Comentarios: referencia de la API, endpoints y ejemplos

OpenAPI YAML OpenAPI JSON problemas YAML Resumen de la API

Este grupo tiene 9 operaciones, generadas a partir de api/openapi.yaml. Filtre por ruta, acción o autenticación. Cada endpoint indica sus entradas; despliéguelo para ver una plantilla de solicitud y los códigos de respuesta. Las plantillas necesitan sus propios valores y un cuerpo válido según el esquema.

Reemplace los marcadores en mayúsculas con sus valores. Para una solicitud JSON, guarde un cuerpo que coincida con el esquema en request.json. Los ejemplos de cookies usan un frasco de cookies local de una sesión autenticada.

Comentarios

GET/api/comment/screen/{id}¶

Obtener comentarios de pantalla

Comentarios opacos de agente en la pantalla nombrada. ScreenRig no los lee ni usa. No son autorización y no están en el manifiesto en tiempo de ejecución. Una pantalla sin comentarios devuelve comentarios nulos. Las pantallas archivadas siguen siendo accesibles. Lectura autenticada /api control-plane; cuesta 1 crédito.

Autenticación: projectBearer
Cuerpo de la solicitud: ninguno
ID de operación: getScreenComments

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Comentarios	Comentarios (application/json)
403	outside_screen_scope - el llamador está limitado a pantallas y la pantalla, carpeta de pantallas, selector o audiencia que nombra o alcanza la solicitud está fuera de ellas (docs/screen-scope.md). Un id fuera del alcance y un id que no existe reciben la misma respuesta; errors[0].screen_scope lleva el alcance del llamador, y la escritura se rechaza por completo, nunca se acota.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

PUT/api/comment/screen/{id}¶

Poner comentarios de pantalla

Reemplaza comentarios opacos de agentes en la pantalla nombrada. El valor de comentarios debe ser un objeto JSON cuyo formato UTF-8 compacto tenga como máximo 1024 bytes. Última escritura gana solo en el campo comentarios; la revisión, updated_at y el manifiesto de ejecución no cambian.

Autenticación: projectBearer
Cuerpo de la solicitud: Escribir comentarios
ID de operación: putScreenComments

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
Idempotency-Key	encabezado	opcional	Omitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Campos del cuerpo de la solicitud

Campo	Descripción
comentarios (requerido, objeto)	Objeto JSON opaco de agente. La serialización compacta UTF-8 debe tener como máximo 1024 bytes. Se permiten objetos anidados, arreglos y cadenas. Se rechazan arreglos, cadenas, números, booleanos y nulos como valor de comentarios en sí.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Comentarios	Comentarios (application/json)
403	outside_screen_scope - el llamador está limitado a pantallas y la pantalla, carpeta de pantallas, selector o audiencia que nombra o alcanza la solicitud está fuera de ellas (docs/screen-scope.md). Un id fuera del alcance y un id que no existe reciben la misma respuesta; errors[0].screen_scope lleva el alcance del llamador, y la escritura se rechaza por completo, nunca se acota.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

ELIMINAR/api/comment/screen/{id}¶

Eliminar comentarios de pantalla

Elimina los comentarios de la pantalla. Es idempotente si ya están eliminados. No incrementa la revisión ni vuelve a emitir el manifiesto de ejecución.

Autenticación: projectBearer
Cuerpo de la solicitud: ninguno
ID de operación: deleteScreenComments

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
Idempotency-Key	encabezado	opcional	Omitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
204	No establecido	sin cuerpo
403	outside_screen_scope - el llamador está limitado a pantallas y la pantalla, carpeta de pantallas, selector o audiencia que nombra o alcanza la solicitud está fuera de ellas (docs/screen-scope.md). Un id fuera del alcance y un id que no existe reciben la misma respuesta; errors[0].screen_scope lleva el alcance del llamador, y la escritura se rechaza por completo, nunca se acota.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/comment/playlist/{id}¶

Obtener comentarios de lista de reproducción

