Referência da API

API de Dashboard

Painel de pessoas e projetos

Referência HTTP. Gerada a partir do contrato backend. Navegue pelos endpoints abaixo ou baixe o OpenAPI.

Este grupo tem 94 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.

Painel de pessoas e projetos

POST/api/invitations/inspect

Inspecionar convite do Dashboard

Inspeciona um convite sem consumi-lo. Nunca reporta estado de cadastro ou verificação, exceto que um reset de login reporta replaces_unverified_account. Um convite organization_admin ou organization_member informa o nome da organização e nenhum projeto.

Autenticação
nenhum
Corpo da solicitação
InvitationInspectRequest
ID da operação
inspectDashboardInvitation

Campos do corpo da solicitação

CampoDescrição
token (obrigatório, string)padrão: "^[A-Za-z0-9_-]{43}$"
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/invitations/inspect'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Inspeciona um convite sem consumi-lo.InvitationInspect (application/json); headers: 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)
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
POST/api/invitations/passkey-options

Iniciar convite de painel Passkey

Inicia uma cerimônia de registro de cinco minutos vinculada ao resumo e modo do convite. Link create_login requer cookie __Host-screenrig-signup verificado e usa seu nome.

Email create_login vincula o nome de exibição fornecido; reset vincula a pessoa alvo, exceto que um reset de um endereço não verificado registra a passkey para a nova pessoa que ele cria, nomeada pelo nome de exibição fornecido ou, quando ausente, a partir do endereço.

Esse reset exige replace_unverified_account true (a inspeção informa replaces_unverified_account) e, caso contrário, responde 409 unverified_account_replacement.

Autenticação
nenhum OU invitationSignup
Corpo da solicitação
Solicitação de opções de passkey de convite
ID da operação
startDashboardInvitationPasskey

Campos do corpo da solicitação

CampoDescrição
token (obrigatório, string)padrão: "^[A-Za-z0-9_-]{43}$"
mode (obrigatório, string)Permitido: "create_login", "reset"
display_name (opcional, DashboardDisplayName)Nome de exibição imprimível aparado, com no máximo 80 bytes UTF-8. Rejeita controles, texto com aparência de URL, @, www., :// e material de credenciais. Nunca autorização. minLength: 1 maxLength: 80
replace_unverified_account (opcional, boolean)

Somente reset de login (modo reset; qualquer outro modo o recusa). Deve ser true quando a inspeção informa replaces_unverified_account true, o que é o consentimento da pessoa para uma conta nova e vazia no lugar da conta não verificada que o endereço possui; ausente ou false, a resposta é 409 unverified_account_replacement e nenhuma cerimônia é iniciada.

Ignorado quando o reset não substitui nada. padrão: false

Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/invitations/passkey-options'

Respostas

StatusSignificadoCorpo e cabeçalhos
201Inicia uma cerimônia de registro de cinco minutos vinculada ao resumo e modo do convite.DashboardPasskeyRegistration (application/json); cabeçalhos: 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)
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
POST/api/invitations/email-verifications

Verificar e-mail de convite do Dashboard

Inicia um cadastro vinculado ao navegador e revoga cadastros anteriores para este convite. O desafio de verificação está vinculado a este cadastro. Autenticação de desenvolvimento verifica o cadastro imediatamente sem e-mail.

Autenticação
nenhum
Corpo da solicitação
InvitationEmailVerificationRequest
ID da operação
verifyDashboardInvitationEmail

Campos do corpo da solicitação

CampoDescrição
token (obrigatório, string)padrão: "^[A-Za-z0-9_-]{43}$"
display_name (obrigatório, DashboardDisplayName)Nome de exibição imprimível aparado, com no máximo 80 bytes UTF-8. Rejeita controles, texto com aparência de URL, @, www., :// e material de credenciais. Nunca autorização. minLength: 1 maxLength: 80
email (obrigatório, string)minLength: 3 maxLength: 254 formato: "email"
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/invitations/email-verifications'

Respostas

StatusSignificadoCorpo e cabeçalhos
202Inicia um cadastro vinculado ao navegador e revoga cadastros anteriores para este convite.InvitationEmailVerificationAccepted (application/json); headers: Set-Cookie, 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)
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
GET/api/invitations/signup

Obter inscrição de convite do dashboard

Retorna o cadastro ao vivo pertencente a este navegador. Um cookie de cadastro ausente, revogado, consumido ou expirado retorna invitation_invalid.

Autenticação
invitationSignup
Corpo da solicitação
nenhum
ID da operação
getDashboardInvitationSignup
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/invitations/signup'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Retorna o cadastro ao vivo pertencente a este navegador.Cadastro por convite (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)
POST/api/invitations/accept

Aceitar convite do dashboard

Aceita um convite transacionalmente e cria uma nova sessão de pessoa, excluindo a sessão antiga quando presente.

Link create_login requer o cookie verificado __Host-screenrig-signup para este convite. signed_in requer uma sessão do dashboard e login recente ou prova nova; a entrega por e-mail requer um e-mail verificado correspondente ou o endereço não verificado da pessoa que fez login, que a aceitação verifica.

Um endereço que uma pessoa ativa já possui, verificado ou não, retorna resource_conflict para create_login. Um reset autentica a pessoa que possui um endereço verificado.

Um reset de um endereço não verificado exige replace_unverified_account true (a inspeção informa replaces_unverified_account) e, caso contrário, responde 409 unverified_account_replacement e não consome nada; com ele, o reset cria uma nova pessoa verificada com a credencial que ele registra, nomeada por display_name ou, quando ausente, a partir do endereço, com uma nova organização e um novo projeto, e autentica essa pessoa; a pessoa não verificada é excluída (suas sessões, passkeys e agentes são encerrados) e os projetos e organizações que ela criou permanecem, sem ela e sem mais corresponder ao endereço como contato, de modo que nenhum reset posterior reenvia um convite de inscrição para eles.

A resposta nomeia o novo projeto. Uma sessão que exige verificação de e-mail (email_verification_required em GET /api/session) aceita apenas um convite enviado por e-mail que nomeie o próprio endereço e recebe 403 email_verification_required para qualquer outro.

Um convite organization_admin adiciona a pessoa aos administradores da organização e não abre nenhum projeto; retorna organization_admin_limit quando a organização já tem 20 administradores e permanece pendente, e resource_conflict quando a organização foi excluída.

Um convite organization_member define a organização principal da pessoa como a organização que convida, substituindo qualquer organização principal anterior, e não concede associação ao projeto; retorna managed_elsewhere (409) quando outra organização gerencia a pessoa, e resource_conflict quando a organização foi excluída.

Um convite organization_admin define a organização principal somente para uma pessoa que não tem nenhuma. Um convite project_member verifica novamente a política de convidados da organização e retorna guest_not_allowed (403) quando a pessoa seria um convidado externo que a política recusa; um convite de projeto nunca altera a organização principal de ninguém. Um convite recusado permanece pendente.

Autenticação
nenhum OU invitationSignup OU dashboardSession
Corpo da solicitação
InvitationAcceptRequest
ID da operação
acceptDashboardInvitation

Campos do corpo da solicitação

CampoDescrição
token (obrigatório, string)padrão: "^[A-Za-z0-9_-]{43}$"
mode (obrigatório, string)Permitido: "create_login", "signed_in", "reset"
display_name (opcional, DashboardDisplayName)Nome de exibição imprimível aparado, com no máximo 80 bytes UTF-8. Rejeita controles, texto com aparência de URL, @, www., :// e material de credenciais. Nunca autorização. minLength: 1 maxLength: 80
credencial (opcional, InvitationCredential)
proof (opcional, DashboardProof)
buyer (opcional, InvitationBuyer)
remove_other_passkeys (opcional, boolean)

Somente redefinição de login (mode reset). Remove as chaves de acesso da pessoa além da que esta redefinição registra, ou todas quando a redefinição define uma senha, para que um dispositivo perdido ou roubado deixe de entrar. Ausente significa true; qualquer outro convite o recusa. Uma redefinição de um endereço não verificado cria uma pessoa nova sem outras chaves de acesso e o ignora.

Uma redefinição que registra uma chave de acesso remove a senha, seja qual for este valor. default: true

replace_unverified_account (opcional, boolean)

Somente reset de login (modo reset; qualquer outro convite o recusa). Deve ser true quando a inspeção informa replaces_unverified_account true, o que é o consentimento da pessoa para uma conta nova e vazia no lugar da conta não verificada que o endereço possui; ausente ou false, a resposta é 409 unverified_account_replacement e nada é consumido.

Ignorado quando o reset não substitui nada. padrão: false

Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/invitations/accept'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Aceita um convite transacionalmente e cria uma nova sessão de pessoa, excluindo a sessão antiga quando presente.InvitationAccepted (application/json); headers: Set-Cookie, 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)
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
POST/api/signups/passkey-options

Iniciar passkey de cadastro do dashboard

Inicia uma cerimônia de registro de cinco minutos para um cadastro de autoatendimento, vinculada ao endereço de e-mail normalizado e ao nome de exibição. Não cria nada e não envia e-mail.

Um endereço que uma pessoa ativa possui, verificado ou não, retorna 409 account_exists; um endereço em um domínio cuja organização faz login por meio de um provedor de identidade retorna 403 sso_required; um endereço ou nome inválido retorna 400 invalid_request com erros de campo. Um servidor que executa a autenticação de desenvolvimento do dashboard retorna passkeys_disabled.

Limitado por endereço de cliente.

Autenticação
nenhum
Corpo da solicitação
SignupPasskeyOptionsRequest
ID da operação
startDashboardSignupPasskey

Campos do corpo da solicitação

CampoDescrição
email (obrigatório, string)minLength: 3 maxLength: 254 formato: "email"
display_name (obrigatório, DashboardDisplayName)Nome de exibição imprimível aparado, com no máximo 80 bytes UTF-8. Rejeita controles, texto com aparência de URL, @, www., :// e material de credenciais. Nunca autorização. minLength: 1 maxLength: 80
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/signups/passkey-options'

Respostas

StatusSignificadoCorpo e cabeçalhos
201Inicia uma cerimônia de registro de cinco minutos para um cadastro de autoatendimento.DashboardPasskeyRegistration (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)
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)
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)
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)
POST/api/signups

Criar cadastro no dashboard

Cria uma conta de autoatendimento e faz o login deste navegador.

Uma transação cria a pessoa com um endereço de e-mail não verificado e um prazo de verificação de 72 horas, registra a passkey da cerimônia que POST /api/signups/passkey-options iniciou, cria a organização e o projeto da pessoa como a inscrição do agente os cria, torna a pessoa o proprietário do projeto, armazena a escolha sobre e-mails de marketing e enfileira o e-mail de verificação (purpose account_email).

O visitante do site que abriu a página é vinculado à conta e o cadastro é contado como signed_up. A resposta define o cookie de sessão do dashboard. As recusas são as de POST /api/signups/passkey-options; uma cerimônia usada, expirada ou incompatível retorna 400 invalid_request. Limitado por endereço de cliente e por endereço de e-mail.

Autenticação
nenhum
Corpo da solicitação
SignupRequest
ID da operação
createDashboardSignup

Campos do corpo da solicitação

CampoDescrição
email (obrigatório, string)minLength: 3 maxLength: 254 formato: "email"
display_name (obrigatório, DashboardDisplayName)Nome de exibição imprimível aparado, com no máximo 80 bytes UTF-8. Rejeita controles, texto com aparência de URL, @, www., :// e material de credenciais. Nunca autorização. minLength: 1 maxLength: 80
marketing_email (obrigatório, boolean)A pessoa optou por receber novidades do produto por e-mail. Armazenado como consentimento junto com a pessoa.
credential (obrigatório, DashboardPasskeyProof)
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/signups'

Respostas

StatusSignificadoCorpo e cabeçalhos
201A conta existe e este navegador tem a sessão dela.SignupCreated (application/json); cabeçalhos: Cache-Control, Set-Cookie, 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)
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)
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)
PUT/api/session/project

Trocar projeto do dashboard

Alterna para um dos projetos da pessoa e atualiza seu último uso. Um membro da equipe também pode alternar para um projeto que eles monitoram; essa sessão indica shadow true, é somente leitura e não atualiza o último uso. Qualquer outro projeto retorna not_found.

Autenticação
dashboardSession
Corpo da solicitação
DashboardProjectSwitch
ID da operação
switchDashboardProject

Campos do corpo da solicitação

CampoDescrição
project_id (obrigatório, string)minLength: 1
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/session/project'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Alterna para um dos projetos da pessoa e atualiza seu último uso.DashboardSession (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)
GET/api/members

Listar membros no dashboard

Lista membros do projeto atual sem seus endereços de e-mail privados.

Todo membro tem a mesma autoridade, exceto o gerenciamento de membros (remoção, aprovador, escopos, propriedade), que cabe ao proprietário e a um administrador da organização do projeto que seja membro. owner marca o proprietário do projeto, external marca um convidado (a organização principal do membro não é a organização do projeto), e viewer_user_id e viewer_is_owner descrevem a pessoa com a sessão iniciada.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
listDashboardMembers
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/members'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Lista membros do projeto atual sem seus endereços de e-mail privados.DashboardMemberList (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)
EXCLUIR/api/members/{user_id}

Remover membro do Dashboard

Remove um membro do projeto atual. O proprietário do projeto remove qualquer outro membro, assim como um administrador da organização do projeto que é membro; qualquer membro remove a si mesmo para sair. O proprietário nunca é removido e nunca sai (owner_cannot_leave; transfira a propriedade primeiro). Um membro removendo outra pessoa é recusado com owner_required.

Uma pessoa que não é membro, inclusive uma já removida, é not_found. Em uma transação, a associação termina, os convites por e-mail pendentes dessa pessoa para o projeto são revogados, e o evento do projeto member.removed é anexado (detalhes user_id, removed_by_user_id, left).

As sessões da pessoa param de resolver o projeto na próxima solicitação e voltam ao estado padrão como após a exclusão de um projeto. As associações de agentes são separadas e permanecem. Somente pessoas; sem rota bearer.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
removeDashboardMember

