Agentenverbindungen: API-Referenz mit Endpunkten und Beispielen

OpenAPI YAML OpenAPI JSON Probleme YAML API-Überblick

Diese Gruppe hat 3 Operationen, generiert aus api/openapi.yaml. Filtern Sie nach Pfad, Aktion oder Authentifizierung. Jeder Endpunkt listet seine Eingaben auf; klappen Sie ihn auf, um eine Anfragevorlage und die Antwortcodes zu sehen. Die Vorlagen brauchen Ihre eigenen Werte und einen schemagültigen Anfragekörper.

Großgeschriebene Platzhalter durch Ihre Werte ersetzen. Für eine JSON-Anfrage speichern Sie einen Body, der dem Schema in request.json entspricht. Cookie-Beispiele verwenden ein lokales Cookie-Archiv aus einer authentifizierten Sitzung.

Agenteninstallationen und -verbindungen

POST/api/agent-identity/revoke¶

Agentenidentität widerrufen

Widerruft die globale Identität, alle ihre Identitätsnachweise und Projekttoken sowie ihre ausstehenden Verbindungen. Eine exakte Wiederholung mit einem widerrufenen Identitätsnachweis gelingt ohne weitere Änderung. Projektbesitz und Inhalte bleiben erhalten. Es werden keine Cookies, Origin, Abfragen oder Body akzeptiert. Diese Route belastet nicht den API-Zähler.

Ein Agenten-Zugriffs-JWT mit Identitätsscope, dessen Berechtigung Identitätszugriff gewährt (Nur Lesen, Vorschlagen oder Verwalten, je nach Zugriffsebene des Token-Projekts), widerruft dieselbe und jede OAuth-Berechtigung der Identität; seine Tokens werden innerhalb von Sekunden abgelehnt. Ein erneuter Versuch mit demselben JWT nach dem Widerruf ist ein No-Op-Erfolg.

Authentifizierung: agentIdentityBearer
Anfrageinhalt: keine
Operations-ID: revokeAgentIdentity

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request POST 'https://api.screenrig.ai/api/agent-identity/revoke'

Antworten

Status	Bedeutung	Textkörper und Header
204	Identität widerrufen.	kein Körper; Header: Cache-Control
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)

GET/api/agents/self¶

Aktuellen Agenten abrufen

Gibt die Agenteninstallation zurück, die mit dem aufrufenden Projektträger verknüpft ist, plus connection_ready. Ein Projekt ist bereit, wenn mindestens ein Mitglied einen Passkey oder ein Passwort hat. Der Identitätsstatus ist diagnostisch und belastet den API-Zähler nicht.

Authentifizierung: projectBearer
Anfrageinhalt: keine
Operations-ID: getCurrentAgent

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/agents/self'

Antworten

Status	Bedeutung	Textkörper und Header
200	Aktuelle Verbindungsbereitschaft von Agent und Projekt.	AgentSelfStatus (application/json); Header: Cache-Control
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)

POST/api/agents/self/disconnect¶

Aktuellen Agent trennen

Widerruft nur die aufrufende Projektmitgliedschaft und deren Projekttoken, wobei die globale Identität, andere Mitgliedschaften, Projekt und Inhalte erhalten bleiben. Eine Wiederholung mit demselben kryptografisch gültigen widerrufenen Token ist ein No-Op-Erfolg. Das Trennen des letzten aktiven Agenten gibt agent_lockout_risk zurück, sofern allow_last_agent nicht explizit gesetzt ist. Belastet nicht den API-Zähler.

Ein Agenten-Zugriffs-JWT, auch Nur Lesen, trennt den Agenten vom Token-Projekt; die Mitgliedschaft endet, die Projektzustimmung verlässt die Agentenberechtigungen und dieses Identität/Projekt-Paar wird für ältere Zugriffstoken getrennt. Andere Projekte im Token funktionieren weiter. Ein erneuter Versuch mit demselben JWT nach der Trennung ist ein No-Op-Erfolg.

Authentifizierung: revocableAgentBearer
Anfrageinhalt: AgentDisconnectRequest
Operations-ID: disconnectCurrentAgent

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.

Anfrageinhalt-Felder

Feld	Beschreibung
allow_last_agent (optional, Boolean)	Verliert explizit den letzten aktiven Agenten-Berechtigten. Ein registrierter Dashboard-Passkey bleibt unabhängige Verwaltungsbefugnis. Standard: false

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/agents/self/disconnect'

Antworten

Status	Bedeutung	Textkörper und Header
204	Agent getrennt.	kein Körper; Header: Cache-Control
401	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)
409	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)