OpenAPI YAMLOpenAPI JSONproblemas YAMLVisão geral da API
Este grupo tem 3 operações, geradas a partir de api/openapi.yaml. Filtre por caminho, ação ou autenticação. Cada endpoint lista suas entradas; expanda-o para ver um modelo de solicitação e os códigos de resposta. Os modelos precisam de seus próprios valores e de um corpo válido conforme o esquema.
Substitua os espaços reservados em maiúsculas pelos seus valores. Para uma solicitação JSON, salve um corpo que corresponda ao esquema em request.json. Exemplos de cookies usam um jar local de cookies de uma sessão autenticada.
Instalações e conexões do agente
Revogar identidade do agente
Revoga a identidade global, todas as suas credenciais de identidade e tokens de projeto, e suas conexões pendentes. Uma repetição exata com uma credencial de identidade revogada tem sucesso sem outra transição. A propriedade do projeto e o conteúdo permanecem. Nenhum cookie, Origin, query ou corpo é aceito. Esta rota não debita o medidor da API.
Um JWT de acesso de agente que carrega o escopo de identidade, cujo grant detém acesso à identidade (Somente leitura, Propor ou Gerenciar, qualquer que seja o nível de acesso do projeto do token), revoga o mesmo e todo grant OAuth da identidade; seus tokens são recusados em segundos. Uma nova tentativa com o mesmo JWT após a revogação é um sucesso sem efeito.
Modelo e respostas da solicitação
curl --request POST 'https://api.screenrig.ai/api/agent-identity/revoke'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 204 | Identidade revogada. | sem corpo; cabeçalhos: Cache-Control |
| padrão | Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico. | Problema (application/problem+json) |
Obter agente atual
Retorna a instalação do agente vinculada ao portador do projeto que chama, além de connection_ready. Um projeto está pronto quando pelo menos um membro tem passkey ou senha. O status de identidade é diagnóstico e não debita o medidor da API.
Parâmetros
| Nome | Enviar | Obrigatório? | Descrição |
|---|---|---|---|
| ScreenRig-Project | cabeçalho | opcional | Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token. |
Modelo e respostas da solicitação
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/agents/self'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 200 | Prontidão da conexão do agente e projeto atuais. | AgentSelfStatus (application/json); cabeçalhos: Cache-Control |
| padrão | Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico. | Problema (application/problem+json) |
Desconectar agente atual
Revoga apenas a associação do projeto que está fazendo a chamada e seu token de projeto, preservando a identidade global, outras associações, projeto e conteúdo. Repetir com o mesmo portador revogado criptograficamente válido é uma operação sem efeito com sucesso. Desconectar o último agente ativo retorna agent_lockout_risk, a menos que allow_last_agent seja explícito. Não debita o medidor da API.
Um JWT de acesso de agente, incluindo Somente leitura, desconecta o agente do projeto do seu token; a associação termina, o consentimento do projeto deixa os grants do agente e esse par identidade/projeto é cortado para tokens de acesso mais antigos. Outros projetos no token continuam funcionando. Uma nova tentativa com o mesmo JWT após a desconexão é um sucesso sem efeito.
Parâmetros
| Nome | Enviar | Obrigatório? | Descrição |
|---|---|---|---|
| ScreenRig-Project | cabeçalho | opcional | Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token. |
Campos do corpo da solicitação
| Campo | Descrição |
|---|---|
| allow_last_agent (opcional, booleano) | Aceita explicitamente a perda do último portador ativo do agente. Uma passkey de dashboard registrada permanece autoridade administrativa independente. padrão: falso |
Modelo e respostas da solicitação
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/agents/self/disconnect'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 204 | Agente desconectado. | sem corpo; cabeçalhos: Cache-Control |
| 401 | Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico. | Problema (application/problem+json) |
| 409 | Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico. | Problema (application/problem+json) |
| padrão | Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico. | Problema (application/problem+json) |