Parâmetros

NomeEnviarObrigatório?Descrição
user_idcaminhoobrigatório
project_idconsultaobrigatórioO projeto que o chamador quer dizer; uma sessão cuja seleção mudou é recusada com resource_conflict.
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/members/USER_ID?project_id=PROJECT_ID'

Respostas

StatusSignificadoCorpo e cabeçalhos
204A associação terminou.sem corpo
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)
GET/api/members/{user_id}/activity

Listar atividade dos membros

A atividade de uma pessoa no projeto atual, as mais recentes primeiro: seus acessos (e acessos recusados nomeando seu endereço ou passkey), saídas, trocas para o projeto, mudanças de credenciais, provas de reautenticação e cada mudança que fizeram pelo painel, incluindo recusadas e falhas. Leituras nunca são registradas.

Solicitações do agente e CLI estão em seus agentes (listDashboardAgentEvents). A sombra de um membro da equipe do projeto não registra nada; uma alteração feita sob um contrato de escrita aprovado de um membro da equipe é uma linha desse membro da equipe com origem na equipe.

A própria pessoa, o proprietário do projeto, um admin da organização do projeto e um membro da equipe acompanhando o projeto podem ler. Qualquer outro recebe not_found, assim como uma pessoa que não é membro nem tem linhas aqui, então a resposta nunca revela quem pertence; linhas de ex-membros permanecem legíveis.

O projeto é da sessão, nunca da solicitação, e apenas as linhas desse projeto são retornadas.

Cada valor é derivado do servidor: a ação da rota que o servidor correspondeu (ou uma ação de conta nomeada como session.sign_in ou passkey.add), o recurso do primeiro valor do caminho da rota quando é um identificador emitido pelo servidor, status, problem_code e erro do registro de problemas, o cliente analisado do User-Agent e dica de plataforma (o User-Agent bruto não é mantido).

Nenhum corpo de solicitação, senha, token ou cookie é armazenado. client_ip e email são exibidos conforme registrados.

Chaves de paginação em (at, id) descendente. Passe next_cursor como after para continuar; é nulo no fim. Uma linha escrita enquanto isso só aparece antes da primeira página e retenção remove as linhas mais antigas, então um cursor nunca repete ou pula uma linha sobrevivente. Cursor ou filtro malformado é recusado com invalid_request; limite fora de 1-100 é padrão.

As linhas expiram na janela de retenção de eventos do projeto no momento em que foram escritas. recorded_since é o tempo da linha mais antiga sobrevivente do projeto ou, antes de qualquer uma, quando este servidor começou a registrar; nada antes disso é reconstruído.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
listMemberActivity

Parâmetros

NomeEnviarObrigatório?Descrição
user_idcaminhoobrigatório
depoisconsultaopcionalCursor da next_cursor da página anterior.
limiteconsultaopcional
kindconsultaopcionalSó esses tipos; repita o parâmetro ou separe tipos com vírgulas.
resultadoconsultaopcional
resource_typeconsultaopcionalTipo exato do objeto que a requisição agiu.
resource_idconsultaopcionalIdentificador exato do objeto que a requisição agiu.
desdeconsultaopcional
atéconsultaopcional
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/members/USER_ID/activity'

Respostas

StatusSignificadoCorpo e cabeçalhos
200A atividade da pessoa no projeto atual.MemberActivityList (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)
GET/api/me

Obter dados do usuário do dashboard

Retorna o perfil da pessoa conectada e contagem de credenciais.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
getDashboardMe
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/me'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Retorna o perfil da pessoa conectada e contagem de credenciais.DashboardMe (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)
EXCLUIR/api/me

Excluir eu do dashboard

Marca para exclusão a pessoa conectada. Protegido por prova: o corpo carrega uma prova de login recente verificada contra uma reautenticação vinculada a esta sessão com tipo account_delete e subject_id igual ao id do usuário da pessoa conectada (inicie com POST /api/me/reauthentications). Sem reautenticação atual, a resposta é reauthentication_required.

Em caso de sucesso, a resposta é 204, o cookie de sessão do dashboard é limpo e o cache HTTP do navegador para a origem do dashboard é limpo como ao sair.

Autenticação
dashboardSession
Corpo da solicitação
DashboardProofRequest
ID da operação
deleteDashboardMe

Campos do corpo da solicitação

CampoDescrição
proof (obrigatório, DashboardProof)
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me'

Respostas

StatusSignificadoCorpo e cabeçalhos
204Pessoa excluída, cookie de sessão do dashboard limpo e cache HTTP do navegador para esta origem limpo.sem corpo; cabeçalhos: Clear-Site-Data
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)
POST/api/me/reauthentications

Iniciar reautenticação do painel

Inicia o passo-up passkey vinculado à sessão, tipo e assunto. Pessoa sem passkey recebe resource_conflict e usa prova de senha.

Autenticação
dashboardSession
Corpo da solicitação
DashboardReauthenticationRequest
ID da operação
startDashboardReauthentication

Campos do corpo da solicitação

CampoDescrição
kind (obrigatório, string)

Permitido: "agent_connection_approval", "agent_connection_denial", "agent_disconnect", "email_change", "password_set", "passkey_add", "passkey_delete", "invitation_accept", "account_delete", "staff_grant", "staff_action", "staff_featuresets", "staff_education_eligible", "dashboard_token", "oauth_authorization_approval", "oauth_authorization_denial", "service_client_change", "review_policy_change", "identity_provider_change", "sso_policy_change", "scim_change"

subject_id (opcional, string)

O assunto ao qual a reautenticação se vincula. kind account_delete requer o ID do usuário da pessoa conectada. kind staff_grant é apenas para a equipe e requer o e-mail da pessoa adicionada. kind staff_action requer o request_id específico preparado. kind staff_featuresets é apenas para a equipe e requer o ID da organização (substituindo seus featuresets). kind staff_education_eligible é apenas para a equipe e requer o ID da organização (marcando-a como escola ou distrito K-12 verificado, ou removendo a marca). kind dashboard_token é apenas para a equipe e requer o ID do usuário da pessoa da equipe conectada (criando ou substituindo um token de link do dashboard). kinds oauth_authorization_approval e oauth_authorization_denial requerem o ID da autorização (oaz_...). kind service_client_change requer o ID do cliente de serviço, ou o ID do projeto ao criar um cliente. kind review_policy_change requer o ID do projeto (desativando a exigência de revisão para alterações de agente). kinds identity_provider_change, sso_policy_change e scim_change requerem o ID da organização (um administrador da organização alterando sua conexão de login único, sua política Require SSO ou suas configurações e tokens de SCIM); uma sessão iniciada por login único prova com {type: sso} em vez disso e não inicia nenhuma reautenticação. minLength: 1

Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me/reauthentications'

Respostas

StatusSignificadoCorpo e cabeçalhos
201Inicia o passo-up passkey vinculado à sessão, tipo e assunto.DashboardReauthentication (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)
PUT/api/me/password

Definir senha do dashboard

Define ou substitui a senha da pessoa após prova recente. A primeira senha requer prova de passkey; substituição aceita a senha atual ou uma passkey. Revoga outras sessões e enfileira um aviso de alteração de login.

Uma pessoa cujo endereço de e-mail não foi verificado, como um cadastro de autoatendimento antes de a pessoa verificá-lo, não pode definir uma senha e recebe 403 email_verification_required.

Autenticação
dashboardSession
Corpo da solicitação
DashboardPasswordSet
ID da operação
setDashboardPassword

Campos do corpo da solicitação

CampoDescrição
senha (obrigatório, string)12–128 bytes UTF-8, sem espaços. Não pode ser igual ao e-mail, nome de exibição ou senha comum do pacote. Armazenado apenas como hash Argon2id. minLength: 12 maxLength: 128 pattern: "^\\S+$"
proof (obrigatório, DashboardProof)
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me/password'

Respostas

StatusSignificadoCorpo e cabeçalhos
204Define ou substitui a senha da pessoa após prova recente.sem corpo
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)
GET/api/me/passkeys

Listar passkeys no dashboard

Lista as passkeys da pessoa com o que um cliente precisa para manter o gerenciador de senhas do navegador em sincronia com elas (a WebAuthn Signal API). A lista traz o ID da parte confiável e o identificador de usuário (user handle) sob os quais as passkeys estão registradas, e cada passkey traz o seu ID de credencial e o provedor informado pelo autenticador dela.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
listDashboardPasskeys
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/me/passkeys'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Lista as passkeys da pessoa.DashboardPasskeyList (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)
POST/api/me/passkeys/options

Iniciar registro Passkey do painel

Verifica prova recente e inicia um registro vinculado à sessão e pessoa. Passkeys estão desativadas sob autenticação em desenvolvimento.

Autenticação
dashboardSession
Corpo da solicitação
DashboardProofRequest
ID da operação
startDashboardPasskeyRegistration

Campos do corpo da solicitação

CampoDescrição
proof (obrigatório, DashboardProof)
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me/passkeys/options'

Respostas

StatusSignificadoCorpo e cabeçalhos
201Verifica prova recente e inicia um registro vinculado à sessão e pessoa.DashboardPasskeyRegistration (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)
POST/api/me/passkeys/complete

Concluir registro de passkey do Dashboard

Armazena a nova passkey, revoga as outras sessões da pessoa e enfileira uma notificação de alteração de login. Uma passkey enviada sem nome recebe o nome do seu provedor, ou Passkey quando o autenticador não informou nenhum provedor que a lista conheça.

Autenticação
dashboardSession
Corpo da solicitação
DashboardPasskeyComplete
ID da operação
completeDashboardPasskeyRegistration

Campos do corpo da solicitação

CampoDescrição
ceremony_id (obrigatório, string)minLength: 1
credencial (obrigatório, objeto)Resposta de credencial WebAuthn.
nome (opcional, string)

O nome que a pessoa dá à passkey. Se omitido, a passkey recebe o nome do seu provedor (por exemplo, iCloud Keychain), ou Passkey quando o autenticador não informou nenhum provedor que a lista conheça. minLength: 1 maxLength: 60

Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me/passkeys/complete'

Respostas

StatusSignificadoCorpo e cabeçalhos
201Armazena a nova chave de acesso, revoga outras sessões da pessoa e enfileira notificação de alteração de login.DashboardPasskey (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)
PATCH/api/me/passkeys/{id}

Renomear passkey do dashboard

Renomeia um passkey pertencente à pessoa conectada.

Autenticação
dashboardSession
Corpo da solicitação
DashboardPasskeyPatch
ID da operação
renameDashboardPasskey

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório

Campos do corpo da solicitação

CampoDescrição
nome (obrigatório, string)minLength: 1 maxLength: 60
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request PATCH --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me/passkeys/RESOURCE_ID'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Renomeia um passkey pertencente à pessoa conectada.DashboardPasskey (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)
EXCLUIR/api/me/passkeys/{id}

Excluir passkey do dashboard

Exclui uma passkey após prova recente e envia uma notificação de alteração de login. Remover o último método de login retorna last_credential. Uma pessoa cuja conta requer passkey (todo membro da equipe) não pode remover sua última passkey; isso retorna 409 resource_conflict.

Autenticação
dashboardSession
Corpo da solicitação
DashboardProofRequest
ID da operação
deleteDashboardPasskey

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório

Campos do corpo da solicitação

CampoDescrição
proof (obrigatório, DashboardProof)
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me/passkeys/RESOURCE_ID'

Respostas

StatusSignificadoCorpo e cabeçalhos
204Exclui uma passkey após prova recente e envia uma notificação de alteração de login.sem corpo
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)
GET/api/me/email

Obter e-mail do dashboard

Retorna o estado do e-mail verificado e pendente da pessoa. Uma pessoa que se cadastrou por conta própria mantém um endereço não verificado até abrir o link enviado a ele; email_verified é false e verify_by é o prazo, após o qual a sessão pode usar apenas as rotas que verificam ou alteram o endereço (email_verification_required em GET /api/session).

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
getDashboardEmail
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/me/email'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Retorna o estado de e-mail verificado e pendente da pessoa.DashboardEmail (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)
POST/api/me/email/change

Alterar e-mail do Dashboard

Solicita uma alteração de e-mail após prova nova. O endereço verificado continua em vigor enquanto a verificação está pendente. Um endereço que qualquer outra pessoa ativa possui, verificado ou não, retorna user_email_conflict. O endereço antigo recebe um aviso, não um link para desfazer.

Uma pessoa cujo endereço não foi verificado o altera da mesma forma; verificar o novo endereço o torna o endereço verificado da pessoa e limpa verify_by.

Autenticação
dashboardSession
Corpo da solicitação
UserEmailChangeRequest
ID da operação
changeDashboardEmail

Campos do corpo da solicitação

CampoDescrição
email (obrigatório, string)minLength: 3 maxLength: 254 formato: "email"
proof (obrigatório, DashboardProof)
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me/email/change'

Respostas

StatusSignificadoCorpo e cabeçalhos
202Solicita uma alteração de e-mail após prova recente.UserEmailChangeAccepted (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)
POST/api/me/email/verification

Solicitar verificação de e-mail do dashboard

Enfileira um novo link de verificação. Enquanto uma alteração de e-mail aguarda verificação (pending_email em GET /api/me/email), ele é o link dessa alteração, enviado ao endereço pendente; caso contrário, é um link account_email para o endereço atual não verificado da pessoa. Até dez minutos depois do último link do mesmo tipo, não enfileira nada e ainda responde 202.

Uma pessoa cujo endereço é verificado e que não tem alteração pendente retorna 409 resource_conflict.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
requestDashboardEmailVerification
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/me/email/verification'

Respostas

StatusSignificadoCorpo e cabeçalhos
202O link de verificação está na fila ou foi enfileirado nos últimos dez minutos.DashboardEmailVerificationAccepted (application/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)
PUT/api/me/signup-profile

Colocar perfil de cadastro do dashboard

Substitui as respostas que a pessoa deu após o cadastro pelo corpo, que contém todas as respostas até agora; um membro omitido, ou null, fica sem resposta. Cada membro tem um conjunto fechado de valores, e um valor fora dele retorna 400 invalid_request com um erro de campo.

