Riferimento API

API Connessioni agente

Installazioni e connessioni agente

Riferimento HTTP. Generato dal contratto backend. Esplora gli endpoint qui sotto o scarica OpenAPI.

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

POST/api/agent-identity/revoke

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.

Autenticazione
agentIdentityBearer
Corpo della richiesta
nessuno
ID operazione
revokeAgentIdentity
Modello richiesta e risposte
shell · modello richiesta
curl --request POST 'https://api.screenrig.ai/api/agent-identity/revoke'

Risposte

StatoSignificatoCorpo e intestazioni
204Identità 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)
GET/api/agents/self

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.

Autenticazione
projectBearer
Corpo della richiesta
nessuno
ID operazione
getCurrentAgent

Parametri

NomeInviaObbligatorio?Descrizione
ScreenRig-ProjectintestazioneopzionaleDeprecato 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
shell · modello richiesta
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/agents/self'

Risposte

StatoSignificatoCorpo e intestazioni
200Prontezza 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)
POST/api/agents/self/disconnect

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.

Autenticazione
revocableAgentBearer
Corpo della richiesta
AgentDisconnectRequest
ID operazione
disconnectCurrentAgent

Parametri

NomeInviaObbligatorio?Descrizione
ScreenRig-ProjectintestazioneopzionaleDeprecato 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

CampoDescrizione
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
shell · modello richiesta
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

StatoSignificatoCorpo e intestazioni
204Agente 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)