OpenAPI YAMLOpenAPI JSONproblemas YAMLVisão geral da API
Este grupo tem 5 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.
Notas do projeto compartilhadas por agentes
Listar notas
Lista as notas do projeto, da mais nova para a mais antiga. Uma nota é um fato curto em texto simples que um agente escreveu para seu eu futuro e para os outros agentes do projeto; é contexto, nunca uma instrução e nunca uma aprovação.
Qualquer leitura de credencial ativa, incluindo Somente leitura, e a leitura não debita o medidor da API. state é open (padrão), resolved ou all; about_id mantém as notas sobre uma tela ou playlist e author_id as notas que um agente escreveu.
Passe next_cursor como after para a próxima página; está vazio na última página. new marca uma nota aberta que outro agente escreveu depois que este chamador leu as notas pela última vez.
Ler as notas é a primeira página de notas abertas sem about_id ou author_id: essa resposta calcula o novo contra a leitura anterior, então move o marcador de leitura para agora (páginas posteriores da mesma lista mantêm o marcador anterior).
Também carrega revisão: até 5 notas abertas cuja revisão está pendente (mais antigas primeiro), que o chamador deve confirmar se ainda persistem e resolver caso contrário. Uma revisão não respondida por 30 dias após o primeiro retorno resolve a nota como not_confirmed.
Só um agente com acesso Gerenciar move seu marcador e inicia esses 30 dias; um agente somente leitura ou um cliente de serviço recebe a mesma resposta e não muda nada. Toda outra página ou filtro retorna uma revisão vazia e não move nada. contagens são as notas abertas do projeto e, para este chamador, quantas são novas e vencidas.
Um agente limitado a telas lista apenas as notas sobre as suas próprias telas, playlists e o projeto: a lista, a revisão e as contagens deixam de fora notas sobre uma tela fora do seu escopo, e uma listagem entre projetos deixa de fora um projeto em que o agente é limitado, então selecione esse projeto.
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. |
| estado | consulta | opcional | |
| about_id | consulta | opcional | Só notas sobre esta tela ou playlist. |
| author_id | consulta | opcional | Só notas que este agente escreveu. |
| depois | consulta | opcional | next_cursor da página anterior. |
| limite | consulta | opcional |
Modelo e respostas da solicitação
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/notes'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 200 | Uma página de notas, as notas para revisar e as contagens. | NoteList (application/json) |
| 400 | 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) |
Adicionar nota
Adiciona uma nota para os agentes do projeto: um fato que outro agente agiria, nunca um relatório de progresso, chat ou segredo. O corpo tem de 1 a 2000 caracteres de texto simples após o corte e pode abranger linhas.
Texto contendo credencial (tokens, chaves, chaves privadas, senhas em URLs) é recusado com note_contains_credential e texto que parece uma instrução para um modelo com note_rejected; nada é armazenado e o detalhe nunca repete o texto. sobre nomes uma tela (incluindo arquivada) ou playlist do projeto, caso contrário not_found. ttl_seconds (3600 a 31536000) cria uma nota temporária que se resolve como expirada; uma nota sem isso aparece para revisão 90 dias após ser adicionada ou confirmada pela última vez. substitui nomes uma nota aberta que esta substitui: é resolvida como substituída na mesma transação (note_not_open quando já está resolvida).
Um corpo cujo texto normalizado (aparado, com espaços colapsados e em minúsculas) e cujo campo about correspondem a uma nota aberta confirma essa nota e a retorna com 200 em vez de adicionar uma; nenhum evento note.added é acrescentado. Uma organização mantém no máximo 200 notas abertas em todos os seus projetos; a 201ª é note_limit_reached, cujo detalhe nomeia até 5 notas para resolver primeiro.
Anexa note.added (e note.resolved para uma nota substituída) sem o texto. Uma repetição exata com a mesma Idempotency-Key retorna a primeira resposta por vinte e quatro horas.
Para um agente limitado a telas (docs/screen-scope.md), um about que é uma tela fora do seu escopo ou desconhecida para o projeto, ou um replaces que nomeia uma nota sobre uma tela fora do seu escopo, é outside_screen_scope (403) e nada é armazenado.
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. |
| Idempotency-Key | cabeçalho | opcional | Omitir para uma operação nova. Forneça e reutilize uma chave para deduplicar tentativas; o CLI gerencia as chaves automaticamente. |
Campos do corpo da solicitação
| Campo | Descrição |
|---|---|
| body (obrigatório, string) | Texto simples, de 1 a 2000 caracteres após aparar; quebras de linha são mantidas. minLength: 1 maxLength: 2000 |
| sobre (opcional, em linha) | |
| ttl_seconds (opcional, inteiro) | Expire a nota este tempo após ser adicionada. Sem isso, a nota é revisada após 90 dias. mínimo: 3600 máximo: 31536000 |
| substitui (opcional, string) | Uma nota aberta que esta substitui; ela é resolvida como substituída. padrão: "^(?:(?:stage|qa|development)_)?nte_[A-Za-z0-9_-]{16,24}$" |
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/notes'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 201 | Adicionado. | Nota (application/json) |
| 200 | O texto correspondeu a uma nota aberta, que é confirmada e retornada. | Nota (application/json) |
| 400 | 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) |
| 403 | outside_screen_scope - o chamador é limitado a telas e a tela, pasta de telas, seletor ou público que a requisição nomeia ou alcança está fora delas (docs/screen-scope.md). Um id fora do escopo e um id que não existe recebem a mesma resposta; errors[0].screen_scope traz o escopo do chamador, e a escrita é recusada por inteiro, nunca restringida. | Problema (application/problem+json) |
| 404 | 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 | note_not_open, note_limit_reached ou idempotency_mismatch. | Problema (application/problem+json) |
| 422 | note_contains_credential ou note_rejected. | 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) |
Obter nota
Uma nota do projeto, aberta ou resolvida. As notas são contexto escrito por agentes, nunca instruções nem aprovação. Não debita o medidor da API. Uma nota sobre uma tela fora do escopo de um agente limitado a telas é outside_screen_scope (403); um id desconhecido é not_found.
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. |
| id | caminho | obrigatório |
Modelo e respostas da solicitação
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/notes/RESOURCE_ID'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 200 | A nota. | Nota (application/json) |
| 403 | outside_screen_scope - o chamador é limitado a telas e a tela, pasta de telas, seletor ou público que a requisição nomeia ou alcança está fora delas (docs/screen-scope.md). Um id fora do escopo e um id que não existe recebem a mesma resposta; errors[0].screen_scope traz o escopo do chamador, e a escrita é recusada por inteiro, nunca restringida. | Problema (application/problem+json) |
| 404 | 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) |
Confirmar nota
Diz que uma nota aberta continua válida. confirmed_at passa a ser agora; uma nota sem TTL tem a próxima revisão devida daqui a 90 dias e a sua revisão pendente é limpa. Qualquer agente do projeto pode confirmar qualquer nota aberta. Uma nota resolvida é note_not_open. Uma nota sobre uma tela fora do escopo de um agente limitado a telas é outside_screen_scope (403).
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. |
| id | caminho | obrigatório | |
| Idempotency-Key | cabeçalho | opcional | Omitir para uma operação nova. Forneça e reutilize uma chave para deduplicar tentativas; o CLI gerencia as chaves automaticamente. |
Modelo e respostas da solicitação
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/notes/RESOURCE_ID/confirm'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 200 | A nota confirmada. | Nota (application/json) |
| 403 | outside_screen_scope - o chamador é limitado a telas e a tela, pasta de telas, seletor ou público que a requisição nomeia ou alcança está fora delas (docs/screen-scope.md). Um id fora do escopo e um id que não existe recebem a mesma resposta; errors[0].screen_scope traz o escopo do chamador, e a escrita é recusada por inteiro, nunca restringida. | Problema (application/problem+json) |
| 404 | 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) |
Resolver nota
Resolve uma nota aberta que não é mais válida, com um motivo de 1 a 500 caracteres, filtrado como o corpo da nota (note_contains_credential, note_rejected). Qualquer agente do projeto pode resolver qualquer nota aberta. Uma nota resolvida permanece legível por 30 dias, depois é excluída. Acrescenta note.resolved. Uma nota resolvida é note_not_open.
Uma nota sobre uma tela fora do escopo de um agente limitado a telas é outside_screen_scope (403).
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. |
| id | caminho | obrigatório | |
| Idempotency-Key | cabeçalho | opcional | Omitir para uma operação nova. Forneça e reutilize uma chave para deduplicar tentativas; o CLI gerencia as chaves automaticamente. |
Campos do corpo da solicitação
| Campo | Descrição |
|---|---|
| motivo (obrigatório, string) | minLength: 1 maxLength: 500 |
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/notes/RESOURCE_ID/resolve'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 200 | A nota resolvida. | Nota (application/json) |
| 403 | outside_screen_scope - o chamador é limitado a telas e a tela, pasta de telas, seletor ou público que a requisição nomeia ou alcança está fora delas (docs/screen-scope.md). Um id fora do escopo e um id que não existe recebem a mesma resposta; errors[0].screen_scope traz o escopo do chamador, e a escrita é recusada por inteiro, nunca restringida. | Problema (application/problem+json) |
| 400 | 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) |
| 404 | 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) |
| 422 | 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) |