O perfil é mantido junto com a pessoa e exibido à equipe do screenRIG com a organização na qual a pessoa se cadastrou.

Autenticação
dashboardSession
Corpo da solicitação
SignupProfile
ID da operação
putDashboardSignupProfile

Campos do corpo da solicitação

CampoDescrição
who_for (opcional, inline)
use_case (opcional, inline)
screen_range (opcional, inline)
go_live (opcional, inline)
devices (opcional, inline)
role (opcional, inline)
firm_kind (opcional, inline)
agent (opcional, inline)
agent_other (opcional, inline)O nome do agente quando agent é other.
heard (opcional, inline)
heard_detail (opcional, inline)
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me/signup-profile'

Respostas

StatusSignificadoCorpo e cabeçalhos
204O perfil é armazenado.sem corpo
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)
GET/api/applications/{id}/usage

Obter uso de aplicativo do dashboard

Onde um aplicativo (app web) do projeto da sessão é posicionado, calculado em uma única passagem pelas playlists do projeto e uma leitura das telas que as têm. placements são as primitivas de aplicativo cujo aplicativo proprietário armazenado é este aplicativo, em ordem de playlist (a ordem da lista de playlists), página e primitiva; uma playlist que o posiciona duas vezes tem dois. release informa como cada versão fixada se compara com a latest_ready_release do aplicativo: latest, older ou unknown enquanto ele não tem nenhuma. screens são as telas pairing_pending e ativas que têm uma playlist de um posicionamento como padrão, a agendam, a usam em um takeover ou a exibem no momento, as mais recentes primeiro; telas arquivadas nunca contam, e uma tela cujo Player não consegue exibir apps web carrega applications_unsupported.

Um membro ou agente limitado a telas (screen_scope) vê apenas as suas telas, e screen_count conta somente essas. Isso não é o que bloqueia a exclusão, que são as concessões de runtime (o manifesto de uma tela que contém uma versão). Um id que o projeto não tem é not_found, como em getApplication. A resposta é privada e no-store.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
getDashboardApplicationUsage

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/applications/RESOURCE_ID/usage'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Onde o aplicativo é posicionado.ApplicationUsage (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)
POST/api/advertising/inventory/{screen_id}

Colocar inventário de publicidade do painel

Autenticação
dashboardSession
Corpo da solicitação
AdvertisingInventoryWrite
ID da operação
putDashboardAdvertisingInventory

Parâmetros

NomeEnviarObrigatório?Descrição
ScreenRig-ProjectcabeçalhoopcionalObsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
screen_idcaminhoobrigatório
If-MatchcabeçalhoopcionalRevisão positiva opcional do recurso. Omitir para escrever o recurso atual; uma revisão obsoleta fornecida é revision_conflict.

Campos do corpo da solicitação

CampoDescrição
impressions_per_hour (opcional, inline)

A estimativa do vendedor das impressões que esta tela entrega em uma hora. Cada exibição concluída conta este valor vezes os seus segundos sobre 3600 como impressões estimadas nos relatórios. Null ou ausente significa sem estimativa.

ads_enabled (obrigatório, booleano)
site_name (opcional, string)maxLength: 120
cidade (opcional, string)maxLength: 120
região (opcional, string)maxLength: 120
venue_type (opcional, string)maxLength: 64
audience_tags (opcional, array)
posicionamento (opcional, string)maxLength: 120
public_description (opcional, string)maxLength: 500
rate_override_mcr_per_15s (opcional, inline)Nulo restaura a herança do padrão do projeto; nunca significa zero.
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/inventory/SCREEN_ID'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Inventário armazenado.AdvertisingInventory (application/json)
403outside_screen_scope como em OutsideScreenScope, ou approver_required - um membro limitado a telas que não pode aprovar revisões não altera o que uma tela reproduz nem quando (docs/screen-scope.md).Problema (application/problem+json)
409

protected_target - a alteração alcança uma tela em uma pasta de telas protegida e não tem forma de revisão (docs/screen-scope.md). Remova a proteção da pasta por meio de uma revisão, faça a alteração e proteja a pasta de novo.

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)
GET/api/media/{id}/usage

Obter uso de mídia do dashboard

Onde um item de mídia pronto do projeto da sessão é usado, calculado em uma única passagem pelas playlists do projeto e uma leitura das telas que as têm. playlists são as que nomeiam o arquivo (os ids estáticos de uma primitiva de imagem ou vídeo e um seletor por id ou ids, o fallback de um stream, uma string media:<id> nos params de um cartão, o logo de um stinger, uma faixa de trilha sonora), depois as cujos seletores tag, folder ou all o alcançam, cada grupo na ordem da lista de playlists; uma playlist é uma entrada cujo uses lista cada forma, os tipos exatos primeiro.

Os seletores são avaliados como o runtime os resolve: um filtro de tag corresponde à tag e às tags do arquivo, um seletor de pasta aos arquivos diretamente dentro da pasta, um seletor all a todos os arquivos do tipo, e um arquivo pendente pelas suas últimas tags e pasta aprovadas (um arquivo nunca aprovado não é alcançado por nenhum).

Rotação (batch_size, one_at_a_time), janelas de disponibilidade, ajuste de proporção e a visibilidade de uma página não são avaliados. screens são as telas pairing_pending e ativas que têm uma dessas playlists como padrão, a agendam, a usam em um takeover ou a exibem no momento, as mais recentes primeiro; telas arquivadas nunca contam.

Um membro ou agente limitado a telas (screen_scope) vê apenas as suas telas, e screen_count conta somente essas. Um id que o projeto não tem, ou um item de mídia que não está pronto, é not_found, como em getMedia. A resposta é privada e no-store.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
getDashboardMediaUsage

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/media/RESOURCE_ID/usage'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Onde a mídia é usada.MediaUsage (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)
GET/api/media/{id}/thumbnail

Obter miniatura de mídia do dashboard

Retorna um pequeno WebP com perda de qualidade de uma imagem pronta pertencente ao projeto da sessão, para que as grades do painel nunca decodifiquem originais. Há um tamanho: cabe dentro de 512 x 512 mantendo a proporção e nunca é ampliado, e uma imagem animada mostra seu primeiro quadro.

A primeira solicitação a gera e armazena ao lado do original; solicitações posteriores transmitem a cópia armazenada, e excluir o mídia remove-a junto com o original. O identificador de outro projeto, vídeo, áudio e mídia que não está pronto retornam not_found. Range não é aceito.

O ETag é forte e nomeia o original e o gerador de miniaturas, então é o mesmo em toda requisição e host. A resposta é privada, no-cache, e um If-None-Match que corresponde, verificado após a mídia resolver no projeto da sessão, retorna 304 sem ler a miniatura. Bytes completos são registrados como egressos dashboard_media.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
getDashboardMediaThumbnail

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório
If-None-MatchcabeçalhoopcionalETag da miniatura retornada por esta rota.
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/media/RESOURCE_ID/thumbnail'

Respostas

StatusSignificadoCorpo e cabeçalhos
200A miniatura WebP.string (image/webp); cabeçalhos: Content-Length, Content-Disposition, ETag, Cache-Control, X-Content-Type-Options
304O ETag da miniatura corresponde ao If-None-Match. Nenhum corpo ou incremento de saída é produzido.sem corpo; cabeçalhos: ETag, Cache-Control
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)
HEAD/api/media/{id}/thumbnail

Miniatura de mídia do painel principal

Aplica as mesmas regras de propriedade, condicionais e geração que getDashboardMediaThumbnail e retorna seus cabeçalhos sem o corpo. Nenhuma saída é registrada.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
headDashboardMediaThumbnail

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório
If-None-MatchcabeçalhoopcionalETag da miniatura retornada por esta rota.
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request HEAD --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/media/RESOURCE_ID/thumbnail'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Metadados da miniatura sem corpo.sem corpo; cabeçalhos: Content-Length, Content-Disposition, ETag, Cache-Control, X-Content-Type-Options
304O ETag da miniatura corresponde ao If-None-Match. Nenhum incremento de saída é produzido.sem corpo; cabeçalhos: ETag, Cache-Control
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)
GET/api/email/verify

Verificação de e-mail do painel Peek

Verificação segura para scanner. Nunca verifica um endereço, altera um usuário ou autentica o visitante. Informa o propósito e o estado do link; um link account_email pendente só verifica para uma requisição que traga a sessão do dashboard da pessoa, então uma página pede o login antes de pedir a confirmação.

Autenticação
nenhum
Corpo da solicitação
nenhum
ID da operação
peekDashboardEmailVerification

Parâmetros

NomeEnviarObrigatório?Descrição
tokenconsultaobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET 'https://screenrig.ai/api/email/verify?token=TOKEN'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Status da verificação.EmailVerifyResult (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)
POST/api/email/verify

Verificar e-mail do Dashboard

A confirmação humana explícita consome um desafio de verificação vinculado a um propósito. Os desafios de cadastro por link requerem o cookie __Host-screenrig-signup correspondente; os desafios de alteração de e-mail são vinculados a token, portanto o link funciona em qualquer navegador.

Um desafio account_email (enviado por e-mail no cadastro de autoatendimento e por POST /api/me/email/verification, válido por 30 dias) abre em qualquer navegador, mas só verifica para uma requisição que traga uma sessão ativa do dashboard da pessoa a quem o link se destina, inclusive uma sessão que email_verification_required limita a esta rota.

Sem sessão, ou com a de outra pessoa, responde 200 sign_in_required, não verifica nada e deixa o link utilizável. Um link account_email verificado marca o endereço da pessoa como verificado e encerra o prazo de verificação; responde superseded quando outra pessoa verificou o mesmo endereço primeiro. A verificação nunca autentica o visitante.

Autenticação
nenhum OU invitationSignup OU dashboardSession
Corpo da solicitação
EmailVerifyRequest
ID da operação
verifyDashboardEmail

Campos do corpo da solicitação

CampoDescrição
token (obrigatório, string)minLength: 1
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/email/verify'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Status da verificação.EmailVerifyResult (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)
POST/api/webauthn/assertions

Iniciar afirmação Passkey do painel

Inicia uma cerimônia de afirmação WebAuthn sem nome de usuário e retorna as opções de requisição literalmente para navigator.credentials.get. Nenhum cookie é necessário, e nenhuma lista allowCredentials é publicada, então a rota não revela quais usuários ou credenciais existem. A cerimônia expira com DashboardCeremonyTTL de cinco minutos.

Quando o servidor executa autenticação de desenvolvimento do dashboard, esta rota retorna passkeys_disabled.

Autenticação
nenhum
Corpo da solicitação
nenhum
ID da operação
startDashboardPasskeyAssertion
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST 'https://screenrig.ai/api/webauthn/assertions'

Respostas

StatusSignificadoCorpo e cabeçalhos
201Opções de solicitação WebAuthn vinculadas a esta cerimônia.DashboardPasskeyAssertion (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)
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)
POST/api/webauthn/assertions/complete

Concluir afirmação de passkey do Dashboard

Verifica uma asserção sem nome de usuário e cria o cookie de sessão do dashboard para o usuário identificado pela credencial descobrível. Nenhum cookie autentica a solicitação. Uma cerimônia desconhecida, expirada ou já usada retorna passkey_invalid, assim como uma asserção que a parte confiável não pode verificar ou um contador de assinatura que retrocede.

Uma cerimônia válida cujo identificador de credencial não está registrado para ninguém (nenhuma credencial armazenada o tem, de nenhuma pessoa) retorna, em vez disso, 401 passkey_unknown; essa resposta vale somente para esse único caso, então um cliente pode instruir o navegador a esquecer a credencial (PublicKeyCredential.signalUnknownCredential) com base nela e em nenhuma outra.

O identificador da credencial não é autorização por si só: a asserção assinada é. Uma pessoa cujo endereço verificado está em um domínio cuja organização exige login único é recusada com 403 sso_required, a menos que seja um administrador de emergência (break-glass) dessa organização; esse login é auditado.

Quando o servidor executa autenticação de desenvolvimento do dashboard, esta rota retorna passkeys_disabled.

Autenticação
nenhum
Corpo da solicitação
DashboardPasskeyAssertionComplete
ID da operação
completeDashboardPasskeyAssertion

Campos do corpo da solicitação

CampoDescrição
ceremony_id (obrigatório, string)
credencial (obrigatório, objeto)Resposta de asserção WebAuthn serializada do PublicKeyCredential retornado pelo autenticador.
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/webauthn/assertions/complete'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Cookie de sessão criado a partir de uma asserção verificada.DashboardSession (application/json); cabeçalhos: Cache-Control, Set-Cookie
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)
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)
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)
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)
POST/api/sessions

Criar sessão do dashboard

Faz login da pessoa identificada por e-mail verificado e senha. E-mail desconhecido, sem senha e senha errada retornam a mesma resposta não autorizada. Abre o último projeto usado se ainda for uma associação, caso contrário a associação mais recente, ou nenhum projeto.

Um endereço em um domínio cuja organização exige login único é recusado com 403 sso_required antes de qualquer conta ser consultada, de modo que a resposta não depende de uma pessoa possuir ou não o endereço; POST /api/sso/starts autentica essa pessoa pelo provedor de identidade dela.

O login com senha requer um e-mail verificado; por isso, uma pessoa que se cadastrou por conta própria (POST /api/signups) faz login com a passkey, e quem definiu uma senha em um endereço não verificado ainda recebe a resposta unauthorized. A autenticação de desenvolvimento usa esse mesmo fluxo de senha.

Autenticação
nenhum
Corpo da solicitação
DashboardPasswordLogin
ID da operação
createDashboardSession

Campos do corpo da solicitação

CampoDescrição
email (obrigatório, string)O endereço de e-mail verificado da pessoa. E-mail desconhecido, sem senha e senha incorreta retornam a mesma resposta não autorizada. minLength: 3 maxLength: 254 format: "email"
senha (obrigatório, string)minLength: 12 maxLength: 128
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/sessions'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Sessão da pessoa criada a partir de e-mail e senha verificados.DashboardSession (application/json); cabeçalhos: Cache-Control, Set-Cookie, 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)
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)
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)
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)
GET/api/session

