OpenAPI YAMLOpenAPI JSONproblemas YAMLResumen de la API
Este grupo tiene 3 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.
Instalaciones y conexiones del agente
Revocar identidad de agente
Revoca la identidad global, todas sus credenciales de identidad y tokens de proyecto, y sus conexiones pendientes. Una repetición exacta con una credencial de identidad revocada tiene éxito sin otra transición. La propiedad del proyecto y el contenido permanecen. No se acepta cookie, Origin, consulta ni cuerpo. Esta ruta no descuenta del medidor de API.
Un JWT de acceso de agente que lleva el alcance de identidad, cuyo permiso mantiene el acceso a identidad (Solo lectura, Proponer o Administrar, cualquiera sea el nivel de acceso del proyecto del token), revoca el mismo y todos los permisos OAuth de la identidad; sus tokens son rechazados en segundos. Un reintento con el mismo JWT después de la revocación es un éxito sin operación.
Plantilla y respuestas de solicitud
curl --request POST 'https://api.screenrig.ai/api/agent-identity/revoke'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 204 | Identidad revocada. | sin cuerpo; encabezados: Cache-Control |
| 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 agente actual
Devuelve la instalación del agente vinculada al portador del proyecto que llama más connection_ready. Un proyecto está listo cuando al menos un miembro tiene una passkey o contraseña. El estado de identidad es diagnóstico y no descuenta del medidor de la API.
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/agents/self'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 200 | Estado actual de conexión del agente y proyecto. | AgentSelfStatus (application/json); encabezados: Cache-Control |
| 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) |
Desconectar agente actual
Revoca solo la membresía del proyecto que llama y su token de proyecto, preservando la identidad global, otras membresías, proyecto y contenido. Repetir con el mismo portador revocado y criptográficamente válido es una operación sin efecto con éxito. Desconectar al último agente activo devuelve agent_lockout_risk a menos que allow_last_agent sea explícito. No descuenta del medidor de API.
Un JWT de acceso de agente, incluido Solo lectura, desconecta al agente del proyecto de su token; la membresía termina, el consentimiento del proyecto deja los permisos del agente y ese par identidad/proyecto se corta para tokens de acceso antiguos. Otros proyectos en el token siguen funcionando. Un reintento con el mismo JWT después de la desconexión es un éxito sin operación.
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. |
Campos del cuerpo de la solicitud
| Campo | Descripción |
|---|---|
| allow_last_agent (opcional, booleano) | Acepta explícitamente la pérdida del último portador activo del agente. Un passkey registrado en el dashboard sigue siendo autoridad administrativa independiente. por defecto: false |
Plantilla y respuestas de solicitud
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/agents/self/disconnect'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 204 | Agente desconectado. | sin cuerpo; encabezados: Cache-Control |
| 401 | 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) |
| 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) |