Comentarios opacos de agente en la lista de reproducción nombrada. ScreenRig no los lee ni usa. Una lista de reproducción sin comentarios devuelve comentarios nulos. Lectura autenticada /api control-plane; cuesta 1 crédito.

Autenticación: projectBearer
Cuerpo de la solicitud: ninguno
ID de operación: getPlaylistComments

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Comentarios	Comentarios (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

PUT/api/comment/playlist/{id}¶

Poner comentarios de lista de reproducción

Reemplaza comentarios opacos de agentes en la lista de reproducción nombrada. El JSON UTF-8 compacto del objeto comentarios debe tener como máximo 1024 bytes. Última escritura gana solo en el campo comentarios; la revisión y el manifiesto de ejecución no cambian.

Autenticación: projectBearer
Cuerpo de la solicitud: Escribir comentarios
ID de operación: putPlaylistComments

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
Idempotency-Key	encabezado	opcional	Omitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Campos del cuerpo de la solicitud

Campo	Descripción
comentarios (requerido, objeto)	Objeto JSON opaco de agente. La serialización compacta UTF-8 debe tener como máximo 1024 bytes. Se permiten objetos anidados, arreglos y cadenas. Se rechazan arreglos, cadenas, números, booleanos y nulos como valor de comentarios en sí.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Comentarios	Comentarios (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

ELIMINAR/api/comment/playlist/{id}¶

Eliminar comentarios de lista de reproducción

Quita comentarios de lista de reproducción. Idempotente si ya está quitado. No incrementa revisión ni vuelve a emitir el manifiesto de ejecución.

Autenticación: projectBearer
Cuerpo de la solicitud: ninguno
ID de operación: deletePlaylistComments

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
Idempotency-Key	encabezado	opcional	Omitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
204	No establecido	sin cuerpo
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/comment/playlist/{id}/page/{page_id}¶

Obtener comentarios de página de lista de reproducción

Comentarios opacos de agente en una página de lista de reproducción, dirigidos por la cadena id de la página. Una página sin comentarios devuelve comentarios nulos. Lista de reproducción o página faltante es not_found. Lectura autenticada /api control-plane; cuesta 1 crédito.

Autenticación: projectBearer
Cuerpo de la solicitud: ninguno
ID de operación: getPlaylistPageComments

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
page_id	ruta	requerido	Cadena de id de página de lista de reproducción.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Comentarios	Comentarios (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

PUT/api/comment/playlist/{id}/page/{page_id}¶

Poner comentarios de página de lista de reproducción

Reemplaza comentarios opacos de agentes en una página de lista de reproducción. El JSON UTF-8 compacto del objeto comentarios debe tener como máximo 1024 bytes. Última escritura gana solo en el campo comentarios de esa página; la revisión de la lista y el manifiesto de ejecución no cambian.

Autenticación: projectBearer
Cuerpo de la solicitud: Escribir comentarios
ID de operación: putPlaylistPageComments

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
page_id	ruta	requerido	Cadena de id de página de lista de reproducción.
Idempotency-Key	encabezado	opcional	Omitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Campos del cuerpo de la solicitud

Campo	Descripción
comentarios (requerido, objeto)	Objeto JSON opaco de agente. La serialización compacta UTF-8 debe tener como máximo 1024 bytes. Se permiten objetos anidados, arreglos y cadenas. Se rechazan arreglos, cadenas, números, booleanos y nulos como valor de comentarios en sí.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Comentarios	Comentarios (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

ELIMINAR/api/comment/playlist/{id}/page/{page_id}¶

Eliminar comentarios de página de lista de reproducción

Quita comentarios en una página de lista de reproducción. Idempotente si ya está quitado. No incrementa revisión ni vuelve a emitir el manifiesto de ejecución.

Autenticación: projectBearer
Cuerpo de la solicitud: ninguno
ID de operación: deletePlaylistPageComments

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
page_id	ruta	requerido	Cadena de id de página de lista de reproducción.
Idempotency-Key	encabezado	opcional	Omitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
204	No establecido	sin cuerpo
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)