Obter sessão do dashboard

Retorna a sessão atual do dashboard. O cookie de sessão e a sessão do lado do servidor estabelecem autoridade; user_id é descritivo. Uma resposta 401 significa que é necessário entrar.

O campo dev_auth é reservado para desenvolvimento local e é falso no serviço hospedado. organization é a organização principal da pessoa, ausente enquanto ela não tem nenhuma; project.organization_admin informa se a pessoa administra a organização do projeto atual.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
getDashboardSession
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/session'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Sessão atual do dashboard.DashboardSession (application/json); 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)
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)
POST/api/logout

Sair da sessão do Dashboard

Exclui a linha de sessão do lado do servidor e expira o cookie da sessão. Não exclui o usuário nem remove nenhuma credencial. É intrinsecamente idempotente e não aceita Idempotency-Key.

Um logout bem-sucedido também limpa o cache HTTP do navegador para a origem do dashboard, eliminando os bytes privados, sem cache de mídia, screenshot e revisão de anúncios que a sessão visualizou; uma sessão que apenas expira os deixa até o navegador os remover.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
logoutDashboardSession
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/logout'

Respostas

StatusSignificadoCorpo e cabeçalhos
204Linha de sessão excluída, cookie de sessão expirado e cache HTTP do navegador para esta origem limpo.sem corpo; cabeçalhos: Cache-Control, Set-Cookie, Clear-Site-Data
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)
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)
POST/api/onboarding/steps

Registrar etapa de onboarding

Reporta uma etapa do percurso de um navegador pelos fluxos de entrada do dashboard (cadastro, login, redefinição, convite e adição de uma passkey) para a leitura de onboarding da equipe. Acesso público: funciona com e sem uma sessão do dashboard.

A jornada é o id aleatório do próprio navegador; o servidor também guarda o cookie de visitante da edge quando a requisição traz um, e a pessoa e a organização quando há uma sessão. Uma jornada é restrita à equipe e guarda os valores reais que as pessoas informaram (endereços, nomes, respostas); nunca recebe senha, código ou token.

O primeiro valor de mode, source, utm_source, utm_medium, utm_campaign, click_kind, site_trail e site_cta é mantido; cada etapa mantém seu primeiro horário, e o value e o detail de uma etapa e o e-mail da jornada (de email_submitted) são os mais recentes. source é aceito somente com entry_viewed. question é obrigatório com as etapas question_* e recusado com qualquer outra. detail é um código de problema para uma etapa *_failed, o método de login para signed_in, ou connected ou skipped para signup_finished. email_verified, email_gate_reached, site_visited, site_cta_clicked e os marcos da conta são gravados ou derivados pelo servidor e são recusados aqui.

Somente os comprimentos são limitados. Limitado por endereço de cliente.

Autenticação
nenhum
Corpo da solicitação
OnboardingStepRequest
ID da operação
recordOnboardingStep

Campos do corpo da solicitação

CampoDescrição
journey_id (obrigatório, string)A jornada do navegador: um UUID RFC 4122 em minúsculas que o dashboard mantém em seu próprio armazenamento. pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
step (obrigatório, OnboardingStepName)

Uma etapa dos fluxos de entrada, em ordem de exibição. email_verified, email_gate_reached e os marcos da conta (agent_connected, screen_paired, playlist_with_content, activated) são gravados ou incorporados pelo servidor e não são nomes que um cliente envia.

Permitido: "entry_viewed", "returning_shown", "email_submitted", "address_new", "address_existing", "address_sso", "address_failed", "signup_form_viewed", "signup_name_entered", "signup_marketing_choice", "passkey_unsupported", "passkey_started", "passkey_cancelled", "signup_failed", "account_created", "question_shown", "question_answered", "question_follow_up", "question_skipped", "connect_viewed", "connect_copied", "agent_approved", "signup_finished", "dashboard_opened", "signin_passkey_started", "signin_passkey_cancelled", "signin_password_started", "signin_sso_started", "signin_failed", "signed_in", "reset_viewed", "reset_requested", "reset_opened", "reset_completed", "invite_viewed", "invite_email_sent", "invite_passkey_started", "invite_passkey_cancelled", "invite_failed", "invite_accepted", "passkey_upgrade_shown", "passkey_add_started", "passkey_add_cancelled", "passkey_added"

mode (opcional, string)O modo da página de entrada. O primeiro valor é mantido. Permitido: "login", "signup"
source (opcional, string)

Somente com entry_viewed: de onde a pessoa veio, como a página de entrada o nomeia: o caminho do link de cadastro, a última página do site, o host de referência ou direct. Mantido como enviado. O primeiro valor é mantido. maxLength: 500

utm_source (opcional, string)Em minúsculas. O primeiro valor é mantido. maxLength: 80
utm_medium (opcional, string)Em minúsculas. O primeiro valor é mantido. maxLength: 80
utm_campaign (opcional, string)Em minúsculas. O primeiro valor é mantido. maxLength: 80
click_kind (opcional, string)O ID de clique de publicidade que a página de destino trazia; o ID em si nunca é enviado. Permitido: "gclid", "gbraid", "wbraid", "fbclid", "msclkid", "li_fat_id", "ttclid", "rdt_cid", "twclid"
question (opcional, string)

Obrigatório com question_shown, question_answered, question_follow_up e question_skipped; recusado com qualquer outra etapa. agent_other, heard_text e heard_kind nomeiam perguntas de acompanhamento e são usados somente com question_follow_up.

Permitido: "who_for", "use_case", "screen_range", "go_live", "devices", "role", "firm_kind", "agent", "heard", "agent_other", "heard_text", "heard_kind"

detail (opcional, string)Um código de problema para uma etapa *_failed, o método para signed_in (passkey, password, sso, autofill), connected ou skipped para signup_finished. Mantido como enviado. maxLength: 200
value (opcional, OnboardingValue)

O que a pessoa informou em uma etapa: o endereço digitado (email_submitted, reset_requested), o nome (signup_name_entered), sim ou não (signup_marketing_choice), as opções escolhidas ou o texto de acompanhamento (question_answered, question_follow_up), um endereço ou nome informado em um convite. Nunca uma senha, código ou token. Vazio equivale a ausente.

site_trail (opcional, array)As páginas que o navegador visualizou no site nesta aba, as mais antigas primeiro. O primeiro valor é mantido.
site_cta (opcional, OnboardingSiteCTA)O link de cadastro ou de login em que a pessoa clicou no site.
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/onboarding/steps'

Respostas

StatusSignificadoCorpo e cabeçalhos
204A etapa foi registrada.sem corpo; 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)
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)
GET/api/agents

Listar agentes no dashboard

Lista todos os agentes pendentes, ativos, revogados, cancelados e expirados do projeto da sessão com metadados de instalação segura, último uso, contagem de solicitações autenticadas e créditos medidos diretamente atribuíveis. Nenhum byte de portador, chave do destinatário, envelope ou identificador do projeto é retornado.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
listDashboardAgents
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/agents'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Agentes do projeto.AgentList (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)
GET/api/agents/{id}/events

Listar eventos de agentes no dashboard

Histórico deste agente, do mais recente para o mais antigo, como UM registro por gatilho. Ele contém tanto o que o agente solicitou quanto o que mudou como resultado. Uma solicitação que mudou algo é seu evento de domínio, marcado com o comando que o causou. Uma solicitação que não mudou nada — recusada, falhou ou um sucesso sem evento — é um evento agent.command.

Não há endpoint separado para comandos; mostrar o mesmo gatilho em dois painéis era o defeito que isso substituiu. Eventos de ciclo de vida para este agente estão incluídos. Atividade apenas de worker, player e dashboard nunca é inferida como atividade do agente. Duas solicitações são dois gatilhos. Uma nova tentativa após recusa é um segundo registro, nunca uma reescrita do primeiro.

Leituras não são registradas, porque não mudam nada e um agente de polling enterraria toda ação real. Inscrição anônima é excluída. Cada parte do carimbo do comando é derivada da rota que este servidor correspondeu ou do registro de problemas.

Não há vetor de argumento, corpo de solicitação, cabeçalho ou texto livre em qualquer registro, então nada precisa ser ocultado e nenhum chamador pode escrever texto escolhido em uma superfície visível ao operador. Identificadores de recurso aparecem porque um identificador nunca é autorização e já é publicado em eventos. Chaves de paginação em sequência, descendente.

Passe o next_cursor retornado como after para continuar. next_cursor está vazio quando a página é curta, que é o fim do histórico: um append concorrente só assume uma sequência maior, e a retenção remove as sequências mais baixas primeiro, então um cursor nunca duplica ou pula um registro sobrevivente. Paginação por offset não é suportada.

Cada parâmetro de busca é um predicado de correspondência exata ou intervalo em um token escrito pelo servidor. Um cursor ou valor de filtro malformado é recusado com invalid_request. Um limite fora de 1-200 é ajustado para o padrão em vez de recusado. Registros expiram na janela de retenção de eventos do projeto.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
listDashboardAgentEvents

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório
depoisconsultaopcionalCursor da next_cursor da página anterior.
limiteconsultaopcional
comandoconsultaopcionalNome exato do comando derivado da rota, como screens.archive.
tipoconsultaopcionalTipo de evento exato, como agent.command ou screen.archived.
resource_typeconsultaopcionalTipo exato do objeto que a requisição agiu.
resource_idconsultaopcionalIdentificador exato do objeto que a requisição agiu.
resultadoconsultaopcionalPresente apenas em registros agent.command; um evento de domínio implica ok.
problem_codeconsultaopcionalCódigo de problema estável exato com o qual o servidor recusou.
desdeconsultaopcional
atéconsultaopcional
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/agents/RESOURCE_ID/events'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Histórico do agente.EventList (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)
POST/api/agents/{id}/disconnect

Desconectar agente do dashboard

Desconecta o agente do projeto selecionado após prova recente. O projeto deve ser uma das associações da pessoa. Conexões pendentes e emissões de credenciais são canceladas; nenhum token substituto é emitido. Um membro limitado a telas não conecta agentes, não emite credenciais nem gerencia as pessoas do projeto: outside_screen_scope (peça ao proprietário do projeto).

Autenticação
dashboardSession
Corpo da solicitação
DashboardAgentAction
ID da operação
disconnectDashboardAgent

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório

Campos do corpo da solicitação

CampoDescrição
project_id (obrigatório, string)minLength: 1
proof (opcional, DashboardProof)
capacidades (opcional, array)

Opcional apenas na conexão do agente e aprovação do app conectado. Omitido aprova o conjunto completo solicitado; um subconjunto não vazio das capacidades da conexão restringe a credencial concedida; qualquer outra coisa é invalid_request.

user_code (opcional, string)

Obrigatório ao aprovar um login de dispositivo (fluxo device): o código que a pessoa confirma corresponde ao terminal. Uma incompatibilidade é agent_connection_code_mismatch; o quinto expira o login (agent_connection_expired). Ignorado caso contrário. maxLength: 32

acesso (opcional, string)

O nível de acesso com que um login de dispositivo ou app conectado é aprovado (Somente leitura, Propor ou Gerenciar); omitido mantém o nível solicitado. Ignorado para outras conexões. Uma pessoa que não pode aprovar revisões não pode aprovar Gerenciar (403 approver_required). Permitido: "read", "propose", "manage"

Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/agents/RESOURCE_ID/disconnect'

Respostas

StatusSignificadoCorpo e cabeçalhos
204Agente desconectado.sem corpo
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)
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)
GET/api/agents/{id}/notes

Listar notas de agentes no dashboard

As notas que este agente escreveu no projeto da sessão, mais recentes primeiro, abertas e resolvidas. state é all (padrão), open ou resolved. Passe next_cursor como after; está vazio na última página. Os corpos das notas são texto simples escrito por um agente; renderize como texto, nunca como HTML ou Markdown.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
listDashboardAgentNotes

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório
estadoconsultaopcional
depoisconsultaopcionalnext_cursor da página anterior.
limiteconsultaopcional
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/agents/RESOURCE_ID/notes'

Respostas

StatusSignificadoCorpo e cabeçalhos
200As notas do agente.NotePage (application/json); cabeçalhos: Cache-Control
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)
POST/api/agents/{id}/notes/{note_id}/resolve

Resolver nota do agente do dashboard

Resolve uma das notas abertas do agente como a pessoa conectada, com um motivo obrigatório; resolution.by nomeia a pessoa. Acrescenta note.resolved com a pessoa como ator. Uma nota resolvida é note_not_open.

Autenticação
dashboardSession
Corpo da solicitação
NoteResolve
ID da operação
resolveDashboardAgentNote

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório
note_idcaminhoobrigatórioO id de uma das notas do agente.
Idempotency-KeycabeçalhoopcionalOmitir 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

CampoDescrição
motivo (obrigatório, string)minLength: 1 maxLength: 500
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/agents/RESOURCE_ID/notes/NOTE_ID/resolve'

Respostas

StatusSignificadoCorpo e cabeçalhos
200A nota resolvida.Nota (application/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)
EXCLUIR/api/agents/{id}/notes/{note_id}

Excluir nota do agente do dashboard

Exclui uma das notas do agente, aberta ou resolvida, como a pessoa conectada. Acrescenta note.deleted com a pessoa como ator.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
deleteDashboardAgentNote

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório
note_idcaminhoobrigatórioO id de uma das notas do agente.
Idempotency-KeycabeçalhoopcionalOmitir 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
shell · modelo de requisição
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/agents/RESOURCE_ID/notes/NOTE_ID'

Respostas

StatusSignificadoCorpo e cabeçalhos
204Excluído.sem corpo
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)
GET/api/agent-connections/pending

Listar conexões de agentes no dashboard

As solicitações de conexão pendentes endereçadas ao projeto da sessão, que um membro pode revisar e aprovar: solicitações nomeando o projeto, e logins ou conexões de dispositivo por uma identidade de agente já membro dele.

O login de uma nova instalação não está listado (sua dica de projeto é fornecida pelo cliente); uma pessoa o acessa pelo código do usuário (POST /api/agent-connections/lookup).

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
listDashboardAgentConnections
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/agent-connections/pending'

Respostas

StatusSignificadoCorpo e cabeçalhos
200As solicitações pendentes, mais recentes primeiro, no máximo 100.objeto (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)
POST/api/agent-connections/lookup

Pesquisar conexão do agente no Dashboard

Resolve o código do usuário de um login pendente do dispositivo (`screenrig login`), conforme digitado ou preenchido na página de conexão, para sua conexão, cuja visualização de aprovação então o mostra. Não aprova nada. Separadores, espaços e maiúsculas são ignorados. Um código desconhecido, usado ou inválido é agent_connection_invalid; um expirado é agent_connection_expired.

Limitado a 5 consultas por sessão de dashboard a cada 10 minutos, 20 por endereço de cliente por hora e 1200 por hora em toda a frota (rate_limited). Um membro limitado a telas não conecta agentes, não emite credenciais nem gerencia as pessoas do projeto: outside_screen_scope (peça ao proprietário do projeto).

Autenticação
dashboardSession
Corpo da solicitação
object
ID da operação
lookupDashboardAgentConnection

Campos do corpo da solicitação

CampoDescrição
user_code (obrigatório, string)maxLength: 32
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/agent-connections/lookup'

Respostas

StatusSignificadoCorpo e cabeçalhos
200A conexão que o código nomeia.objeto (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)
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)
GET/api/agent-connections/{id}

Obter conexão do agente do dashboard

Retorna metadados de revisão de conexão segura. A revisão não seleciona um projeto; a aprovação seleciona uma das associações da pessoa.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
getDashboardAgentConnection

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/agent-connections/RESOURCE_ID'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Metadados de conexão segura.AgentConnection (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)
POST/api/agent-connections/{id}/approve

Aprovar conexão do agente no dashboard

Aprova a conexão para o projeto selecionado após prova recente e cria um agente pendente. O projeto deve ser uma das associações da pessoa. Retorna metadados seguros, nunca o bearer. Um membro limitado a telas não conecta agentes, não emite credenciais nem gerencia as pessoas do projeto: outside_screen_scope (peça ao proprietário do projeto).

Autenticação
dashboardSession
Corpo da solicitação
DashboardAgentAction
ID da operação
approveDashboardAgentConnection

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório

Campos do corpo da solicitação

CampoDescrição
project_id (obrigatório, string)minLength: 1
proof (opcional, DashboardProof)
capacidades (opcional, array)

Opcional apenas na conexão do agente e aprovação do app conectado. Omitido aprova o conjunto completo solicitado; um subconjunto não vazio das capacidades da conexão restringe a credencial concedida; qualquer outra coisa é invalid_request.

user_code (opcional, string)

Obrigatório ao aprovar um login de dispositivo (fluxo device): o código que a pessoa confirma corresponde ao terminal. Uma incompatibilidade é agent_connection_code_mismatch; o quinto expira o login (agent_connection_expired). Ignorado caso contrário. maxLength: 32

acesso (opcional, string)

O nível de acesso com que um login de dispositivo ou app conectado é aprovado (Somente leitura, Propor ou Gerenciar); omitido mantém o nível solicitado. Ignorado para outras conexões. Uma pessoa que não pode aprovar revisões não pode aprovar Gerenciar (403 approver_required). Permitido: "read", "propose", "manage"

Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/agent-connections/RESOURCE_ID/approve'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Metadados seguros do agente pendentes.Agent (application/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)
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)
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)
POST/api/agent-connections/{id}/deny

Negar conexão do agente do Dashboard

Nega a conexão para o projeto selecionado após prova recente, sem criar um agente. O projeto deve ser uma das associações da pessoa. Um membro limitado a telas não conecta agentes, não emite credenciais nem gerencia as pessoas do projeto: outside_screen_scope (peça ao proprietário do projeto).

Autenticação
dashboardSession
Corpo da solicitação
DashboardAgentAction
ID da operação
denyDashboardAgentConnection

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório

Campos do corpo da solicitação

CampoDescrição
project_id (obrigatório, string)minLength: 1
proof (opcional, DashboardProof)
capacidades (opcional, array)

Opcional apenas na conexão do agente e aprovação do app conectado. Omitido aprova o conjunto completo solicitado; um subconjunto não vazio das capacidades da conexão restringe a credencial concedida; qualquer outra coisa é invalid_request.

user_code (opcional, string)

Obrigatório ao aprovar um login de dispositivo (fluxo device): o código que a pessoa confirma corresponde ao terminal. Uma incompatibilidade é agent_connection_code_mismatch; o quinto expira o login (agent_connection_expired). Ignorado caso contrário. maxLength: 32

acesso (opcional, string)

O nível de acesso com que um login de dispositivo ou app conectado é aprovado (Somente leitura, Propor ou Gerenciar); omitido mantém o nível solicitado. Ignorado para outras conexões. Uma pessoa que não pode aprovar revisões não pode aprovar Gerenciar (403 approver_required). Permitido: "read", "propose", "manage"

Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/agent-connections/RESOURCE_ID/deny'

Respostas

StatusSignificadoCorpo e cabeçalhos
204Conexão negada.sem corpo
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)
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)
GET/api/dashboard/boot

Obter boot do dashboard

Uma única requisição para o shell do dashboard.

Cada membro é o corpo que a rota indicada responde para esta mesma sessão (GET /api/me/email, /api/support/status, /api/projects, /api/organizations, /api/project, /api/project/capabilities, /api/advertising/network, /api/alerts?state=open&limit=1 e /api/reviews?state=all&limit=1), produzido pelo handler próprio dessa rota, sob as suas próprias verificações de autorização, plano e escopo.

Um membro fica ausente quando sua rota não responderia 2xx para esta sessão (uma recusa, um papel ou plano que não pode lê-la, nenhum projeto atual, uma falha), e o dashboard então lê essa rota por conta própria. advertising_network é null quando sua rota responderia 404 not_found porque o projeto não tem rede.

Uma sessão sem projeto atual recebe os membros que não precisam de nenhum.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
getDashboardBoot
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/dashboard/boot'

Respostas

StatusSignificadoCorpo e cabeçalhos
200As leituras do shell do dashboard.DashboardBoot (application/json); 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)
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)
GET/api/summary

Obter resumo do dashboard

Contadores de status de rede do projeto para o projeto da sessão. Contagens de telas online são derivadas de fluxos de eventos em tempo real pareados, a mesma derivação que Screen.online publica; não são booleanos armazenados nem heartbeat do player. Bytes de mídia são bytes duráveis apenas da mídia pronta.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
getDashboardSummary
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/summary'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Contadores resumidos do projeto.DashboardSummary (application/json); 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)
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)
GET/api/billing/payout-status

Obter status de pagamento do dashboard

Estado verdadeiro da capacidade de pagamento. rails_available é falso e unavailable_reason é financial_rails_unavailable enquanto cartão, imposto e via de saque estão indisponíveis. Nenhuma credencial bancária bruta é retornada.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
getDashboardPayoutStatus
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/billing/payout-status'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Status do pagamento.Status de pagamento de cobrança (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)
GET/api/billing/receipts/{id}

Obter recibo do dashboard

Um recibo/documento fiscal finalizado pertencente ao solicitante. Nenhum recibo existe enquanto a coleta de dinheiro não é enviada, então isto é not_found em vez de um documento fabricado.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
getDashboardReceipt

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/billing/receipts/RESOURCE_ID'

Respostas

StatusSignificadoCorpo e cabeçalhos
404not_found - nenhum recibo existe.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)
GET/api/balance

Obter saldo do dashboard

Retorna o saldo público de créditos totais do projeto da sessão. Esta leitura autenticada por cookie nunca debita, então permanece disponível em zero. O dashboard somente com cookie nunca apresenta um portador de projeto para GET /api/project.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
getDashboardBalance
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/balance'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Saldo total de créditos públicos.DashboardBalance (application/json); 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)
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)
POST/api/applications/{id}/preview-launches

Criar pré-visualização de aplicativo do dashboard

Cria um único ticket de lançamento de uso único de trinta segundos para a última versão pronta de um aplicativo que o projeto da sessão possui, no host de pré-visualização exato dessa versão, nunca no host de lançamento que os Players usam, para que um Player e o dashboard em um navegador nunca compartilhem os documentos em cache desse host ou concedam cookie.

O ticket se converte no cookie release-grant apenas nesse host, então a pré-visualização é cross-origin por construção e o código da aplicação web nunca pode ler um cookie do dashboard. A resposta release_id identifica a versão exata escolhida para este lançamento, mesmo que outra publicação termine depois. Atribua launch_url a iframe.src e a mais nada.

A autoridade aqui é a autoridade do proprietário: o projeto da sessão é dono da aplicação. Essa é uma fonte deliberada de segunda autoridade ao lado da autoridade exata do manifesto atual para screenrig.webapp-package/v1, e está limitada a esta operação. Não generalize para mídia ou conteúdo protegido do runtime.

Não há player pai, então o SDK do navegador e a ponte chave-valor falham fechados e a pré-visualização é apenas apresentação. Uma aplicação sem versão pronta é resource_conflict.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
createDashboardApplicationPreviewLaunch

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/applications/RESOURCE_ID/preview-launches'

Respostas

StatusSignificadoCorpo e cabeçalhos
201Pré-visualização de lançamento de host de liberação exata de 30 segundos para uso único.DashboardApplicationPreviewLaunch (application/json); cabeçalhos: Cache-Control, Referrer-Policy, RateLimit-Policy, RateLimit
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)
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)
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)
GET/api/organizations/{org_id}

Obter organização do dashboard

Uma organização como um item de GET /api/organizations a mostra ao chamador, com admin, home e reseller. Uma pessoa conectada a lê quando a administra, administra o revendedor ao qual ela está delegada, é da equipe, ou a veria nessa listagem (membro de um de seus projetos ativos, ou é sua organização principal).

Qualquer outra pessoa, ou uma organização que não existe, recebe 404 not_found. Não concede associação a nenhum projeto. Somente sessões por cookie; uma credencial de agente é recusada.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
getDashboardOrganization

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/organizations/ORG_ID'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Resultado da organização.OrganizationView (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)
GET/api/organizations/{org_id}/projects

Dashboard Organizações Projetos

Administradores da organização leem apenas nomes de projetos, proprietários, status e contagem de telas; isso não concede acesso ao projeto. Um administrador lê o conteúdo de um projeto somente depois de entrar nele (POST .../projects/{project_id}/access) e gerencia as pessoas dele com as rotas de proprietário e de membros abaixo.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
dashboardOrganizationsProjects

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
cursorconsultaopcional
limiteconsultaopcional
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/projects'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Resultado da organização.OrganizationProjectPage (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)
GET/api/resellers

Listar revendedores no dashboard

Os revendedores ativos cuja organização a pessoa conectada administra (admin_user_ids), ordenados por nome; vazio para todas as outras pessoas. Somente sessões por cookie. Um revendedor é uma organização que a equipe tornou revendedora ou que um de seus admins registrou (POST /api/resellers); seus admins gerenciam as organizações dos clientes dele (docs/resellers.md).

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
listDashboardResellers
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/resellers'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Os revendedores do chamador.ResellerList (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)
POST/api/resellers

Registrar revendedor

Um admin de uma organização a torna revendedora imediatamente. O chamador deve ser uma pessoa conectada com endereço de e-mail verificado (somente sessões por cookie; agentes e clientes de serviço nunca têm autoridade de revendedor) e admin da organização indicada por organization_id; qualquer outra pessoa recebe 404 not_found.

O revendedor começa com 2000 pontos-base do preço de tabela (20%), em vigor desde agora, e fica aguardando análise; ele cadastra até 10 clientes atuais (customer_limit) até que o screenRIG o analise. A organização deve estar ativa, não ser já um revendedor, não ser cliente de um revendedor e não estar no plano staff ou promo (409 reseller_conflict, o detalhe informa o motivo).

Acrescenta reseller.enrolled à auditoria da organização.

Autenticação
dashboardSession
Corpo da solicitação
ResellerEnrollment
ID da operação
enrollReseller

Campos do corpo da solicitação

CampoDescrição
organization_id (obrigatório, string)A organização que será tornada revendedora; o chamador deve ser um dos admins dela. minLength: 1 maxLength: 200
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/resellers'

Respostas

StatusSignificadoCorpo e cabeçalhos
201O novo revendedor, como GET /api/resellers/{reseller_id} o lê.Reseller (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)
GET/api/resellers/{reseller_id}

Obter revendedor do dashboard

Um revendedor que o chamador administra, com a sua margem. Qualquer outra pessoa recebe 404 not_found.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
getDashboardReseller

Parâmetros

NomeEnviarObrigatório?Descrição
reseller_idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/resellers/RESELLER_ID'

Respostas

StatusSignificadoCorpo e cabeçalhos
200O revendedor.Reseller (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)
GET/api/resellers/{reseller_id}/customers

Listar clientes de revendedor no dashboard

Os clientes atuais do revendedor (organizações delegadas a ele), ordenados por nome, com plano, contagens e bytes armazenados. Somente admins do revendedor; qualquer outra pessoa recebe 404 not_found.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
listDashboardResellerCustomers

Parâmetros

NomeEnviarObrigatório?Descrição
reseller_idcaminhoobrigatório
cursorconsultaopcional
limiteconsultaopcional
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/resellers/RESELLER_ID/customers'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Uma página de clientes.ResellerCustomerPage (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)
POST/api/resellers/{reseller_id}/customers

Criar cliente de revendedor do dashboard

Cria uma organização cliente delegada ao revendedor desde a sua criação, no plano Standard, tendo como único admin o admin do revendedor que faz a chamada. A organização principal do chamador não muda. Os próprios admins da organização podem encerrar a delegação depois (DELETE /api/organizations/{org_id}/reseller).

Acrescenta organization.created e reseller.customer_started à auditoria da organização. Um revendedor aguardando análise (review_state pending) cadastra até customer_limit clientes atuais; acima disso, a resposta é 409 reseller_conflict.

