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.
Transferência do navegador da página inicial
Reivindicar link do navegador
Reivindica um código de link do navegador para o projeto autenticado e cria atomicamente exatamente uma tela pairing_pending inicial mais sua concessão de provisionamento de navegador existente. A inscrição permanece apenas para o projeto. A resposta é apenas metadados seguros e nunca contém token de provisionamento, URL fragmentado, cookie ou prova.
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 |
|---|---|
| código (obrigatório, string) | padrão: "^[23456789ABCDEFGHJKMNPQRSTUVWXYZ]{3}-?[23456789ABCDEFGHJKMNPQRSTUVWXYZ]{3}$" |
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/project/browser-links/claim'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 201 | Reivindicação exata de link de navegador sem fragmento segura para reprodução. | BrowserLinkClaim (application/json); cabeçalhos: Cache-Control, 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) |
| 403 | 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) |
| 410 | 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 |
| 500 | 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) |
Obter status do link do navegador
Fallback de polling somente leitura autenticado apenas pelo cookie apex browser-link proprietário. Retorna metadados de status seguros e o caminho fixo de continuação, nunca uma URL ou token de provisionamento.
Modelo e respostas da solicitação
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/screen/browser-links'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 200 | Status seguro reivindicado. | BrowserLinkStatus (application/json); cabeçalhos: Cache-Control, Referrer-Policy |
| 202 | Link do navegador existe, mas ainda não foi reivindicado. | BrowserLinkStatus (application/json); cabeçalhos: Cache-Control, Referrer-Policy |
| 401 | Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). 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 Runtime (application/problem+json) |
| 410 | Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). 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 Runtime (application/problem+json) |
| padrão | Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). 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 Runtime (application/problem+json) |
Iniciar link do navegador
POST estrito sem JavaScript compatível de mesma origem que cria ou reutiliza sessão de link de navegador não reivindicada de 24 horas. Reivindicar dentro desse período cria janela protegida independente de 10 minutos para provisionamento e entrega; pareamento de Player por cookie dura 24 horas.
Pareamento nativo é um localizador separado não reclamado por setenta e duas horas; a entrega nativa reclamada permanece durável até a conclusão assinada ou reset explícito no player. Define exatamente o cookie apex host-only Secure HttpOnly SameSite=Strict Path=/ __Host-screenrig-browser-link sem Domain.
Clientes JSON recebem 201; Accept text/html recebe um 303 sem corpo para /setup. Não existe fallback inseguro para localhost; desenvolvimento requer a origem HTTPS loopback configurada.
Modelo e respostas da solicitação
curl --request POST 'https://screenrig.ai/screen/browser-links'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 201 | Metadados seguros do código/status do link do navegador. | BrowserLinkSession (application/json); cabeçalhos: Cache-Control, Referrer-Policy, Set-Cookie, RateLimit-Policy, RateLimit |
| 303 | Continuação do formulário No-JavaScript para a página de configuração somente leitura. | sem corpo; cabeçalhos: Location, Cache-Control, Referrer-Policy, Set-Cookie |
| 403 | Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). 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 Runtime (application/problem+json) |
| 409 | Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). 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 Runtime (application/problem+json) |
| 429 | Problema estável rate_limited em runtime ou rota de conteúdo voltada ao Player, no formato de documento runtime (RuntimeProblem). 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 Runtime (application/problem+json); cabeçalhos: Retry-After, RateLimit-Policy, RateLimit |
| 500 | Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). 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 Runtime (application/problem+json) |
| padrão | Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). 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 Runtime (application/problem+json) |
Eventos de link do navegador do fluxo
Reprodução SSE reproduzível apenas com cookie do proprietário e Last-Event-ID. Dados do evento contêm apenas campos de status seguros. Nunca contém URL/token de provisionamento e não usa o fluxo de eventos do projeto.
Parâmetros
| Nome | Enviar | Obrigatório? | Descrição |
|---|---|---|---|
| Last-Event-ID | cabeçalho | opcional | Cursor durável usado quando after está ausente. |
Modelo e respostas da solicitação
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/stream/browser-links/events'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 200 | Status de emissão/reivindicação do Browser-link via SSE. | string (text/event-stream); cabeçalhos: Cache-Control, Referrer-Policy, X-Accel-Buffering |
| 400 | Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). 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 Runtime (application/problem+json) |
| 401 | Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). 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 Runtime (application/problem+json) |
| 410 | Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). 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 Runtime (application/problem+json) |
| padrão | Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). 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 Runtime (application/problem+json) |
Continuar link do navegador
GET autenticado apenas por cookie de proprietário para navegação. Após reivindicação, retorna um 303 sem corpo cuja Location sensível é a URL exata do Player /s/<public_id>#provision=<token>. A Location nunca é exposta via CORS, JSON, SSE, polling, logs, rastreamentos, métricas, análises, eventos ou erros e é idempotente apenas durante a curta janela de reparo de entrega.
Modelo e respostas da solicitação
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/screen/browser-links/continue'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 303 | Redirecionamento sem corpo para o fragmento de provisionamento do Player. | sem corpo; cabeçalhos: Location, Cache-Control, Referrer-Policy |
| 401 | Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). 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 Runtime (application/problem+json) |
| 409 | Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). 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 Runtime (application/problem+json) |
| 410 | Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). 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 Runtime (application/problem+json) |
| padrão | Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). 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 Runtime (application/problem+json) |
Obter página de configuração do link do navegador
Instruções de configuração somente leitura. Sem código, o cookie browser-link proprietário fornece status. Com código, retorna instruções públicas apenas, usando 404 genérico para códigos inválidos ou expirados. Aceita text/markdown ou format=markdown seleciona Markdown para o formulário público do código. Nenhuma URL ou token de provisionamento é retornado.
Parâmetros
| Nome | Enviar | Obrigatório? | Descrição |
|---|---|---|---|
| código | consulta | opcional | Código de configuração pública para instruções de configuração sem efeitos colaterais; não requer cookie. |
| formato | consulta | opcional |
Modelo e respostas da solicitação
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/setup'Respostas
| Status | Significado | Corpo e cabeçalhos |
|---|---|---|
| 200 | Configuração segura de HTML noindex. | string (text/html); cabeçalhos: Cache-Control, Referrer-Policy, X-Robots-Tag |
| 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) |
| 410 | 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) |