OpenAPI YAMLOpenAPI JSONproblemas YAMLVisão geral da API
Este grupo tem 1 operação, gerada 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.
Códigos de configuração do site
Obter o código de configuração do visitante
Chamada anônima de mesma origem a partir dos prompts de agente do site. Responde com o código de configuração do cookie de visitante próprio da requisição (sr_vid), gerando-o na primeira vez: o mesmo visitante recebe o mesmo código enquanto ele for válido (90 dias a partir da geração).
Uma pessoa o cola no agente junto com o prompt de configuração, e o agente o passa à inscrição da CLI, que vincula o novo projeto a essa visita. Exige o Origin do site. Uma requisição sem exatamente um cookie de visitante bem formado recebe 204 e não gera nada. O código não concede nada; apenas nomeia uma visita.
No máximo 60 códigos novos por IP de cliente por hora (IPv6 agrupado por /64); todas as requisições compartilham um limite de 120 por IP por minuto. Retry-After é a referência.
Parâmetros
| Nome | Enviar | Obrigatório? | Descrição |
|---|---|---|---|
| Origem | cabeçalho | obrigatório |
Modelo e respostas da solicitação
curl --request POST --header 'Origin: https://screenrig.ai' 'https://screenrig.ai/website/setup-codes'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 200 | O código de configuração do visitante. | WebsiteSetupCode (application/json); cabeçalhos: Cache-Control |
| 204 | A requisição não trouxe cookie de visitante, então não há visita a nomear. | 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) |