OpenAPI YAMLOpenAPI JSONproblemi YAMLPanoramica dell’API
Questo gruppo ha 3 operazioni, generate da api/openapi.yaml. Filtra per percorso, azione o autenticazione. Ogni endpoint elenca i suoi input; espandilo per vedere un modello di richiesta e i codici di risposta. I modelli richiedono i tuoi valori e un corpo valido secondo lo schema.
Sostituisci i segnaposto maiuscoli con i tuoi valori. Per una richiesta JSON, salva un corpo che corrisponde allo schema in request.json. Gli esempi di cookie usano un cookie jar locale da una sessione autenticata.
Installazioni e connessioni agente
Revoca identità agente
Revoca l’identità globale, tutte le sue credenziali d’identità e i token di progetto, e le sue connessioni in sospeso. Una ripetizione esatta con una credenziale d’identità revocata ha successo senza altra transizione. La proprietà del progetto e i contenuti rimangono. Non è accettato cookie, Origin, query o body. Questa rotta non addebita il contatore API.
Un JWT di accesso agente che porta lo scope identity, il cui grant detiene l’accesso identity (Read only, Propose o Manage, qualunque sia il livello di accesso del progetto del token), revoca lo stesso e ogni grant OAuth dell’identity; i suoi token sono rifiutati entro secondi. Un retry con lo stesso JWT dopo la revoca è un successo no-op.
Modello richiesta e risposte
curl --request POST 'https://api.screenrig.ai/api/agent-identity/revoke'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 204 | Identità revocata. | nessun corpo; intestazioni: Cache-Control |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
Ottieni agente corrente
Restituisce l’installazione dell’agente collegata al bearer del progetto chiamante più connection_ready. Un progetto è pronto quando almeno un membro ha un passkey o password. Lo stato dell’identità è diagnostico e non addebita il contatore API.
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
Modello richiesta e risposte
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/agents/self'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Prontezza di connessione dell’agente e progetto corrente. | AgentSelfStatus (application/json); intestazioni: Cache-Control |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
Disconnetti agente corrente
Revoca solo l’iscrizione del progetto chiamante e il suo token di progetto, preservando l’identità globale, altre iscrizioni, progetto e contenuti. Ripetere con lo stesso bearer revocato e crittograficamente valido è un successo senza effetto. Disconnettere l’ultimo agente attivo restituisce agent_lockout_risk a meno che allow_last_agent non sia esplicito. Non addebita il contatore API.
Un JWT di accesso agente, incluso Read only, disconnette l’agente dal progetto del suo token; la membership termina, il consenso del progetto lascia i grant dell’agente e quella coppia identity/progetto è tagliata fuori per i token di accesso più vecchi. Altri progetti nel token continuano a funzionare. Un retry con lo stesso JWT dopo la disconnessione è un successo no-op.
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
Campi del corpo della richiesta
| Campo | Descrizione |
|---|---|
| allow_last_agent (opzionale, booleano) | Accetta esplicitamente la perdita dell’ultimo agente attivo bearer. Una passkey dashboard registrata resta autorità amministrativa indipendente. default: false |
Modello richiesta e risposte
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/agents/self/disconnect'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 204 | Agente disconnesso. | nessun corpo; intestazioni: Cache-Control |
| 401 | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
| 409 | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |