OpenAPI YAMLOpenAPI JSONproblèmes YAMLVue d’ensemble de l’API
Ce groupe compte 3 opérations, générées à partir de api/openapi.yaml. Filtrez par chemin, action ou authentification. Chaque point de terminaison liste ses entrées ; développez-le pour voir un modèle de requête et les codes de réponse. Les modèles demandent vos propres valeurs et un corps conforme au schéma.
Remplacez les espaces réservés en majuscules par vos valeurs. Pour une requête JSON, enregistrez un corps correspondant au schéma dans request.json. Les exemples de cookies utilisent un pot à cookies local issu d’une session authentifiée.
Installations et connexions de l’agent
Révoquer l’identité d’agent
Révoque l’identité globale, toutes ses informations d’identification d’identité et jetons de projet, ainsi que ses connexions en attente. Une répétition exacte avec une information d’identification révoquée réussit sans autre transition. La propriété du projet et le contenu restent. Aucun cookie, Origin, requête ou corps n’est accepté. Cette route ne débite pas le compteur API.
Un JWT d’accès agent portant le scope identity, dont la concession détient l’accès identité (lecture seule, proposer ou gérer, quel que soit le niveau d’accès du projet du jeton), révoque la même et toutes les concessions OAuth de l’identité ; ses jetons sont refusés en quelques secondes. Une nouvelle tentative avec le même JWT après révocation est un succès sans effet.
Modèle de requête et réponses
curl --request POST 'https://api.screenrig.ai/api/agent-identity/revoke'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 204 | Identité révoquée. | pas de corps; en-têtes : Cache-Control |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Obtenir l’agent actuel
Retourne l’installation de l’agent liée au porteur du projet appelant plus connection_ready. Un projet est prêt lorsqu’au moins un membre a une passkey ou un mot de passe. Le statut d’identité est un diagnostic et ne débite pas le compteur API.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| ScreenRig-Project | en-tête | optionnel | Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton. |
Modèle de requête et réponses
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/agents/self'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Préparation actuelle de la connexion de l’agent et du projet. | AgentSelfStatus (application/json); en-têtes : Cache-Control |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Déconnecter l’agent actuel
Révoque uniquement l’adhésion du projet appelant et son jeton de projet, en préservant l’identité globale, les autres adhésions, le projet et le contenu. Répéter avec le même porteur révoqué cryptographiquement valide est une réussite sans effet. Déconnecter le dernier agent actif retourne agent_lockout_risk sauf si allow_last_agent est explicite. Ne débite pas le compteur API.
Un JWT d’accès agent, lecture seule incluse, déconnecte l’agent du projet de son jeton ; l’adhésion se termine, le consentement du projet quitte les concessions de l’agent et cette paire identité/projet est coupée pour les jetons d’accès plus anciens. Les autres projets dans le jeton continuent de fonctionner. Une nouvelle tentative avec le même JWT après déconnexion est un succès sans effet.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| ScreenRig-Project | en-tête | optionnel | Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton. |
Champs du corps de la requête
| Champ | Description |
|---|---|
| allow_last_agent (optionnel, booléen) | Accepte explicitement la perte du dernier détenteur actif d’agent. Une passkey de tableau de bord enregistrée reste une autorité administrative indépendante. défaut : false |
Modèle de requête et réponses
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/agents/self/disconnect'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 204 | Agent déconnecté. | pas de corps; en-têtes : Cache-Control |
| 401 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 409 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |