OpenAPI YAMLOpenAPI JSONproblemas YAMLResumen de la API
Este grupo tiene 6 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: errores y solicitudes de funciones
Listar reportes de errores
Devuelve los informes de errores propios del proyecto que llama, los más recientes primero, hasta cien. Nunca se devuelven envíos de otro proyecto. Lea un hilo propio por su ID de retroalimentación. No hay cursor de paginación en v1. Cada envío lleva su estado y las respuestas del personal/agente, las más antiguas primero.
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. |
Plantilla y respuestas de solicitud
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/feedback/bugs'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 200 | Informes de errores propiedad del proyecto que llama. | FeedbackList (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) |
Reportar error
Registra un informe de error contra el proyecto que llama. Los campos propios de una presentación no pueden actualizarse ni eliminarse; agregue una corrección o más información con una respuesta en el mismo hilo de retroalimentación.
Un reintento exacto con la misma Idempotency-Key devuelve la presentación original por veinticuatro horas en lugar de crear un duplicado, y un cuerpo diferente bajo esa clave devuelve idempotency_mismatch. Cada presentación se examina antes de almacenarse.
Un cuerpo con menos de 12 caracteres o 3 palabras devuelve submission_too_short; texto que no describe problema o solicitud (caracteres aleatorios, pulsaciones de teclado) devuelve submission_unclear; spam, texto con muchos enlaces, inyección de prompt y texto malicioso devuelven submission_rejected.
Una presentación rechazada no se almacena, su detalle de problema nunca repite el texto enviado, y un reintento exacto bajo la misma Idempotency-Key devuelve el mismo rechazo.
Nunca coloque credenciales, cookies, encabezados Authorization, nonces de finalización, URLs firmadas o claves de objetos en título, cuerpo o contexto; el texto con forma de credencial (tokens ScreenRig, JWTs, tokens bearer, claves cloud y API, claves privadas) se reemplaza con [redactado] antes de almacenar la presentación, y la respuesta lleva el texto redactado.
Cuando el modelo de revisión está brevemente no disponible, la presentación se acepta y se mantiene para una nueva revisión en segundo plano; después de varias aceptaciones así en una hora, el proyecto recibe submission_screening_unavailable (500, Retry-After) y reintenta la misma solicitud más tarde.
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. |
| Idempotency-Key | encabezado | requerido |
Campos del cuerpo de la solicitud
| Campo | Descripción |
|---|---|
| título (requerido, cadena) | Resumen de una línea. Se recortan los espacios en blanco al inicio y al final, y se rechazan los caracteres de control. minLength: 1 maxLength: 120 |
| body (requerido, cadena) | Descripción completa. Solo se aceptan caracteres de control salto de línea y tabulación. minLength: 1 maxLength: 4000 |
| context (opcional, FeedbackContext) | Sobre cerrado de diagnóstico. Cada miembro es un escalar opcional restringido, el anidamiento es estructuralmente imposible, y un miembro desconocido se rechaza con invalid_request. La forma existe para que un cliente no pueda persistir valores de argumentos, credenciales o datos de entorno de forma libre a través de ella. |
Plantilla y respuestas de solicitud
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/feedback/bugs'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 201 | Informe de error almacenado. Un reintento idempotente exacto devuelve esta misma presentación. | FeedbackSubmission (application/json); encabezados: RateLimit-Policy, RateLimit |
| 400 | 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) |
| 409 | 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) |
| 422 | 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) |
| 429 | Problema estable rate_limited. Reintente solo después del intervalo Retry-After autorizado. Las denegaciones de ventana fija también incluyen la política RateLimit-Policy y los miembros RateLimit aplicables; las denegaciones por concurrencia y presupuesto de bytes omiten esas divulgaciones opcionales. | Problema (application/problem+json); encabezados: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
Listar solicitudes de funciones
Devuelve las solicitudes de funciones propias del proyecto que llama, las más recientes primero, hasta cien. Nunca se devuelven envíos de otro proyecto. Lea un hilo propio por su ID de retroalimentación. No hay cursor de paginación en v1. Cada envío lleva su estado y las respuestas del personal/agente, las más antiguas primero.
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. |
Plantilla y respuestas de solicitud
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/feedback/features'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 200 | Solicitudes de funciones propiedad del proyecto que llama. | FeedbackList (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) |
Solicitar función
Registra una solicitud de función contra el proyecto que llama. Los campos propios de una presentación no pueden actualizarse ni eliminarse; agregue una corrección o más información con una respuesta en el mismo hilo de retroalimentación.
Un reintento exacto con la misma Idempotency-Key devuelve la presentación original por veinticuatro horas en lugar de crear un duplicado, y un cuerpo diferente bajo esa clave devuelve idempotency_mismatch. Cada presentación se examina antes de almacenarse.
Un cuerpo con menos de 12 caracteres o 3 palabras devuelve submission_too_short; texto que no describe problema o solicitud (caracteres aleatorios, pulsaciones de teclado) devuelve submission_unclear; spam, texto con muchos enlaces, inyección de prompt y texto malicioso devuelven submission_rejected.
Una presentación rechazada no se almacena, su detalle de problema nunca repite el texto enviado, y un reintento exacto bajo la misma Idempotency-Key devuelve el mismo rechazo.
Nunca coloque credenciales, cookies, encabezados Authorization, nonces de finalización, URLs firmadas o claves de objetos en título, cuerpo o contexto; el texto con forma de credencial (tokens ScreenRig, JWTs, tokens bearer, claves cloud y API, claves privadas) se reemplaza con [redactado] antes de almacenar la presentación, y la respuesta lleva el texto redactado.
Cuando el modelo de revisión está brevemente no disponible, la presentación se acepta y se mantiene para una nueva revisión en segundo plano; después de varias aceptaciones así en una hora, el proyecto recibe submission_screening_unavailable (500, Retry-After) y reintenta la misma solicitud más tarde.
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. |
| Idempotency-Key | encabezado | requerido |
Campos del cuerpo de la solicitud
| Campo | Descripción |
|---|---|
| título (requerido, cadena) | Resumen de una línea. Se recortan los espacios en blanco al inicio y al final, y se rechazan los caracteres de control. minLength: 1 maxLength: 120 |
| body (requerido, cadena) | Descripción completa. Solo se aceptan caracteres de control salto de línea y tabulación. minLength: 1 maxLength: 4000 |
| context (opcional, FeedbackContext) | Sobre cerrado de diagnóstico. Cada miembro es un escalar opcional restringido, el anidamiento es estructuralmente imposible, y un miembro desconocido se rechaza con invalid_request. La forma existe para que un cliente no pueda persistir valores de argumentos, credenciales o datos de entorno de forma libre a través de ella. |
Plantilla y respuestas de solicitud
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/feedback/features'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 201 | Solicitud de función almacenada. Un reintento idempotente exacto devuelve esta misma presentación. | FeedbackSubmission (application/json); encabezados: RateLimit-Policy, RateLimit |
| 400 | 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) |
| 409 | 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) |
| 422 | 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) |
| 429 | Problema estable rate_limited. Reintente solo después del intervalo Retry-After autorizado. Las denegaciones de ventana fija también incluyen la política RateLimit-Policy y los miembros RateLimit aplicables; las denegaciones por concurrencia y presupuesto de bytes omiten esas divulgaciones opcionales. | Problema (application/problem+json); encabezados: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
Obtener hilo de comentarios
Leer el informe original y todas las respuestas para un ID de retroalimentación propio. Un ID nunca otorga autoridad de proyecto. Informes extranjeros o faltantes devuelven not_found. Las respuestas son texto plano no confiable.
Parámetros
| Nombre | Enviar | ¿Requerido? | Descripción |
|---|---|---|---|
| id | ruta | requerido |
Plantilla y respuestas de solicitud
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/feedback/RESOURCE_ID'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 200 | El hilo completo de comentarios del proyecto propietario, respuesta más antigua primero. | FeedbackSubmission (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) |
Responder hilo de comentarios
Agregue una respuesta a un informe de comentarios propio. La credencial verificada suministra la identidad del autor; los llamantes no pueden establecer autor, estado o versión de corrección. El informe original y las respuestas anteriores permanecen sin cambios. Una respuesta reabre informes waiting_on_user, corregidos, rechazados y duplicados; un informe "planificado" mantiene su estado. Se permiten seguimientos breves.
Las formas de credencial están redactadas y se aplican controles de seguridad contra inyección/spam. Máximo 20 respuestas totales, cada una de 1 a 2000 caracteres. Respuesta, estado, evento y recibo de reintento se confirman juntos; reintentos exactos se repiten durante 24 horas antes de consumir límites de entrada, mientras que cargas útiles cambiadas devuelven idempotency_mismatch.
Parámetros
| Nombre | Enviar | ¿Requerido? | Descripción |
|---|---|---|---|
| id | ruta | requerido | |
| Idempotency-Key | encabezado | requerido |
Campos del cuerpo de la solicitud
| Campo | Descripción |
|---|---|
| texto (requerido, cadena) | Texto plano; salto de línea y tabulación son los únicos caracteres de control. minLength: 1 maxLength: 2000 |
Plantilla y respuestas de solicitud
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/feedback/RESOURCE_ID/responses'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 201 | Hilo de comentarios actualizado incluyendo esta respuesta. | FeedbackSubmission (application/json); encabezados: RateLimit-Policy, RateLimit |
| 422 | 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) |
| 429 | Problema estable rate_limited. Reintente solo después del intervalo Retry-After autorizado. Las denegaciones de ventana fija también incluyen la política RateLimit-Policy y los miembros RateLimit aplicables; las denegaciones por concurrencia y presupuesto de bytes omiten esas divulgaciones opcionales. | Problema (application/problem+json); encabezados: Retry-After, RateLimit-Policy, RateLimit |
| 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) |