Autenticação
dashboardSession
Corpo da solicitação
object
ID da operação
createDashboardResellerCustomer

Parâmetros

NomeEnviarObrigatório?Descrição
reseller_idcaminhoobrigatório

Campos do corpo da solicitação

CampoDescrição
nome (obrigatório, ProjectName)Nome de projeto imprimível aparado. Rejeita controles, texto com aparência de URL, @, www. e ://. minLength: 1 maxLength: 60
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/resellers/RESELLER_ID/customers'

Respostas

StatusSignificadoCorpo e cabeçalhos
201O novo cliente.ResellerCustomer (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)
GET/api/resellers/{reseller_id}/customers/{org_id}

Obter cliente de revendedor do dashboard

Um cliente atual do revendedor. Somente admins do revendedor; uma organização que não é cliente atual responde 404 not_found.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
getDashboardResellerCustomer

Parâmetros

NomeEnviarObrigatório?Descrição
reseller_idcaminhoobrigatório
org_idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/resellers/RESELLER_ID/customers/ORG_ID'

Respostas

StatusSignificadoCorpo e cabeçalhos
200O cliente.ResellerCustomer (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)
PUT/api/resellers/{reseller_id}/customers/{org_id}/plan

Definir plano de cliente de revendedor do dashboard

Define o plano de um cliente atual, pelo qual o revendedor paga. standard remove o plano; plus e premium são sempre permitidos, education somente para uma organização elegível para educação. Enterprise, staff e promo são atribuídos pela equipe.

Um upgrade vale de imediato; um downgrade ou uma remoção, no próximo limite mensal UTC, como nas mudanças de plano de uma organização (docs/billing-rollup.md). Acrescenta reseller.customer_plan à auditoria da organização.

Autenticação
dashboardSession
Corpo da solicitação
object
ID da operação
setDashboardResellerCustomerPlan

Parâmetros

NomeEnviarObrigatório?Descrição
reseller_idcaminhoobrigatório
org_idcaminhoobrigatório

Campos do corpo da solicitação

CampoDescrição
plan_id (obrigatório, string)Permitido: "standard", "plus", "education", "premium"
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/resellers/RESELLER_ID/customers/ORG_ID/plan'

Respostas

StatusSignificadoCorpo e cabeçalhos
200O cliente com o plano como está armazenado agora.ResellerCustomer (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)
GET/api/resellers/{reseller_id}/customers/{org_id}/projects

Listar projetos de clientes de revendedor no dashboard

Os projetos ativos de um cliente atual, com nomes, status, contagem de telas e se o chamador já é membro. Listar não concede acesso a projetos; POST .../access entra em um deles.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
listDashboardResellerCustomerProjects

Parâmetros

NomeEnviarObrigatório?Descrição
reseller_idcaminhoobrigatório
org_idcaminhoobrigatório
cursorconsultaopcional
limiteconsultaopcional
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/resellers/RESELLER_ID/customers/ORG_ID/projects'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Uma página de projetos.ResellerCustomerProjectPage (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)
POST/api/resellers/{reseller_id}/customers/{org_id}/projects/{project_id}/access

Entrar em projeto de cliente de revendedor do dashboard

Torna o admin do revendedor que faz a chamada um membro pleno do projeto de um cliente atual (can_approve, sem escopos, origem reseller_admin), como faz a entrada de um admin da organização, para que possa abri-lo com PUT /api/session/project. Quem já é membro recebe o projeto inalterado.

Acrescenta member.added_by_reseller ao projeto e reseller.project_joined à auditoria da organização, e envia um e-mail ao proprietário do projeto. A associação permanece até ser removida; encerrar a delegação não a remove.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
joinDashboardResellerCustomerProject

Parâmetros

NomeEnviarObrigatório?Descrição
reseller_idcaminhoobrigatório
org_idcaminhoobrigatório
project_idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/resellers/RESELLER_ID/customers/ORG_ID/projects/PROJECT_ID/access'

Respostas

StatusSignificadoCorpo e cabeçalhos
200O projeto que o chamador agora pode abrir.DashboardProjectReference (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)
GET/api/resellers/{reseller_id}/statement

Obter extrato de revendedor do dashboard

O que o revendedor deve por um mês UTC. Uma linha por cliente delegado em qualquer momento do mês, com a parte das cobranças de uso, na parte delegada do mês, que o crédito do próprio cliente não cobriu (ao preço de tabela e ao preço do revendedor), e o preço anual do plano dele.

O preço do revendedor é o de tabela menos a margem em vigor na data mais recente entre o início do mês e a (re)criação do revendedor. Somente admins do revendedor.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
getDashboardResellerStatement

Parâmetros

NomeEnviarObrigatório?Descrição
reseller_idcaminhoobrigatório
períodoconsultaopcionalO mês UTC, YYYY-MM. Se omitido, é o mês atual.
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/resellers/RESELLER_ID/statement'

Respostas

StatusSignificadoCorpo e cabeçalhos
200O extrato.ResellerStatement (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)
EXCLUIR/api/organizations/{org_id}/reseller

Encerrar revendedor da organização do dashboard

Um admin da organização encerra de imediato a delegação ao seu revendedor. A partir daí a organização paga por si mesma; seu plano, seus projetos e seus membros permanecem como estão, inclusive as associações que os admins do revendedor têm. O excedente que a carteira dela acumulou durante a delegação, pelo qual o revendedor é cobrado, é baixado na mesma alteração.

Acrescenta reseller.customer_ended à auditoria da organização. Uma organização sem revendedor responde 404 not_found.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
endDashboardOrganizationReseller

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/reseller'

Respostas

StatusSignificadoCorpo e cabeçalhos
200A organização, agora sem revendedor.OrganizationView (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)
GET/api/organizations/{org_id}/discovery

Dashboard Organizações Descoberta

Projetos em outros locais cujos proprietários têm um e-mail verificado no domínio verificado exato. Endereços de contato e subdomínios não correspondem, e administradores não podem puxar projetos.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
dashboardOrganizationsDiscovery

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
cursorconsultaopcional
limiteconsultaopcional
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/discovery'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Resultado da organização.OrganizationProjectPage (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)
POST/api/organizations/{org_id}/domain-challenges

Dashboard Organizações Iniciar Domínio

Abra um desafio DNS TXT de 7 dias para um domínio, substituindo o desafio pendente desse domínio; os outros domínios da organização permanecem inalterados. Coloque seu valor exato no nome DNS retornado e mantenha-o lá. Uma organização mantém no máximo 20 domínios, verificados e pendentes juntos (resource_conflict). Um domínio mantido por outra organização é resource_conflict.

Um domínio que esta organização já possui pode ser comprovado novamente, o que registra o novo valor para a verificação diária de DNS.

Autenticação
dashboardSession
Corpo da solicitação
OrganizationDomainInput
ID da operação
dashboardOrganizationsStartDomain

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório

Campos do corpo da solicitação

CampoDescrição
domínio (obrigatório, string)Domínio DNS exato; sem curinga, URL ou endereço IP. minLength: 3 maxLength: 253
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/domain-challenges'

Respostas

StatusSignificadoCorpo e cabeçalhos
201Resultado da organização.OrganizationDomainChallenge (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)
POST/api/organizations/{org_id}/domain-verification

Dashboard Organizações Verificar Domínio

Verifique um desafio não expirado contra DNS e adicione seu domínio à organização, além dos domínios que ela já possui. Cada domínio exato pertence a uma organização. Uma prova rotacionada durante a verificação é recusada. Mantenha o registro TXT no lugar; uma verificação diária remove um domínio cujo registro permanece ausente por sete dias.

Uma vez que a reivindicação é confirmada, e em segundo plano após esta resposta, cada projeto cujo proprietário é uma pessoa verificada exatamente no domínio e que está sozinho na organização pessoal desse proprietário é movido para esta organização (renomeado para "<name> (<owner>)" em caso de conflito de nome).

Projetos em qualquer outra organização, projetos com plano pago pelo cliente próprio, e projetos que seu proprietário ou equipe transferiu para fora de uma organização de domínio permanecem onde estão; um projeto que os limites da organização recusam é tentado novamente um dia depois. O posicionamento não concede acesso.

Autenticação
dashboardSession
Corpo da solicitação
OrganizationDomainProof
ID da operação
dashboardOrganizationsVerifyDomain

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório

Campos do corpo da solicitação

CampoDescrição
challenge_id (obrigatório, string)
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/domain-verification'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Resultado da organização.VerifiedOrganizationDomain (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)
GET/api/organizations/{org_id}/admins

Dashboard Organizações Administradores

Um administrador designado lê os administradores da organização, os candidatos que podem se tornar um (proprietários verificados e ativos de seus projetos ao vivo que ainda não são administradores) e a revisão da organização. Qualquer outro é recusado como nas outras rotas de administrador da organização. Apenas pessoas; agentes e credenciais portadoras não têm rota de administrador.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
dashboardOrganizationsAdmins

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/admins'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Administradores da organização.OrganizationAdmins (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)
PUT/api/organizations/{org_id}/admins

Dashboard Organizações Definir Administradores

Um administrador designado substitui os administradores da organização. If-Match carrega a revisão da organização; uma desatualizada é revision_conflict com current_revision. O conjunto nomeia de 1 a 20 pessoas, cada uma um administrador atual ou um candidato, caso contrário invalid_request; um administrador remove a si mesmo somente enquanto outro administrador permanecer.

A alteração incrementa a revisão, é registrada na auditoria da organização, não concede associação ao projeto e retorna a mesma forma que GET. Apenas pessoas; agentes e credenciais bearer não têm rota admin.

Autenticação
dashboardSession
Corpo da solicitação
OrganizationAdminsUpdate
ID da operação
dashboardOrganizationsSetAdmins

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
If-MatchcabeçalhoobrigatórioA revisão da organização obtida por GET, opcionalmente entre aspas.

Campos do corpo da solicitação

CampoDescrição
admin_user_ids (obrigatório, array)
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'If-Match: "REVISION"' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/admins'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Administradores da organização após a alteração.OrganizationAdmins (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)
GET/api/organizations/{org_id}/people

Dashboard Organizações Pessoas

Um administrador designado lê as pessoas da organização. Somente leitura. projects lista os projetos ativos da organização, ordenados por nome, no máximo 500. people é a união dos membros da organização (member true), das associações ativas nesses projetos (associações suspensas ficam de fora) e dos administradores designados.

A ordem é administradores primeiro, depois membros da organização, depois pessoas externas (as que não são membros da organização), cada grupo por nome de exibição e depois por e-mail.

Cada pessoa traz sua função em cada projeto (owner ou member), se pode aprovar revisões nele (can_approve) e se está limitada a telas ou uploads (limited), se é administrador, se é membro da organização (member), se é gerenciada pela organização (managed) e, para uma pessoa externa, se a política de convidados atual não a admitiria (outside_guest_policy).

Um administrador ou membro da organização que não está em nenhum projeto aparece com a lista projects vazia. email fica vazio para uma pessoa cujo endereço não foi verificado. Pessoas e agentes desativados nunca aparecem. No máximo 500 pessoas são retornadas, administradores sempre entre elas; truncated é verdadeiro quando pessoas, projetos ou associações foram omitidos.

Qualquer outra pessoa é recusada como nas demais rotas de administração da organização. Somente pessoas; agentes e credenciais bearer não têm rota.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
dashboardOrganizationsPeople

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/people'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Pessoas da organização.OrganizationPeople (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)
GET/api/organizations/{org_id}/admin-invitations

Dashboard Organizações Listar Convites de Administrador

Um administrador designado lista os convites de administrador da organização por id, 50 de cada vez, após expirar os que passaram do tempo. Endereços dos destinatários são visíveis para os administradores da organização, que os forneceram. Tokens e URLs de credenciais nunca são listados. Apenas pessoas; agentes e credenciais portadoras não têm rota de administrador.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
dashboardOrganizationsListAdminInvitations

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
statusconsultaopcional
cursorconsultaopcional
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/admin-invitations'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Os convites de admin da organização.OrganizationAdminInvitationList (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)
POST/api/organizations/{org_id}/admin-invitations

Dashboard Organizações Criar Convites de Administrador

Um administrador designado convida pessoas por e-mail para se tornarem administradores. Aceitar adiciona a pessoa aos administradores da organização e cria seu login se não tiver; não concede associação ao projeto. No máximo 20 administradores contando convites pendentes (organization_admin_limit); um endereço cuja pessoa já administra a organização é invalid_request.

Convites por e-mail expiram após sete dias; um convite pendente para o mesmo endereço é reutilizado. Os nomes da organização e do convidador devem ser adequados para e-mail. Apenas pessoas; agentes e credenciais de portador não têm rota de administrador.

Autenticação
dashboardSession
Corpo da solicitação
OrganizationAdminInvitationCreate
ID da operação
dashboardOrganizationsCreateAdminInvitations

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
Idempotency-Keycabeçalhoobrigatório

Campos do corpo da solicitação

CampoDescrição
e-mails (obrigatório, array)
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/admin-invitations'

Respostas

StatusSignificadoCorpo e cabeçalhos
201Os convites de admin da organização, um por endereço distinto.OrganizationAdminInvitationCreated (application/json); cabeçalhos: Cache-Control, 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)
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
POST/api/organizations/{org_id}/admin-invitations/{invitation_id}/revoke

Dashboard Organizações Revogar Convite de Administrador

Um administrador designado revoga um convite de administrador pendente e libera sua vaga de administrador. Um convite já revogado retorna 204; um aceito retorna invitation_consumed; um id que a organização não possui é not_found. Apenas pessoas; agentes e credenciais portadoras não têm rota de administrador.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
dashboardOrganizationsRevokeAdminInvitation

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
invitation_idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/admin-invitations/INVITATION_ID/revoke'

Respostas

StatusSignificadoCorpo e cabeçalhos
204O convite foi revogado.sem corpo
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)
GET/api/organizations/{org_id}/member-invitations

Dashboard Organizações Listar Convites de Membro

