OpenAPI YAMLOpenAPI JSONproblemas YAMLVisão geral da API
Este grupo tem 6 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.
Feedback: bugs e solicitações de recursos
Listar relatórios de bugs
Retorna os relatórios de bugs do projeto que chama, do mais novo para o mais antigo, até cem. Submissões de outro projeto nunca são retornadas. Leia um tópico próprio pelo ID de feedback. Não há cursor de paginação na v1. Cada submissão carrega seu status e as respostas da equipe/agente, do mais antigo para o mais novo.
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/feedback/bugs'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 200 | Relatórios de bugs pertencentes ao projeto atual. | FeedbackList (application/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) |
Relatar bug
Registra um relatório de bug contra o projeto chamador. Campos próprios da submissão não podem ser atualizados ou excluídos; adicione correção ou mais informações com uma resposta no mesmo tópico de feedback.
Uma nova tentativa exata com a mesma Idempotency-Key retorna a submissão original por vinte e quatro horas em vez de criar um duplicado, e um corpo diferente sob essa chave retorna idempotency_mismatch. Cada submissão é verificada antes de ser armazenada.
Um corpo com menos de 12 caracteres ou 3 palavras retorna submission_too_short; texto que não descreve problema ou requisição (caracteres aleatórios, batida no teclado) retorna submission_unclear; spam, texto com muitos links, injeção de prompt e texto malicioso retornam submission_rejected.
Uma submissão recusada não é armazenada, seu detalhe de problema nunca repete o texto submetido, e uma nova tentativa exata sob a mesma Idempotency-Key retorna a mesma recusa.
Nunca coloque credenciais, cookies, cabeçalhos Authorization, nonces de conclusão, URLs assinadas ou chaves de objeto no título, corpo ou contexto; texto com formato de credencial (tokens ScreenRig, JWTs, tokens bearer, chaves de nuvem e API, chaves privadas) é substituído por [redigido] antes do armazenamento da submissão, e a resposta carrega o texto redigido.
Quando o modelo de triagem está brevemente indisponível, a submissão é aceita e mantida para uma reavaliação em segundo plano; após algumas dessas aceitações em uma hora, o projeto recebe submission_screening_unavailable (500, Retry-After) e tenta a mesma solicitação mais tarde.
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 | obrigatório |
Campos do corpo da solicitação
| Campo | Descrição |
|---|---|
| título (obrigatório, string) | Resumo de uma linha. Espaços em branco no início e fim são removidos, e caracteres de controle são rejeitados. minLength: 1 maxLength: 120 |
| body (obrigatório, string) | Descrição completa. Quebra de linha e tabulação são os únicos caracteres de controle aceitos. minLength: 1 maxLength: 4000 |
| context (opcional, FeedbackContext) | Envelope de diagnóstico fechado. Cada membro é um escalar opcional restrito, aninhamento é estruturalmente impossível, e um membro desconhecido é rejeitado com invalid_request. A forma existe para que um cliente não possa persistir valores de argumento, credenciais ou dados de ambiente livre através dela. |
Modelo e respostas da solicitação
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/feedback/bugs'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 201 | Relatório de bug armazenado. Retentativa idempotente exata retorna esta mesma submissão. | FeedbackSubmission (application/json); cabeçalhos: RateLimit-Policy, RateLimit |
| 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) |
| 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) |
| 429 | Problema estável rate_limited. Refaça só após o intervalo Retry-After autoritativo. Negativas de janela fixa incluem também RateLimit-Policy e membros RateLimit aplicáveis; negativas de concorrência e orçamento de bytes omitem essas divulgações opcionais. | Problema (application/problem+json); cabeçalhos: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
Listar solicitações de recursos
Retorna as solicitações de recursos do projeto que chama, do mais novo para o mais antigo, até cem. Submissões de outro projeto nunca são retornadas. Leia um tópico próprio pelo ID de feedback. Não há cursor de paginação na v1. Cada submissão carrega seu status e as respostas da equipe/agente, do mais antigo para o mais novo.
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/feedback/features'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 200 | Solicitações de recurso pertencentes ao projeto que chama. | FeedbackList (application/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) |
Solicitar recurso
Registra um pedido de recurso contra o projeto chamador. Campos próprios da submissão não podem ser atualizados ou excluídos; adicione correção ou mais informações com uma resposta no mesmo tópico de feedback.
Uma nova tentativa exata com a mesma Idempotency-Key retorna a submissão original por vinte e quatro horas em vez de criar um duplicado, e um corpo diferente sob essa chave retorna idempotency_mismatch. Cada submissão é verificada antes de ser armazenada.
Um corpo com menos de 12 caracteres ou 3 palavras retorna submission_too_short; texto que não descreve problema ou requisição (caracteres aleatórios, batida no teclado) retorna submission_unclear; spam, texto com muitos links, injeção de prompt e texto malicioso retornam submission_rejected.
Uma submissão recusada não é armazenada, seu detalhe de problema nunca repete o texto submetido, e uma nova tentativa exata sob a mesma Idempotency-Key retorna a mesma recusa.
Nunca coloque credenciais, cookies, cabeçalhos Authorization, nonces de conclusão, URLs assinadas ou chaves de objeto no título, corpo ou contexto; texto com formato de credencial (tokens ScreenRig, JWTs, tokens bearer, chaves de nuvem e API, chaves privadas) é substituído por [redigido] antes do armazenamento da submissão, e a resposta carrega o texto redigido.
Quando o modelo de triagem está brevemente indisponível, a submissão é aceita e mantida para uma reavaliação em segundo plano; após algumas dessas aceitações em uma hora, o projeto recebe submission_screening_unavailable (500, Retry-After) e tenta a mesma solicitação mais tarde.
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 | obrigatório |
Campos do corpo da solicitação
| Campo | Descrição |
|---|---|
| título (obrigatório, string) | Resumo de uma linha. Espaços em branco no início e fim são removidos, e caracteres de controle são rejeitados. minLength: 1 maxLength: 120 |
| body (obrigatório, string) | Descrição completa. Quebra de linha e tabulação são os únicos caracteres de controle aceitos. minLength: 1 maxLength: 4000 |
| context (opcional, FeedbackContext) | Envelope de diagnóstico fechado. Cada membro é um escalar opcional restrito, aninhamento é estruturalmente impossível, e um membro desconhecido é rejeitado com invalid_request. A forma existe para que um cliente não possa persistir valores de argumento, credenciais ou dados de ambiente livre através dela. |
Modelo e respostas da solicitação
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/feedback/features'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 201 | Solicitação de recurso armazenada. Retentativa idempotente exata retorna esta mesma submissão. | FeedbackSubmission (application/json); cabeçalhos: RateLimit-Policy, RateLimit |
| 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) |
| 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) |
| 429 | Problema estável rate_limited. Refaça só após o intervalo Retry-After autoritativo. Negativas de janela fixa incluem também RateLimit-Policy e membros RateLimit aplicáveis; negativas de concorrência e orçamento de bytes omitem essas divulgações opcionais. | Problema (application/problem+json); cabeçalhos: Retry-After, RateLimit-Policy, RateLimit |
| 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 tópico de feedback
Ler o relatório original e todas as respostas para um ID de feedback próprio. Um ID nunca concede autoridade de projeto. Relatórios estrangeiros e ausentes retornam not_found. Respostas são texto simples não confiável.
Parâmetros
| Nome | Enviar | Obrigatório? | Descrição |
|---|---|---|---|
| id | caminho | obrigatório |
Modelo e respostas da solicitação
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/feedback/RESOURCE_ID'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 200 | O fio completo de feedback do projeto proprietário, resposta mais antiga primeiro. | FeedbackSubmission (application/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) |
Responder à thread de feedback
Anexa uma resposta a um relatório de feedback próprio. A credencial verificada fornece a identidade do autor; chamadores não podem definir autor, status ou versão de correção. O relatório original e respostas anteriores permanecem inalterados. Uma resposta reabre relatórios waiting_on_user, fixed, declined e duplicate; um relatório "planned" mantém seu status. Pequenas respostas são permitidas.
Formas de credencial são editadas e verificações de segurança contra injeção/spam se aplicam. No máximo 20 respostas totais, cada uma de 1 a 2000 caracteres. Resposta, status, evento e recibo de nova tentativa são confirmados juntos; tentativas exatas são repetidas por 24 horas antes que limites de entrada sejam consumidos, enquanto cargas alteradas retornam idempotency_mismatch.
Parâmetros
| Nome | Enviar | Obrigatório? | Descrição |
|---|---|---|---|
| id | caminho | obrigatório | |
| Idempotency-Key | cabeçalho | obrigatório |
Campos do corpo da solicitação
| Campo | Descrição |
|---|---|
| texto (obrigatório, string) | Texto simples; alimentação de linha e tabulação são os únicos caracteres de controle. minLength: 1 maxLength: 2000 |
Modelo e respostas da solicitação
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/feedback/RESOURCE_ID/responses'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 201 | Discussão de feedback atualizada incluindo esta resposta. | FeedbackSubmission (application/json); cabeçalhos: RateLimit-Policy, RateLimit |
| 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) |
| 429 | Problema estável rate_limited. Refaça só após o intervalo Retry-After autoritativo. Negativas de janela fixa incluem também RateLimit-Policy e membros RateLimit aplicáveis; negativas de concorrência e orçamento de bytes omitem essas divulgações opcionais. | Problema (application/problem+json); cabeçalhos: Retry-After, RateLimit-Policy, RateLimit |
| 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) |