Um administrador designado lista os convites de membro da organização por id, 50 de cada vez, após expirar os que passaram do tempo. Endereços dos destinatários são visíveis para os administradores da organização, que os forneceram. Tokens e URLs de credenciais nunca são listados. Somente pessoas; agentes e credenciais bearer não têm rota de administrador.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
dashboardOrganizationsListMemberInvitations

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
statusconsultaopcional
cursorconsultaopcional
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/member-invitations'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Os convites de membro da organização.OrganizationMemberInvitationList (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)
POST/api/organizations/{org_id}/member-invitations

Dashboard Organizações Criar Convites de Membro

Um administrador designado convida pessoas por e-mail para entrarem na organização como membros. Aceitar define a organização principal da pessoa como esta, substituindo qualquer organização principal anterior, e cria seu login se não tiver; não concede associação ao projeto.

Um endereço cuja pessoa já é membro da organização é invalid_request; um cuja pessoa é gerenciada por outra organização é managed_elsewhere. Convites por e-mail expiram após sete dias; um convite pendente para o mesmo endereço é reutilizado. Os nomes da organização e do convidador devem ser adequados para e-mail.

Aceitar um convite para a organização da equipe (plan_id staff) também torna a pessoa membro da equipe. Por isso, somente a equipe pode enviar esses convites, a um endereço por solicitação com uma comprovação staff_grant vinculada a ele (reauthentication_required sem ela). Apenas pessoas; agentes e credenciais bearer não têm rota de administração.

Autenticação
dashboardSession
Corpo da solicitação
OrganizationMemberInvitationCreate
ID da operação
dashboardOrganizationsCreateMemberInvitations

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
Idempotency-Keycabeçalhoobrigatório

Campos do corpo da solicitação

CampoDescrição
e-mails (obrigatório, array)
proof (opcional, DashboardProof)
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/member-invitations'

Respostas

StatusSignificadoCorpo e cabeçalhos
201Os convites de membro da organização, um por endereço distinto.OrganizationMemberInvitationCreated (application/json); cabeçalhos: Cache-Control, 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)
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
POST/api/organizations/{org_id}/member-invitations/{invitation_id}/revoke

Dashboard Organizações Revogar Convite de Membro

Um administrador designado revoga um convite de membro pendente. Um convite já revogado retorna 204; um aceito retorna invitation_consumed; um id que a organização não possui é not_found. Somente pessoas; agentes e credenciais bearer não têm rota de administrador.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
dashboardOrganizationsRevokeMemberInvitation

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
invitation_idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/member-invitations/INVITATION_ID/revoke'

Respostas

StatusSignificadoCorpo e cabeçalhos
204O convite foi revogado.sem corpo
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)
EXCLUIR/api/organizations/{org_id}/members/{user_id}

Dashboard Organizações Remover Membro

Um administrador designado remove um membro da organização.

Em uma transação, a organização principal da pessoa é limpa e suas associações em todos os projetos ativos da organização terminam, cada uma como a remoção dela desse projeto faria (os convites por e-mail pendentes para ele são revogados e as sessões dela deixam de resolvê-lo); as associações em projetos de outras organizações permanecem intactas, e nenhuma outra organização muda.

A alteração é registrada na auditoria da organização.

Uma pessoa que um provedor de identidade gerencia (login único ou SCIM) é managed_member; um administrador designado é organization_admin_member (remova primeiro a vaga de administrador com PUT /api/organizations/{org_id}/admins); uma pessoa que é proprietária de qualquer projeto ativo da organização é member_owns_projects e o detalhe lista os nomes dos projetos (transfira primeiro esses projetos, nada é removido); uma pessoa que não é membro da organização, inclusive uma já removida, é not_found.

Somente pessoas; agentes e credenciais bearer não têm rota de administrador.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
dashboardOrganizationsRemoveMember

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
user_idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/members/USER_ID'

Respostas

StatusSignificadoCorpo e cabeçalhos
204A pessoa não é mais membro da organização.sem corpo
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)
PUT/api/organizations/{org_id}/guest-policy

Dashboard Organizações Definir Política de Convidados

Um administrador designado define quem a organização admite em seus projetos como convidados, isto é, pessoas cuja organização principal é outra ou que não têm nenhuma. mode allow (o padrão) admite todos os convidados, domains admite um convidado cujo endereço de e-mail verificado está em um dos domains, e none não admite nenhum convidado. domains lista de 1 a 20 nomes DNS distintos em minúsculas, obrigatório para mode domains e omitido nos demais casos; qualquer outra forma é invalid_request.

A política substitui a anterior, incrementa a revisão da organização, é registrada na auditoria da organização e responde com a política em vigor. Ela é verificada quando a organização concede a um convidado uma associação a um projeto, por convite de membro do projeto (criar e aceitar) e por vínculo de grupo SCIM, e recusa com guest_not_allowed.

A equipe e os próprios administradores da organização estão isentos, agentes não são verificados, e membros da organização nunca são convidados. Restringir a política não remove ninguém; outside_policy conta as pessoas externas já presentes nos projetos ativos da organização que a nova política não admitiria, e GET /api/organizations/{org_id}/people sinaliza cada uma delas (outside_guest_policy).

Somente pessoas; agentes e credenciais bearer não têm rota de administrador.

Autenticação
dashboardSession
Corpo da solicitação
OrganizationGuestPolicyUpdate
ID da operação
dashboardOrganizationsSetGuestPolicy

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório

Campos do corpo da solicitação

CampoDescrição
mode (obrigatório, OrganizationGuestPolicyMode)

allow admite todos os convidados. domains admite um convidado cujo endereço de e-mail verificado está em um dos domínios listados (correspondência exata). none não admite nenhum convidado. Membros da organização nunca são convidados. Permitido: "allow", "domains", "none"

domains (opcional, array)Obrigatório para mode domains (1 a 20 domínios, duplicatas recusadas) e omitido para allow e none; em ambos os casos, uma forma incorreta é invalid_request.
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/guest-policy'

Respostas

StatusSignificadoCorpo e cabeçalhos
200A política de convidados agora em vigor.OrganizationGuestPolicyResult (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)
PUT/api/organizations/{org_id}/library

Dashboard Organizações Definir Biblioteca

Um administrador designado define ou remove o projeto Biblioteca da organização. project_id indica um dos projetos ativos da organização, ou null para remover.

Todos os outros projetos da organização passam então a ler as mídias, as pastas de mídia e as playlists da Biblioteca (library=true em GET /api/media, /api/media-folders e /api/playlists, e por ID) e as usam somente para leitura: referências de mídia nas páginas, seletores by:folder que citam uma pasta da Biblioteca (os seletores de tag e de todos nunca alcançam a Biblioteca), cronogramas e pilhas das telas, e from_template. Somente os membros da própria Biblioteca as alteram.

O projeto Biblioteca não tem telas: um projeto com telas resulta em library_no_screens, e a Biblioteca não admite nenhuma depois. Definir uma Biblioteca exige o recurso de plano library (Premium, Education, Enterprise; caso contrário, feature_not_in_plan); removê-la nunca exige, e uma Biblioteca mantida após um downgrade continua sendo servida.

Se a Biblioteca for removida ou substituída, as playlists dos projetos membros que citam seus itens deixam de resolvê-los na próxima gravação, e as telas deixam de receber as mídias dela. Um projeto que é a Biblioteca e é excluído ou movido para fora da organização a remove.

Responde com a visão da organização, é registrada na auditoria da organização (organization.library_changed) e incrementa a revisão. Somente pessoas.

Autenticação
dashboardSession
Corpo da solicitação
OrganizationLibraryUpdate
ID da operação
dashboardOrganizationsSetLibrary

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório

Campos do corpo da solicitação

CampoDescrição
project_id (obrigatório, inline)O projeto da organização que será a Biblioteca, ou null para remover a Biblioteca.
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/library'

Respostas

StatusSignificadoCorpo e cabeçalhos
200A organização com a Biblioteca agora em vigor.OrganizationView (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)
POST/api/organizations/{org_id}/project-access

Dashboard Organizações Definir Acesso ao Projeto

Um administrador designado define o acesso de muitas pessoas a muitos dos projetos ativos da organização em uma única requisição, sem entrar em nenhum deles.

Cada mudança, de 1 a 500, nomeia um projeto, uma pessoa e um acesso, sem repetir nenhum par (project_id, user_id). member torna a pessoa um membro do projeto que não pode aprovar revisões (adicionada quando não é membro; um aprovador perde a aprovação), approver um membro que pode aprovar (adicionado quando não é membro), e none nenhum membro (removida quando é membro).

Tudo é aplicado em ordem em uma única transação, e uma recusa desfaz o lote inteiro; cada recusa aponta changes[i] (o projeto ou a pessoa) ou changes[i].access em errors[].field.

Um projeto que não é um projeto ativo desta organização é not_found; uma pessoa que não é uma pessoa ativa (um agente, uma pessoa desativada, um id desconhecido) ou que é da equipe, uma associação suspensa, e uma pessoa adicionada que não é uma das pessoas da organização (seus administradores, seus membros da organização e os membros ativos de seus outros projetos ativos; qualquer outra pessoa entra por um convite) são invalid_request; o proprietário nunca é definido como member ou none (owner_cannot_leave); um uploader nunca aprova (resource_conflict, como PUT /api/members/{user_id}/approver responde); remover o próprio administrador é proibido (um administrador sai por DELETE /api/members/{user_id}); e uma pessoa adicionada é admitida como um convite a admite, ou seja, os membros da organização e os administradores da organização sempre, e uma pessoa externa somente onde a política de convidados a admite agora (guest_not_allowed).

O limite de 200 membros do projeto e o limite de membros do plano dele se aplicam ao que é adicionado (member_limit_reached). A resposta repete cada mudança na ordem da requisição; changed é false para uma cujo acesso já estava em vigor, que não grava nem registra nada.

Cada mudança é registrada na auditoria da organização (organization.project_member_added, organization.project_member_approver_changed ou organization.project_member_removed) e nos eventos do projeto (member.added_by_organization_admin, project.member_approver_changed ou member.removed, marcados como do administrador da organização), e o proprietário de cada projeto recebe um e-mail uma única vez por lote, a menos que tenha sido ele a fazer a mudança.

Somente pessoas; agentes e credenciais bearer não têm rota de administrador.

Autenticação
dashboardSession
Corpo da solicitação
OrganizationProjectAccessRequest
ID da operação
dashboardOrganizationsSetProjectAccess

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório

Campos do corpo da solicitação

CampoDescrição
changes (obrigatório, array)As mudanças, aplicadas em ordem; nenhum par (project_id, user_id) aparece duas vezes.
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/project-access'

Respostas

StatusSignificadoCorpo e cabeçalhos
200As mudanças como aplicadas, na ordem da requisição.OrganizationProjectAccessResult (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)
POST/api/organizations/{org_id}/projects/{project_id}/access

Dashboard Organizações Entrar em Projeto

Um administrador designado entra em um dos projetos ativos da organização como membro sem escopo de telas ou de upload que pode aprovar revisões. Entrar é o que dá ao administrador o conteúdo do projeto, que as rotas da organização nunca mostram.

Um administrador que já é membro sem escopo e que pode aprovar recebe 200 com joined false e nada muda; um membro com escopo de telas ou de upload, ou que não pode aprovar, torna-se um membro sem escopo que pode aprovar, registrado como uma entrada.

O limite de 200 membros do projeto se aplica (member_limit_reached); a política de convidados da organização nunca se aplica aos próprios administradores. A entrada é registrada na auditoria da organização como organization.project_joined e nos eventos do projeto como member.added_by_organization_admin, e o proprietário do projeto recebe um e-mail.

Um projeto que a organização não possui, ou que foi excluído, é not_found. Somente pessoas; agentes e credenciais bearer não têm rota de administrador.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
dashboardOrganizationsJoinProject

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
project_idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/projects/PROJECT_ID/access'

Respostas

StatusSignificadoCorpo e cabeçalhos
200O administrador é membro do projeto.OrganizationProjectAccess (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)
PUT/api/organizations/{org_id}/projects/{project_id}/owner

Dashboard Organizações Definir Proprietário do Projeto

Um administrador designado torna uma pessoa o proprietário de um dos projetos ativos da organização sem entrar nele, a partir de quem é o proprietário atual, inclusive um proprietário com a conta desativada.

O novo proprietário é uma pessoa verificada e ativa que é membro do projeto ou membro da organização (um membro da organização que não é membro do projeto é adicionado primeiro como membro sem escopo de telas ou de upload que pode aprovar revisões; a política de convidados não se aplica a um membro da organização); qualquer outra pessoa é invalid_request em user_id.

Um administrador se define como proprietário somente depois de entrar no projeto (POST /api/organizations/{org_id}/projects/{project_id}/access), e quem não é membro sem escopo de telas ou de upload que pode aprovar é invalid_request em user_id.

O efeito é o da transferência feita pelo próprio proprietário, então o escopo de telas e o escopo de upload do novo proprietário são limpos e as responsabilidades legadas do projeto passam a ser vinculadas a ele. Indicar o proprietário atual não altera nada. A alteração é registrada na auditoria da organização como organization.project_owner_changed, e o proprietário anterior e o novo recebem um e-mail.

O limite de 200 membros do projeto se aplica a um membro da organização adicionado (member_limit_reached). Um projeto que a organização não possui, ou que foi excluído, é not_found. Somente pessoas; agentes e credenciais bearer não têm rota de administrador.

Autenticação
dashboardSession
Corpo da solicitação
OrganizationProjectOwnerUpdate
ID da operação
dashboardOrganizationsSetProjectOwner

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
project_idcaminhoobrigatório

Campos do corpo da solicitação

CampoDescrição
user_id (obrigatório, string)O novo proprietário. Uma pessoa verificada e ativa que é membro do projeto ou membro da organização. minLength: 1 maxLength: 200
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/projects/PROJECT_ID/owner'

Respostas

StatusSignificadoCorpo e cabeçalhos
200O proprietário do projeto após a alteração.OrganizationProjectOwner (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)
EXCLUIR/api/organizations/{org_id}/projects/{project_id}/members/{user_id}

Dashboard Organizações Remover Membro do Projeto

Um administrador designado remove um membro de um dos projetos ativos da organização sem entrar nele. Tem o efeito da remoção feita pelo proprietário (DELETE /api/members/{user_id}). A associação termina, os convites por e-mail pendentes da pessoa para o projeto são revogados, as sessões dela deixam de resolver o projeto e as associações de agentes permanecem.

O proprietário nunca é removido (owner_cannot_leave; transfira primeiro a propriedade com PUT /api/organizations/{org_id}/projects/{project_id}/owner). Uma pessoa que não é membro do projeto, inclusive uma já removida, e um projeto que a organização não possui ou que foi excluído são not_found.

A remoção é registrada na auditoria da organização como organization.project_member_removed e nos eventos do projeto como member.removed com removed_by_organization_admin true. Somente pessoas; agentes e credenciais bearer não têm rota de administrador.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
dashboardOrganizationsRemoveProjectMember

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
project_idcaminhoobrigatório
user_idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/projects/PROJECT_ID/members/USER_ID'

Respostas

StatusSignificadoCorpo e cabeçalhos
204A associação terminou.sem corpo
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)
EXCLUIR/api/organizations/{org_id}/domains/{domain}

Dashboard Organizações Remover Um Domínio

Remover um domínio, verificado ou pendente, e deixar os outros domínios da organização. A colocação futura e a descoberta para ele param, e outra organização pode verificá-lo. Projetos já na organização permanecem. Um domínio que a organização não possui nem está provando é not_found.

Enquanto a organização exige login único, um domínio verificado é resource_conflict; desativar Exigir login único entra em vigor após 72 horas, e o domínio pode ser removido nessa ocasião.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
dashboardOrganizationsRemoveOneDomain

Parâmetros

NomeEnviarObrigatório?Descrição
org_idcaminhoobrigatório
domíniocaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/domains/DOMAIN'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Resultado da organização.OrganizationDomainRemoved (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)
PUT/api/members/{user_id}/approver

Definir aprovador de membro do dashboard

Define se um membro pode aprovar: decidir revisões e conceder aos agentes acesso Gerenciar. Um membro que não pode aprovar tem seus agentes mantidos em Propose. Somente o proprietário do projeto ou um membro que administra a organização do projeto (forbidden caso contrário); a própria linha do proprietário é fixa (resource_conflict); um não-membro é not_found.

Acrescenta project.member_approver_changed (detalhes user_id, can_approve).

Autenticação
dashboardSession
Corpo da solicitação
MemberApproverUpdate
ID da operação
setDashboardMemberApprover

Parâmetros

NomeEnviarObrigatório?Descrição
user_idcaminhoobrigatório

Campos do corpo da solicitação

CampoDescrição
can_approve (obrigatório, boolean)
project_id (opcional, string)O projeto que o chamador quer dizer; uma sessão cuja seleção mudou é recusada com resource_conflict. minLength: 1 maxLength: 200
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/members/USER_ID/approver'

Respostas

StatusSignificadoCorpo e cabeçalhos
200O membro.DashboardMember (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)
PUT/api/members/{user_id}/screen-scope

Definir escopo de telas de membro do dashboard

Limita um membro a pastas de telas (cada uma com todas as pastas dentro dela) e telas, ou substitui o escopo de um (docs/screen-scope.md).

Em uma transação, também encerra os agentes que a pessoa trouxe ao projeto (agent.disconnected, como removê-los faria) e acrescenta project.member_screen_scope_changed (detalhes user_id, screen_scope, previous, changed_by_user_id). O escopo é lido na próxima requisição do membro: a mudança aparece no próximo GET /api/session dele, sem entrar de novo.

Somente o proprietário do projeto ou um membro que administra a organização do projeto (forbidden caso contrário); a própria linha do proprietário, um uploader (um membro com escopo é limitado a telas, um uploader a conteúdo) e um membro que aprova revisões com telas avulsas no escopo são resource_conflict; um não membro é not_found; um id que não é uma pasta de telas nem uma tela existente do projeto é invalid_request em screen_scope.folder_ids[i] ou screen_scope.screen_ids[i].

Um membro com escopo que aprova revisões aprova apenas dentro do escopo; um que não pode aprovar lê e executa comandos, mas só altera o que é reproduzido por meio de aprovadores (approver_required).

Um escopo também é recusado com resource_conflict enquanto a pessoa, ou um agente que a pessoa trouxe, tem um cliente de serviço ativo do projeto: o detalhe nomeia até cinco clientes como ID (nome) e conta o restante, e nada é gravado.

Limitar uma pessoa a telas é o recurso de escopo de telas, que o plano Enterprise inclui; um projeto cujo plano não o inclui é recusado com feature_not_in_plan (402). Um escopo definido continua limitando a pessoa até ser limpo (DELETE), o que todo plano pode fazer.

Autenticação
dashboardSession
Corpo da solicitação
MemberScreenScopeUpdate
ID da operação
setDashboardMemberScreenScope

Parâmetros

NomeEnviarObrigatório?Descrição
user_idcaminhoobrigatório

Campos do corpo da solicitação

CampoDescrição
screen_scope (obrigatório, ScreenScope)

Sobre o que um membro ou agente com escopo pode agir (docs/screen-scope.md): as telas nas pastas de telas listadas e em todas as pastas dentro delas, e as telas listadas. Pelo menos um id no total. Um id que não nomeia nenhuma pasta ou tela existente do projeto quando gravado é invalid_request na sua posição; uma exclusão posterior deixa um id morto, que não concede nada.

O escopo é lido a cada requisição, então uma alteração vale já na próxima. Tags nunca são escopo.

project_id (opcional, string)Como em MemberApproverUpdate. minLength: 1 maxLength: 200
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/members/USER_ID/screen-scope'

Respostas

StatusSignificadoCorpo e cabeçalhos
200O membro, com screen_scope.DashboardMember (application/json)
402feature_not_in_plan — O escopo de telas faz parte do plano Enterprise; o problema nomeia o recurso, o plano em que a conta está e required_plan.Problema (application/problem+json)
403forbidden - somente o proprietário do projeto ou um membro que administra a organização do projeto define um escopo, e outside_screen_scope para um membro limitado a telas; peça ao proprietário do projeto.Problema (application/problem+json)
409

resource_conflict - a linha do proprietário, um uploader, um aprovador com telas avulsas no escopo, ou um cliente de serviço ativo da pessoa ou de um agente que ela trouxe; revogue cada cliente nomeado com screenrig service-client revoke ID e defina o escopo de novo.

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)
EXCLUIR/api/members/{user_id}/screen-scope

Limpar escopo de telas de membro do dashboard

Devolve a um membro com escopo as telas do projeto inteiro. Somente o proprietário do projeto ou um membro que administra a organização do projeto; um membro sem escopo fica como está. Acrescenta project.member_screen_scope_changed com screen_scope null.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
clearDashboardMemberScreenScope

Parâmetros

NomeEnviarObrigatório?Descrição
user_idcaminhoobrigatório
project_idconsultaopcionalO projeto que o chamador quer dizer; uma sessão cuja seleção mudou é recusada com resource_conflict.
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/members/USER_ID/screen-scope'

Respostas

StatusSignificadoCorpo e cabeçalhos
200O membro.DashboardMember (application/json)
403forbidden - somente o proprietário do projeto ou um membro que administra a organização do projeto define um escopo, e outside_screen_scope para um membro limitado a telas; peça ao proprietário do projeto.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)
PUT/api/agents/{id}/screen-scope

Definir escopo de telas de agente do dashboard

Limita a associação de um agente ao projeto da sessão a pastas de telas e telas, ou substitui o seu escopo (docs/screen-scope.md). O alcance do agente é este escopo restringido pelo da pessoa responsável por ele, então uma pessoa com escopo nunca age por meio de um agente mais amplo do que ela.

Somente o proprietário do projeto ou um membro que administra a organização do projeto (forbidden caso contrário); um agente que não é membro do projeto é not_found. Acrescenta agent.screen_scope_changed (detalhes agent_id, screen_scope, previous, changed_by_user_id).

O escopo de um agente vale para a próxima requisição dele na instância que o gravou e em até dois segundos nas outras. Um escopo é recusado com resource_conflict enquanto o agente tem um cliente de serviço ativo do projeto: o detalhe nomeia até cinco clientes como ID (nome) e conta o restante, e nada é gravado.

Limitar um agente a telas é o recurso de escopo de telas, que o plano Enterprise inclui; um projeto cujo plano não o inclui é recusado com feature_not_in_plan (402). Um escopo definido continua limitando o agente até ser limpo (DELETE), o que todo plano pode fazer.

Autenticação
dashboardSession
Corpo da solicitação
AgentScreenScopeUpdate
ID da operação
setDashboardAgentScreenScope

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório

Campos do corpo da solicitação

CampoDescrição
screen_scope (obrigatório, ScreenScope)

Sobre o que um membro ou agente com escopo pode agir (docs/screen-scope.md): as telas nas pastas de telas listadas e em todas as pastas dentro delas, e as telas listadas. Pelo menos um id no total. Um id que não nomeia nenhuma pasta ou tela existente do projeto quando gravado é invalid_request na sua posição; uma exclusão posterior deixa um id morto, que não concede nada.

O escopo é lido a cada requisição, então uma alteração vale já na próxima. Tags nunca são escopo.

Modelo e respostas da solicitação
shell · modelo de requisição
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/agents/RESOURCE_ID/screen-scope'

Respostas

StatusSignificadoCorpo e cabeçalhos
200O agente, com screen_scope.Agent (application/json)
402feature_not_in_plan — O escopo de telas faz parte do plano Enterprise; o problema nomeia o recurso, o plano em que a conta está e required_plan.Problema (application/problem+json)
403forbidden - somente o proprietário do projeto ou um membro que administra a organização do projeto define um escopo, e outside_screen_scope para um membro limitado a telas; peça ao proprietário do projeto.Problema (application/problem+json)
409resource_conflict - o agente tem um cliente de serviço ativo do projeto; revogue cada cliente nomeado com screenrig service-client revoke ID e defina o escopo de novo.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)
EXCLUIR/api/agents/{id}/screen-scope

Limpar escopo de telas de agente do dashboard

Remove o escopo da associação de um agente ao projeto da sessão. Somente o proprietário do projeto ou um membro que administra a organização do projeto. Acrescenta agent.screen_scope_changed com screen_scope null.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
clearDashboardAgentScreenScope

Parâmetros

NomeEnviarObrigatório?Descrição
idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/agents/RESOURCE_ID/screen-scope'

Respostas

StatusSignificadoCorpo e cabeçalhos
200O agente.Agent (application/json)
403forbidden - somente o proprietário do projeto ou um membro que administra a organização do projeto define um escopo, e outside_screen_scope para um membro limitado a telas; peça ao proprietário do projeto.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)
PUT/api/members/{user_id}/upload-scope

Definir escopo de upload de membro do dashboard

Transforma um membro em uploader ou substitui o escopo de um (docs/uploaders.md): as playlists cujas páginas ele altera e as pastas de mídia para as quais envia.

Em uma única transação, também impede que aprovem revisões, encerra os agentes que trouxeram ao projeto (agent.disconnected, como a remoção faria) e acrescenta project.member_upload_scope_changed (detalhes user_id, upload_scope, changed_by_user_id).

O escopo é lido na próxima requisição do membro: a mudança aparece no próximo GET /api/session, sem entrar novamente.

Somente o proprietário do projeto ou um membro que administra a organização do projeto (caso contrário, forbidden); a própria linha do proprietário é resource_conflict; um não membro é not_found; um id que não é uma playlist ou pasta de mídia ativa do projeto é invalid_request em upload_scope.playlist_ids[i] ou upload_scope.folder_ids[i]. access propose (o padrão) envia as alterações do uploader para revisão; manage as publica.

Um membro limitado a telas é resource_conflict: remova esse escopo primeiro (DELETE /api/members/{user_id}/screen-scope).

Autenticação
dashboardSession
Corpo da solicitação
MemberUploadScopeUpdate
ID da operação
setDashboardMemberUploadScope

Parâmetros

NomeEnviarObrigatório?Descrição
user_idcaminhoobrigatório

Campos do corpo da solicitação

CampoDescrição
upload_scope (obrigatório, UploadScope)

O que um uploader pode usar (docs/uploaders.md): as playlists cujas páginas ele altera e as pastas de mídia para as quais envia. As pastas são exatamente as listadas, nunca suas subpastas. Um id que, ao ser gravado, não nomeia nenhum objeto ativo do projeto é invalid_request em sua posição; uma exclusão posterior deixa um id morto, que não concede nada.

O escopo é lido a cada requisição, então uma mudança vale para a próxima.

project_id (opcional, string)Como em MemberApproverUpdate. minLength: 1 maxLength: 200
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/members/USER_ID/upload-scope'

Respostas

StatusSignificadoCorpo e cabeçalhos
200O membro, com upload_scope.DashboardMember (application/json)
402

feature_not_in_plan — um escopo de upload cria um uploader, e o plano do projeto não inclui uploaders; required_plan nomeia o plano que os inclui. Restringir um escopo e removê-lo são sempre permitidos.

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)
EXCLUIR/api/members/{user_id}/upload-scope

Limpar escopo de upload de membro do dashboard

Torna um uploader novamente um membro completo, que não aprova revisões (ative isso com setDashboardMemberApprover). Somente o proprietário do projeto ou um membro que administra a organização do projeto; um membro que não é uploader permanece como está. Acrescenta project.member_upload_scope_changed com upload_scope null.

Autenticação
dashboardSession
Corpo da solicitação
nenhum
ID da operação
clearDashboardMemberUploadScope

Parâmetros

NomeEnviarObrigatório?Descrição
user_idcaminhoobrigatório
project_idconsultaopcionalO projeto que o chamador quer dizer; uma sessão cuja seleção mudou é recusada com resource_conflict.
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/members/USER_ID/upload-scope'

Respostas

StatusSignificadoCorpo e cabeçalhos
200O membro.DashboardMember (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)