Referência da API REST de Digital Signage

OpenAPI YAML OpenAPI JSON problemas YAML

Escolha o serviço correto

O endpoint determina tanto a URL base quanto a credencial. Os modelos de solicitação abaixo usam a URL do serviço declarada.

O que você está fazendo	Serviço	Autenticação
Gerenciando telas e conteúdo	`api.screenrig.ai`	Token portador do agente
Executando um Player	`play.screenrig.ai`	Cookies do navegador ou credenciais nativas do Player
Gerenciando um login e projetos	`screenrig.ai/dashboard`	Cookies do Dashboard
Provisionamento de pessoas a partir de um provedor de identidade	`api.screenrig.ai/scim/v2`	Token SCIM da organização
Carregando uma versão do aplicativo	Seu host exato sob `apps.screenrig.ai`	Lançar ticket ou cookie de lançamento

Players nativos usam ScreenRig-Pairing durante a configuração e ScreenRig-Session depois. Essas requisições não devem incluir cookies. Endpoints de navegador usam seus próprios cookies.

Nomes de autenticação usados abaixo

projectBearer: O token de agente ativo usado pelo CLI incluído, vinculado a exatamente um projeto.
áreas de capacidade: Cada credencial de agente carrega um conjunto fixo de áreas: screens, content, playlists, advertising, reports e project. Uma credencial chama apenas rotas em suas áreas; reports também lê qualquer área. Uma requisição nomeando uma área ausente retorna 403 forbidden com o detalhe "Esta credencial de agente não possui a capacidade <name>." Conecte uma nova instalação de agente com as capacidades necessárias para recuperar.
revocableAgentBearer: O token do agente chamador, aceito para tentar novamente sua própria desconexão.
cookies de pareamento, dispositivo e runtime: Credenciais do Player do navegador. Cada endpoint especifica qual cookie aceita.
cookie de sessão do dashboard: A sessão da pessoa logada e o projeto selecionado. O cookie separado __Host-screenrig-signup vincula inscrição por link de convite, verificação de e-mail, opções de credencial e aceitação. Nenhum cookie é credencial de agente. Uma pessoa que pode aprovar cria e substitui playlists com ela no editor de páginas do dashboard.
primitiveCapability: Acesso de curta duração ao armazenamento chave/valor de um aplicativo a partir de uma primitiva de playlist.
demoSession: Uma sessão de demonstração de site privado, separada das credenciais do projeto e dashboard. O site a define após o cadastro ou um convite privado; identificadores de fluxo nunca autorizam acesso.
scimBearer: Token de provisionamento SCIM de uma organização, aceito somente pelas rotas /scim/v2. Nunca é uma credencial de projeto, agente ou dashboard.
ssoTransaction: O cookie que vincula um login único ao navegador que o iniciou.
operatorBearer: Acesso do operador do serviço.

Pessoas, projetos e convites

Uma pessoa tem um login e pode pertencer a muitos projetos. O cadastro sempre cria um novo projeto e envia um convite de membro para o endereço de contato. O agente propõe um nome para o projeto; cada token de agente permanece vinculado a esse projeto.

O dashboard lista os projetos da pessoa e alterna o projeto selecionado para operações autenticadas por cookie. E-mail pessoal e passkeys pertencem ao login, não ao projeto.

Os convites compartilham um fluxo de criação, listagem, revogação e aceitação. Membros do projeto recebem e-mail por padrão; um link de membro solicitado explicitamente é retornado apenas ao seu criador. Convites para compradores de anúncios são apenas por e-mail. Convites por e-mail expiram após sete dias e links de membros após vinte e quatro horas. Uma nova pessoa cria uma passkey; uma pessoa existente faz login antes de aceitar. O cadastro por link verifica o e-mail da pessoa antes de criar um login.

Redefinição de login é apenas por caixa de correio, expira após uma hora e substitui as credenciais de login da pessoa enquanto revoga suas outras sessões. Solicitar confirmação não revela se um e-mail tem login. Abrir o dashboard é navegação, não concessão de autoridade.

Semântica comum de requisição

Idempotência: quando um endpoint aceita Idempotency-Key, reutilize essa chave e a solicitação idêntica após uma resposta perdida; divergência retorna 409 idempotency_mismatch.
Revisões: quando um endpoint exige If-Match, envie a revisão atual do recurso; escritas obsoletas retornam 412 revision_conflict.
Cursores: cursores de lista e SSE são opacos.
Operações: uploads podem começar em receiving, depois usar queued, running, succeeded, failed, ou cancelled.
SSE: retome com o último cursor ou Last-Event-ID. Um quadro stream.resync_required significa buscar novamente o estado autoritativo e retomar no cursor principal fornecido.
Limites: capacidades publicam limites ativos; limitação de taxa retorna 429 rate_limited.

A persistência da credencial pertence ao fluxo do plugin. O CLI incluído lê a configuração da plataforma fora do diretório do plugin substituível.

Enviar ciclos de vida

Aplicativos

Envie um arquivo determinístico já construído e aguarde validação, extração e publicação imutável. screenRIG gerencia a saída estática empacotada.

Mídia

Declare o tipo, tamanho e hash exatos; siga o método PUT bruto assinado e os cabeçalhos literalmente; confirme e aguarde. Trate URLs e cabeçalhos assinados como credenciais.

Conteúdo protegido e de tempo de execução

Emparelhamento, sessões de dispositivo/runtime, manifests, relatórios, eventos, tickets de lançamento e KV de runtime vivem na origem confiável do Player. Mídia do manifest suporta intervalos definidos por contrato; ativos de release usam hosts isolados exatos. Sessões nativas autorizadas do Player recebem pacotes webapp imutáveis normalizados via rota protegida vinculada ao manifest e release.

O conteúdo segue a autoridade atual da tela. Liberação, pacote e acesso K/V derivam das permissões atuais do manifesto da tela; a mídia é servida para uma tela cujo projeto a possui. A autoridade do pacote nativo vincula a tela atual, revisão do manifesto, identidade da liberação, hash do pacote, tamanho, tipo e sessão do dispositivo; o armazenamento permanece privado e a entrega continua mediada pelo servidor.

Inventário completo de endpoints

740 operações em 41 grupos, geradas a partir de api/openapi.yaml. Cada grupo tem sua própria página com os parâmetros, os campos da solicitação, o modelo de solicitação e as respostas de cada operação.

Metadados do serviço, capacidades e busca na documentação

6 operações com seus parâmetros, modelos de solicitação e respostas.

Obter Health GET /.health
Obter prontidão GET /.ready
Obter versão GET /.version
Obter capacidades GET /api/capabilities
Pesquisar na documentação oficial GET /api/docs/search
Ler uma página ou seção da documentação oficial GET /api/docs/page

Projetos, convites e login

147 operações com seus parâmetros, modelos de solicitação e respostas.

Visualizar agente de exclusão de projeto GET /api/project/deletion-preview
Transferir agente proprietário do projeto PUT /api/project/owner
Mover agente do projeto POST /api/project/move
Projeto permitido move agente GET /api/project/moves
Listar projetos de agentes GET /api/projects
Criar projeto de agente POST /api/projects
Listar convites GET /api/invitations
Criar convites POST /api/invitations
Revogar convite POST /api/invitations/{id}/revoke
Solicitar redefinição de login POST /api/sign-in-resets
Registrar CLI POST /api/enrollments
Iniciar ID de agente Entrar GET /agentid/start
Concluir login Agent ID GET /agentid/callback
Obter projeto GET /api/project
Atualizar projeto PATCH /api/project
Excluir agente do projeto DELETE /api/project
Obter capacidades do projeto GET /api/project/capabilities
Listar a auditoria da organização GET /api/organizations/{org_id}/audit
Listar notificações da organização GET /api/organizations/{org_id}/notifications
Criar notificação da organização POST /api/organizations/{org_id}/notifications
Obter notificação da organização GET /api/organizations/{org_id}/notifications/{id}
Atualizar notificação da organização PATCH /api/organizations/{org_id}/notifications/{id}
Excluir notificação da organização DELETE /api/organizations/{org_id}/notifications/{id}
Rotacionar segredo da notificação da organização POST /api/organizations/{org_id}/notifications/{id}/rotate-secret
Testar notificação da organização POST /api/organizations/{org_id}/notifications/{id}/test
Listar entregas da notificação da organização GET /api/organizations/{org_id}/notifications/{id}/deliveries
Listar tentativas de entrega da notificação da organização GET /api/organizations/{org_id}/notifications/{id}/deliveries/{delivery_id}/attempts
Reinscrever uma pessoa em uma notificação da organização DELETE /api/organizations/{org_id}/notifications/{id}/unsubscribed/{user_id}
Listar os tipos de relatório em um projeto GET /api/projects/{project_id}/reports
Listar as assinaturas de relatórios em um projeto GET /api/projects/{project_id}/report-subscriptions
Criar assinatura de relatório em um projeto POST /api/projects/{project_id}/report-subscriptions
Listar cartões no projeto GET /api/projects/{project_id}/cards
Criar cartão de projeto POST /api/projects/{project_id}/cards
Criar portal da organização POST /api/organizations/{org_id}/billing/portal-sessions
Definir recarga automática da organização PUT /api/organizations/{org_id}/billing/auto-top-up
Obter os pagamentos de uma organização GET /api/organizations/{org_id}/billing/payments
Criar um pagamento para uma organização POST /api/organizations/{org_id}/billing/credit-checkouts
Obter saldo de cobrança da organização GET /api/organizations/{org_id}/billing/balance
Obter extrato de cobrança da organização GET /api/organizations/{org_id}/billing/statement
Obter uso de cobrança da organização GET /api/organizations/{org_id}/billing/usage
Lista de organizações do agente GET /api/organizations
Renomear organizações do agente PATCH /api/organizations/{org_id}
Definir política de revisão do projeto PUT /api/project/review-policy
Visualizar agente de exclusão de projeto no projeto GET /api/projects/{project_id}/project/deletion-preview
Transferir agente proprietário do projeto no projeto PUT /api/projects/{project_id}/project/owner
Mover agente do projeto no projeto POST /api/projects/{project_id}/project/move
Projeto permitido move agente no projeto GET /api/projects/{project_id}/project/moves
Listar convites no projeto GET /api/projects/{project_id}/invitations
Criar convites no projeto POST /api/projects/{project_id}/invitations
Obter projeto no projeto GET /api/projects/{project_id}/project
Atualizar projeto dentro do projeto PATCH /api/projects/{project_id}/project
Excluir agente do projeto no projeto DELETE /api/projects/{project_id}/project
Listar aplicativos no projeto GET /api/projects/{project_id}/applications
Enviar aplicativo dentro do projeto POST /api/projects/{project_id}/applications
Criar upload de aplicativo no projeto POST /api/projects/{project_id}/applications/uploads
Listar playlists V2 no projeto GET /api/projects/{project_id}/playlists
Criar playlist V2 no projeto POST /api/projects/{project_id}/playlists
Listar telas no projeto GET /api/projects/{project_id}/screens
Listar pastas de telas no projeto GET /api/projects/{project_id}/screen-folders
Criar pasta de telas no projeto POST /api/projects/{project_id}/screen-folders
Mover telas no projeto POST /api/projects/{project_id}/screens/move
Obter calendário de programação no projeto GET /api/projects/{project_id}/schedule/calendar
Obter modelo de importação de programação no projeto GET /api/projects/{project_id}/schedule/imports/template
Pré-visualizar importação de programação no projeto POST /api/projects/{project_id}/schedule/imports/preview
Confirmar importação de programação no projeto POST /api/projects/{project_id}/schedule/imports
Reivindicar link do navegador no projeto POST /api/projects/{project_id}/project/browser-links/claim
Parear tela no projeto POST /api/projects/{project_id}/screens/pair
Provisionar tela no projeto POST /api/projects/{project_id}/screens/provision
Aplicar ações na tela no projeto POST /api/projects/{project_id}/screens/actions
Iniciar compartilhamento de abas no projeto POST /api/projects/{project_id}/tab-shares
Listar campanhas no projeto GET /api/projects/{project_id}/campaigns
Criar campanha no projeto POST /api/projects/{project_id}/campaigns
Listar conexões de um projeto GET /api/projects/{project_id}/connections
Criar uma conexão em um projeto POST /api/projects/{project_id}/connections
Listar conexões BI no projeto GET /api/projects/{project_id}/bi-connections
Criar conexão BI no projeto POST /api/projects/{project_id}/bi-connections
Listar visualizações BI no projeto GET /api/projects/{project_id}/bi-views
Criar visualização BI no projeto POST /api/projects/{project_id}/bi-views
Listar gatilhos no projeto GET /api/projects/{project_id}/triggers
Criar gatilho no projeto POST /api/projects/{project_id}/triggers
Listar eventos no projeto GET /api/projects/{project_id}/events
Obter capacidades do projeto no projeto GET /api/projects/{project_id}/project/capabilities
Obter saldo de cobrança no projeto GET /api/projects/{project_id}/billing/balance
Obter extrato de cobrança no projeto GET /api/projects/{project_id}/billing/statement
Obter uso de cobrança no projeto GET /api/projects/{project_id}/billing/usage
Obter rede publicitária no projeto GET /api/projects/{project_id}/advertising/network
Criar rede de anúncios no projeto POST /api/projects/{project_id}/advertising/network
Definir taxa padrão de publicidade no projeto POST /api/projects/{project_id}/advertising/network/rate
Listar inventário publicitário no projeto GET /api/projects/{project_id}/advertising/inventory
Listar espaços publicitários no projeto GET /api/projects/{project_id}/advertising/slots
Criar espaço publicitário no projeto POST /api/projects/{project_id}/advertising/slots
Listar associações publicitárias no projeto GET /api/projects/{project_id}/advertising/memberships
Listar redes publicitárias associadas no projeto GET /api/projects/{project_id}/advertising/networks
Listar criativos publicitários no projeto GET /api/projects/{project_id}/advertising/creatives
Criar criativo publicitário no projeto POST /api/projects/{project_id}/advertising/creatives
Listar campanhas publicitárias no projeto GET /api/projects/{project_id}/advertising/campaigns
Criar campanha publicitária no projeto POST /api/projects/{project_id}/advertising/campaigns
Listar avaliações publicitárias no projeto GET /api/projects/{project_id}/advertising/reviews
Obter gastos publicitários no projeto GET /api/projects/{project_id}/advertising/reports/spend
Obter entrega publicitária no projeto GET /api/projects/{project_id}/advertising/reports/delivery
Listar agregados de reprodução no projeto GET /api/projects/{project_id}/playback
Listar execuções de reprodução no projeto GET /api/projects/{project_id}/playback/plays
Obter totais de reprodução no projeto GET /api/projects/{project_id}/playback/totals
Obter completude da reprodução no projeto GET /api/projects/{project_id}/playback/completeness
Obter Health Trend no projeto GET /api/projects/{project_id}/health/trend
Obter uptime do projeto no projeto GET /api/projects/{project_id}/uptime/daily
Listar tipos de cartões no projeto GET /api/projects/{project_id}/card-types
Listar dados de cartões no projeto GET /api/projects/{project_id}/card-data
Listar mídias no projeto GET /api/projects/{project_id}/media
Criar geração de mídia no projeto POST /api/projects/{project_id}/media/generations
Listar pastas de mídia no projeto GET /api/projects/{project_id}/media-folders
Criar pasta de mídia no projeto POST /api/projects/{project_id}/media-folders
Mover mídia no projeto POST /api/projects/{project_id}/media/move
Criar upload de mídia no projeto POST /api/projects/{project_id}/media/uploads
Visualizar seletor no projeto POST /api/projects/{project_id}/selectors/preview
Listar relatórios de bugs no projeto GET /api/projects/{project_id}/feedback/bugs
Relatar bug no projeto POST /api/projects/{project_id}/feedback/bugs
Listar solicitações de recursos no projeto GET /api/projects/{project_id}/feedback/features
Solicitar recurso no projeto POST /api/projects/{project_id}/feedback/features
Listar clientes de serviço no projeto GET /api/projects/{project_id}/service-clients
Criar cliente de serviço no projeto POST /api/projects/{project_id}/service-clients
Listar contas de sincronização de mídia no projeto GET /api/projects/{project_id}/media-sync-accounts
Criar conta de sincronização de mídia no projeto POST /api/projects/{project_id}/media-sync-accounts
Listar sincronizações de mídia no projeto GET /api/projects/{project_id}/media-syncs
Criar sincronização de mídia no projeto POST /api/projects/{project_id}/media-syncs
Listar links da frota no projeto GET /api/projects/{project_id}/fleet-links
Criar link de frota no projeto POST /api/projects/{project_id}/fleet-links
Listar webhooks no projeto GET /api/projects/{project_id}/webhooks
Criar webhook no projeto POST /api/projects/{project_id}/webhooks
Listar alertas no projeto GET /api/projects/{project_id}/alerts
Listar silenciamentos de alerta no projeto GET /api/projects/{project_id}/alert-mutes
Criar silenciamento de alerta no projeto POST /api/projects/{project_id}/alert-mutes
Listar notificações no projeto GET /api/projects/{project_id}/notifications
Criar notificação no projeto POST /api/projects/{project_id}/notifications
Listar notas no projeto GET /api/projects/{project_id}/notes
Adicionar nota no projeto POST /api/projects/{project_id}/notes
Status do suporte no projeto GET /api/projects/{project_id}/support/status
Listar conversas de suporte no projeto GET /api/projects/{project_id}/support/conversations
Criar conversa de suporte no projeto POST /api/projects/{project_id}/support/conversations
Listar avaliações no projeto GET /api/projects/{project_id}/reviews
Projeto Scoped_get Dados do Cartão GET /api/projects/{project_id}/card-data/{key}
Projeto Scoped_put Dados do Cartão PUT /api/projects/{project_id}/card-data/{key}
Projeto Scoped_delete Dados do Cartão DELETE /api/projects/{project_id}/card-data/{key}
Projeto Scoped_get Feed GET /api/projects/{project_id}/feeds/{family}
Projeto Scoped_list Inventário Publicitário Associado GET /api/projects/{project_id}/advertising/networks/{seller_project_id}/inventory
Projeto Scoped_get Agente Atual GET /api/projects/{project_id}/agents/self
Projeto Scoped_disconnect Agente Atual POST /api/projects/{project_id}/agents/self/disconnect

Planos, saldos e extratos de créditos

6 operações com seus parâmetros, modelos de solicitação e respostas.

Obter saldo de cobrança GET /api/billing/balance
Obter extrato de cobrança GET /api/billing/statement
Obter uso de cobrança GET /api/billing/usage
Obter oferta da App Store GET /api/organizations/{organization_id}/app-store/offer
Registrar transação da App Store POST /api/organizations/{organization_id}/app-store/transactions
Receber notificação da App Store POST /api/app-store/notifications

Instalações e conexões do agente

3 operações com seus parâmetros, modelos de solicitação e respostas.

Revogar identidade do agente POST /api/agent-identity/revoke
Obter agente atual GET /api/agents/self
Desconectar agente atual POST /api/agents/self/disconnect

OAuth sign-in, tokens e revogação

10 operações com seus parâmetros, modelos de solicitação e respostas.

Token Oauth POST /oauth/token
Autorização de Dispositivo Oauth POST /oauth/device_authorization
Autorizar Oauth GET /oauth/authorize
Revogar Oauth POST /oauth/revoke
Metadados do Servidor de Autorização Oauth GET /.well-known/oauth-authorization-server
MCP de Recurso Protegido Oauth GET /.well-known/oauth-protected-resource/mcp
API de Recurso Protegido Oauth GET /.well-known/oauth-protected-resource/api
Obter autorização OAuth do dashboard GET /api/oauth/authorizations/{id}
Aprovar autorização OAuth do dashboard POST /api/oauth/authorizations/{id}/approve
Negar autorização OAuth do Dashboard POST /api/oauth/authorizations/{id}/deny

Login único: rotas de login, provedor de identidade e política

13 operações com seus parâmetros, modelos de solicitação e respostas.

Descobrir SSO do dashboard POST /api/sso/discovery
Iniciar SSO do dashboard POST /api/sso/starts
Receber SSOOIDCCallback do dashboard POST /api/sso/oidc/{connection_id}/callback
Obter SSOSAMLMetadata do dashboard GET /api/sso/saml/{connection_id}
Receber SSOSAMLAssertion do dashboard POST /api/sso/saml/{connection_id}/acs
Concluir SSO do dashboard POST /api/sso/finish
Iniciar SSO da sessão do dashboard POST /api/session/sso-starts
Dashboard Organizações Obter provedor de identidade GET /api/organizations/{org_id}/identity-provider
Dashboard Organizações Definir provedor de identidade PUT /api/organizations/{org_id}/identity-provider
Dashboard Organizações Remover provedor de identidade DELETE /api/organizations/{org_id}/identity-provider
Dashboard Organizações Testar provedor de identidade POST /api/organizations/{org_id}/identity-provider/tests
Dashboard Organizações Definir SSOPolicy PUT /api/organizations/{org_id}/sso-policy
Dashboard Organizações Cancelar SSORemoval DELETE /api/organizations/{org_id}/sso-policy/removal

Provisionamento de usuários: SCIM 2.0, tokens e vinculações de grupo

24 operações com seus parâmetros, modelos de solicitação e respostas.

Dashboard Organizações Obter SCIM GET /api/organizations/{org_id}/scim
Dashboard Organizações Definir SCIM PUT /api/organizations/{org_id}/scim
Dashboard Organizações Criar SCIMToken POST /api/organizations/{org_id}/scim/tokens
Dashboard Organizações Revogar SCIMToken DELETE /api/organizations/{org_id}/scim/tokens/{token_id}
Dashboard Organizações Listar SCIMGroups GET /api/organizations/{org_id}/scim/groups
Dashboard Organizações Listar SCIMEvents GET /api/organizations/{org_id}/scim/events
Listar vinculações de grupo do dashboard GET /api/project/group-bindings
Criar vinculação de grupo do dashboard POST /api/project/group-bindings
Excluir vinculação de grupo do dashboard DELETE /api/project/group-bindings/{binding_id}
Obter configuração do provedor de serviço SCIM GET /scim/v2/ServiceProviderConfig
Listar SCIMResource Types GET /scim/v2/ResourceTypes
Listar SCIMSchemas GET /scim/v2/Schemas
Listar SCIMUsers GET /scim/v2/Users
Criar SCIMUser POST /scim/v2/Users
Obter SCIMUser GET /scim/v2/Users/{id}
Substituir SCIMUser PUT /scim/v2/Users/{id}
Aplicar patch em SCIMUser PATCH /scim/v2/Users/{id}
Excluir SCIMUser DELETE /scim/v2/Users/{id}
Listar SCIMGroups GET /scim/v2/Groups
Criar SCIMGroup POST /scim/v2/Groups
Obter SCIMGroup GET /scim/v2/Groups/{id}
Substituir SCIMGroup PUT /scim/v2/Groups/{id}
Aplicar patch em SCIMGroup PATCH /scim/v2/Groups/{id}
Excluir SCIMGroup DELETE /scim/v2/Groups/{id}

Clientes de serviço

9 operações com seus parâmetros, modelos de solicitação e respostas.

Listar clientes de serviço GET /api/service-clients
Criar cliente de serviço POST /api/service-clients
Obter cliente de serviço GET /api/service-clients/{id}
Atualizar cliente de serviço PATCH /api/service-clients/{id}
Adicionar chave de cliente de serviço POST /api/service-clients/{id}/keys
Remover chave de cliente de serviço POST /api/service-clients/{id}/keys/{kid}/remove
Adicionar segredo de cliente de serviço POST /api/service-clients/{id}/secrets
Remover segredo de cliente de serviço POST /api/service-clients/{id}/secrets/{secret_id}/remove
Revogar cliente de serviço POST /api/service-clients/{id}/revoke

Aplicativos e operações

11 operações com seus parâmetros, modelos de solicitação e respostas.

Listar aplicativos GET /api/applications
Enviar aplicativo POST /api/applications
Enviar versão do aplicativo POST /api/applications/{id}/releases
Criar upload de aplicativo POST /api/applications/uploads
Criar upload de versão de aplicativo POST /api/applications/{id}/uploads
Commit Application Upload POST /api/applications/uploads/{id}/commit
Obter aplicativo GET /api/applications/{id}
Renomear aplicativo PATCH /api/applications/{id}
Excluir aplicativo DELETE /api/applications/{id}
Obter operação GET /api/operations/{id}
Cancelar operação POST /api/operations/{id}/cancel

Uploads de mídia

38 operações com seus parâmetros, modelos de solicitação e respostas.

Listar mídias GET /api/media
Criar geração de mídia POST /api/media/generations
Listar pastas de mídia GET /api/media-folders
Criar pasta de mídia POST /api/media-folders
Obter pasta de mídia GET /api/media-folders/{id}
Atualizar pasta de mídia PATCH /api/media-folders/{id}
Excluir pasta de mídia DELETE /api/media-folders/{id}
Mover mídia POST /api/media/move
Criar upload de mídia POST /api/media/uploads
Commit Media Upload POST /api/media/uploads/{id}/commit
Visualizar seletor POST /api/selectors/preview
Obter mídia GET /api/media/{id}
Patch Media PATCH /api/media/{id}
Excluir mídia DELETE /api/media/{id}
Patch Media Tags PATCH /api/media/{id}/tags
Aplicar patch na disponibilidade da mídia PATCH /api/media/{id}/availability
Substituir mídia POST /api/media/{id}/replace
Listar versões da mídia GET /api/media/{id}/versions
Excluir versão da mídia DELETE /api/media/{id}/versions/{version}
Restaurar versão da mídia POST /api/media/{id}/versions/{version}/restore
Exportar conteúdo de mídia GET /api/media/{id}/content
Conteúdo de mídia principal HEAD /api/media/{id}/content
Listar contas de sincronização de mídia GET /api/media-sync-accounts
Criar conta de sincronização de mídia POST /api/media-sync-accounts
Obter conta de sincronização de mídia GET /api/media-sync-accounts/{id}
Atualizar conta de sincronização de mídia PATCH /api/media-sync-accounts/{id}
Excluir conta de sincronização de mídia DELETE /api/media-sync-accounts/{id}
Testar conta de sincronização de mídia POST /api/media-sync-accounts/{id}/test
Conectar a conta de sincronização de mídia POST /api/media-sync-accounts/{id}/connect
Listar designs de sincronização de mídia GET /api/media-sync-accounts/{id}/designs
Concluir o consentimento do Canva GET /api/canva/callback
Concluir o consentimento do Dropbox GET /api/dropbox/callback
Listar sincronizações de mídia GET /api/media-syncs
Criar sincronização de mídia POST /api/media-syncs
Obter sincronização de mídia GET /api/media-syncs/{id}
Atualizar sincronização de mídia PATCH /api/media-syncs/{id}
Excluir sincronização de mídia DELETE /api/media-syncs/{id}
Executar sincronização de mídia POST /api/media-syncs/{id}/run

Playlists

16 operações com seus parâmetros, modelos de solicitação e respostas.

Listar playlists V2 GET /api/playlists
Criar playlist V2 POST /api/playlists
Obter Playlist V2 GET /api/playlists/{id}
Atualizar playlist V2 PUT /api/playlists/{id}
Patch Playlist PATCH /api/playlists/{id}
Excluir playlist V2 DELETE /api/playlists/{id}
Patch Playlist Structure PATCH /api/playlists/{id}/structure
Listar revisões da playlist GET /api/playlists/{id}/revisions
Obter revisão da playlist GET /api/playlists/{id}/revisions/{revision}
Promover revisão da playlist POST /api/playlists/{id}/revisions/{revision}/promote
Atualizar valores de playlist PATCH /api/playlists/{id}/values
Listar instâncias de playlist GET /api/playlists/{id}/instances
Expandir modelo de playlist POST /api/playlists/{id}/expand
Adicionar página de playlist POST /api/playlists/{id}/pages
Substituir página de playlist PUT /api/playlists/{id}/pages/{page_id}
Remover página de playlist DELETE /api/playlists/{id}/pages/{page_id}

Telas

84 operações com seus parâmetros, modelos de solicitação e respostas.

Listar telas GET /api/screens
Listar pastas de telas GET /api/screen-folders
Criar pasta de telas POST /api/screen-folders
Obter pasta de telas GET /api/screen-folders/{id}
Atualizar pasta de telas PATCH /api/screen-folders/{id}
Excluir pasta de telas DELETE /api/screen-folders/{id}
Mover telas POST /api/screens/move
Obter calendário de programação GET /api/schedule/calendar
Parear tela POST /api/screens/pair
Provisionar tela POST /api/screens/provision
Aplicar ações na tela POST /api/screens/actions
Obter tela GET /api/screens/{id}
Atualizar tela PATCH /api/screens/{id}
Excluir tela DELETE /api/screens/{id}
Patch Screen Tags PATCH /api/screens/{id}/tags
Aplicar patch nos campos da tela PATCH /api/screens/{id}/fields
Aplicar patch na localização da tela PATCH /api/screens/{id}/location
Alterar a verbosidade de uma tela PATCH /api/screens/{id}/verbosity
Aplicar patch nas configurações do dispositivo da tela PATCH /api/screens/{id}/device-settings
Alterar nome da tela PATCH /api/screens/{id}/name
Alterar playlist da tela PATCH /api/screens/{id}/playlist
Rotacionar ID público da tela POST /api/screens/{id}/public-id/rotate
Obter link da tela GET /api/screens/{id}/link
Criar link da tela POST /api/screens/{id}/link
Excluir link da tela DELETE /api/screens/{id}/link
Confirmar recuperação de tela POST /api/screens/{id}/recovery/confirm
Substituir tela POST /api/screens/{id}/replace
Arquivar tela POST /api/screens/{id}/archive
Desarquivar tela POST /api/screens/{id}/unarchive
Recarregar tela POST /api/screens/{id}/reload
Obter programação de playlist da tela GET /api/screens/{id}/playlist-schedule
Definir programação da playlist da tela PUT /api/screens/{id}/playlist-schedule
Limpar programação da playlist da tela DELETE /api/screens/{id}/playlist-schedule
Pré-visualizar programação de playlist da tela POST /api/screens/{id}/playlist-schedule/preview
Listar revisões da programação de playlist da tela GET /api/screens/{id}/playlist-schedule/revisions
Restaurar revisão da programação de playlist da tela POST /api/screens/{id}/playlist-schedule/revisions/{revision}/restore
Definir takeover da tela POST /api/screens/{id}/takeover
Limpar takeover da tela DELETE /api/screens/{id}/takeover
Iniciar compartilhamento de abas POST /api/tab-shares
Obter compartilhamento de abas GET /api/tab-shares/{id}
Parar compartilhamento de abas DELETE /api/tab-shares/{id}
Reproduzir Página da tela POST /api/screens/{id}/play-page
Identificar tela POST /api/screens/{id}/identify
Suspender tela POST /api/screens/{id}/suspend
Retomar tela POST /api/screens/{id}/resume
Reiniciar tela POST /api/screens/{id}/reboot
Limpar cache da tela POST /api/screens/{id}/clear-cache
Reiniciar app da tela POST /api/screens/{id}/restart-app
Atualizar Player da tela POST /api/screens/{id}/update
Listar comandos da tela GET /api/screens/{id}/commands
Cancelar comando da tela POST /api/screens/{id}/commands/{command_id}/cancel
Definir exibição da tela POST /api/screens/{id}/display
Limpar exibição da tela DELETE /api/screens/{id}/display
Obter programação de exibição da tela GET /api/screens/{id}/display-schedule
Definir programação de exibição da tela PUT /api/screens/{id}/display-schedule
Limpar programação de exibição da tela DELETE /api/screens/{id}/display-schedule
Obter programação de reinício da tela GET /api/screens/{id}/reboot-schedule
Definir programação de reinício da tela PUT /api/screens/{id}/reboot-schedule
Limpar programação de reinício da tela DELETE /api/screens/{id}/reboot-schedule
Toast pós-tela POST /api/screens/{id}/toast
Previsão de armazenamento da tela POST /api/screens/{id}/storage-forecast
Explicar campanhas da tela GET /api/screens/{id}/campaigns
Obter screenshot da tela GET /api/screens/{id}/screenshot
Solicitar screenshot da tela POST /api/screens/{id}/screenshot
Obter status do screenshot da tela GET /api/screens/{id}/screenshot/status
Obter sessão ao vivo da tela GET /api/screens/{id}/live
Iniciar sessão ao vivo da tela POST /api/screens/{id}/live
Parar sessão ao vivo da tela DELETE /api/screens/{id}/live
Criar espectador ao vivo da tela POST /api/screens/{id}/live/viewers
Responder a um espectador ao vivo da tela PUT /api/screens/{id}/live/viewers/{viewer_id}
Iniciar quadros ao vivo da tela POST /api/screens/{id}/live/frames
Obter quadro ao vivo da tela GET /api/screens/{id}/live/frame
Conectar os quadros ao vivo GET /live/frames
Obter histórico de saúde da tela GET /api/screens/{id}/health/history
Obter uptime da tela GET /api/screens/{id}/uptime
Obter presença da tela GET /api/screens/{id}/presence
Obter Health Trend GET /api/health/trend
Obter uptime do projeto GET /api/uptime/daily
Listar links da frota GET /api/fleet-links
Criar link de frota POST /api/fleet-links
Obter link da frota GET /api/fleet-links/{id}
Atualizar link da frota PATCH /api/fleet-links/{id}
Excluir link da frota DELETE /api/fleet-links/{id}
Rotacionar Fleet Link POST /api/fleet-links/{id}/rotate

Campanhas

10 operações com seus parâmetros, modelos de solicitação e respostas.

Listar campanhas GET /api/campaigns
Criar campanha POST /api/campaigns
Pré-visualizar campanha POST /api/campaigns/preview
Obter campanha GET /api/campaigns/{id}
Atualizar campanha PATCH /api/campaigns/{id}
Excluir campanha DELETE /api/campaigns/{id}
Listar revisões da campanha GET /api/campaigns/{id}/revisions
Restaurar revisão da campanha POST /api/campaigns/{id}/revisions/{revision}/restore
Promover campanha POST /api/campaigns/{id}/promote
Listar telas da campanha GET /api/campaigns/{id}/screens

Importação de programação: planilhas de linhas de programação

3 operações com seus parâmetros, modelos de solicitação e respostas.

Obter modelo de importação de programação GET /api/schedule/imports/template
Pré-visualizar importação de programação POST /api/schedule/imports/preview
Confirmar importação de programação POST /api/schedule/imports

Revisões de alterações do agente

7 operações com seus parâmetros, modelos de solicitação e respostas.

Listar avaliações GET /api/reviews
Obter avaliação GET /api/reviews/{id}
Localizar revisão GET /api/reviews/{id}/locate
Aprovar revisão POST /api/reviews/{id}/approve
Rejeitar revisão POST /api/reviews/{id}/reject
Solicitar revisão de alterações POST /api/reviews/{id}/request-changes
Retirar revisão POST /api/reviews/{id}/withdraw

Redes e campanhas de publicidade privadas

46 operações com seus parâmetros, modelos de solicitação e respostas.

Obter rede publicitária GET /api/advertising/network
Criar rede de anúncios POST /api/advertising/network
Definir taxa padrão de publicidade POST /api/advertising/network/rate
Listar inventário publicitário GET /api/advertising/inventory
Colocar inventário de publicidade PUT /api/advertising/inventory/{screen_id}
Listar espaços publicitários GET /api/advertising/slots
Criar espaço publicitário POST /api/advertising/slots
Atualizar slot publicitário POST /api/advertising/slots/{id}
Listar associações publicitárias GET /api/advertising/memberships
Atualizar associação publicitária POST /api/advertising/memberships/{id}
Revogar associação de publicidade POST /api/advertising/memberships/{id}/revoke
Listar redes publicitárias associadas GET /api/advertising/networks
Listar inventário publicitário associado GET /api/advertising/networks/{seller_project_id}/inventory
Listar criativos publicitários GET /api/advertising/creatives
Criar criativo publicitário POST /api/advertising/creatives
Obter criativo publicitário GET /api/advertising/creatives/{id}
Listar campanhas publicitárias do vendedor GET /api/advertising/seller-campaigns
Obter campanha publicitária do vendedor GET /api/advertising/seller-campaigns/{id}
Listar campanhas publicitárias GET /api/advertising/campaigns
Criar campanha publicitária POST /api/advertising/campaigns
Obter campanha publicitária GET /api/advertising/campaigns/{id}
Atualizar campanha publicitária POST /api/advertising/campaigns/{id}
Cotação de campanha publicitária POST /api/advertising/campaigns/{id}/quote
Ativar campanha publicitária POST /api/advertising/campaigns/{id}/activate
Pausar campanha publicitária POST /api/advertising/campaigns/{id}/pause
Retomar campanha publicitária POST /api/advertising/campaigns/{id}/resume
Aceitar tarifas de publicidade POST /api/advertising/campaigns/{id}/accept-rates
Listar avaliações publicitárias GET /api/advertising/reviews
Aprovar revisão de publicidade POST /api/advertising/reviews/{id}/approve
Rejeitar revisão de publicidade POST /api/advertising/reviews/{id}/reject
Obter gastos publicitários GET /api/advertising/reports/spend
Obter entrega publicitária GET /api/advertising/reports/delivery
Listar campanhas diretas de publicidade GET /api/advertising/direct-campaigns
Criar campanha direta de publicidade POST /api/advertising/direct-campaigns
Obter campanha direta de publicidade GET /api/advertising/direct-campaigns/{id}
Atualizar campanha direta de publicidade POST /api/advertising/direct-campaigns/{id}
Pausar campanha direta de publicidade POST /api/advertising/direct-campaigns/{id}/pause
Retomar campanha direta de publicidade POST /api/advertising/direct-campaigns/{id}/resume
Encerrar campanha direta de publicidade POST /api/advertising/direct-campaigns/{id}/end
Obter relatório da campanha direta de publicidade GET /api/advertising/direct-campaigns/{id}/report
Estimar disponibilidade de publicidade POST /api/advertising/availability
Obter estatísticas de preenchimento de publicidade GET /api/advertising/reports/fill
Obter revisão publicitária GET /api/advertising/reviews/{id}
Obter conteúdo de revisão publicitária GET /api/advertising/reviews/{id}/content
Revisão de conteúdo de publicidade principal HEAD /api/advertising/reviews/{id}/content
Solicitar alterações na revisão de publicidade POST /api/advertising/reviews/{id}/request-changes

Comentários

9 operações com seus parâmetros, modelos de solicitação e respostas.

Obter comentários da tela GET /api/comment/screen/{id}
Colocar comentários da tela PUT /api/comment/screen/{id}
Excluir comentários da tela DELETE /api/comment/screen/{id}
Obter comentários da playlist GET /api/comment/playlist/{id}
Colocar comentários da playlist PUT /api/comment/playlist/{id}
Excluir comentários da playlist DELETE /api/comment/playlist/{id}
Obter comentários da página da playlist GET /api/comment/playlist/{id}/page/{page_id}
Colocar comentários da página da playlist PUT /api/comment/playlist/{id}/page/{page_id}
Excluir comentários da página da playlist DELETE /api/comment/playlist/{id}/page/{page_id}

Notas do projeto compartilhadas por agentes

5 operações com seus parâmetros, modelos de solicitação e respostas.

Listar notas GET /api/notes
Adicionar nota POST /api/notes
Obter nota GET /api/notes/{id}
Confirmar nota POST /api/notes/{id}/confirm
Resolver nota POST /api/notes/{id}/resolve

Armazenamento chave/valor do aplicativo

9 operações com seus parâmetros, modelos de solicitação e respostas.

Listar KV GET /api/applications/{application_id}/kv
Obter KV GET /api/applications/{application_id}/kv/{key}
Colocar KV PUT /api/applications/{application_id}/kv/{key}
Excluir KV DELETE /api/applications/{application_id}/kv/{key}
Listar KVWebhooks GET /api/applications/{application_id}/kv-webhooks
Criar KVWebhook POST /api/applications/{application_id}/kv-webhooks
Excluir KVWebhook DELETE /api/applications/{application_id}/kv-webhooks/{webhook_id}
Rotacionar segredo KVWebhook POST /api/applications/{application_id}/kv-webhooks/{webhook_id}/rotate-secret
Receber KVWebhook POST /api/applications/{application_id}/kv-webhooks/{webhook_id}/write

Dados do cartão para cartões integrados

22 operações com seus parâmetros, modelos de solicitação e respostas.

Listar tipos de cartões GET /api/card-types
Obter tipo de cartão GET /api/card-types/{id}
Listar cartões GET /api/cards
Criar cartão POST /api/cards
Obter cartão GET /api/cards/{id}
Patch Card PATCH /api/cards/{id}
Excluir cartão DELETE /api/cards/{id}
Obter dados da instância GET /api/cards/{id}/data
Colocar dados da instância PUT /api/cards/{id}/data
Listar webhooks de cartão GET /api/cards/{id}/kv-webhooks
Criar webhook de cartão POST /api/cards/{id}/kv-webhooks
Atualizar webhook de cartão PATCH /api/cards/{id}/kv-webhooks/{webhook_id}
Excluir webhook de cartão DELETE /api/cards/{id}/kv-webhooks/{webhook_id}
Rotacionar segredo de webhook de cartão POST /api/cards/{id}/kv-webhooks/{webhook_id}/rotate-secret
Listar entregas de webhook de cartão GET /api/cards/{id}/kv-webhooks/{webhook_id}/deliveries
Receber webhook de cartão POST /api/cards/{id}/kv-webhooks/{webhook_id}/write
Head Card KVWebhook HEAD /api/cards/{id}/kv-webhooks/{webhook_id}/write
Listar dados de cartões GET /api/card-data
Obter dados do cartão GET /api/card-data/{key}
Colocar dados do cartão PUT /api/card-data/{key}
Excluir dados do cartão DELETE /api/card-data/{key}
Obter feed GET /api/feeds/{family}

Fontes de dados: endereços que mantêm um cartão atualizado

10 operações com seus parâmetros, modelos de solicitação e respostas.

Listar predefinições de fonte GET /api/source-presets
Obter predefinição de fonte GET /api/source-presets/{name}
Listar fontes de dados GET /api/sources
Criar fonte de dados POST /api/sources
Testar fonte de dados POST /api/sources/test
Obter fonte de dados GET /api/sources/{source_id}
Atualizar fonte de dados PATCH /api/sources/{source_id}
Excluir fonte de dados DELETE /api/sources/{source_id}
Obter as salas de uma fonte de dados GET /api/sources/{source_id}/rooms
Sincronizar fonte de dados POST /api/sources/{source_id}/refresh

Dashboards de BI: conexões e visualizações de Power BI, Tableau e páginas web com login

14 operações com seus parâmetros, modelos de solicitação e respostas.

Listar conexões BI GET /api/bi-connections
Criar conexão BI POST /api/bi-connections
Obter conexão BI GET /api/bi-connections/{id}
Atualizar conexão BI PATCH /api/bi-connections/{id}
Excluir conexão BI DELETE /api/bi-connections/{id}
Testar conexão BI POST /api/bi-connections/{id}/test
Navegar na conexão BI GET /api/bi-connections/{id}/browse
Listar visualizações BI GET /api/bi-views
Criar visualização BI POST /api/bi-views
Obter visualização BI GET /api/bi-views/{id}
Atualizar visualização BI PATCH /api/bi-views/{id}
Excluir visualização BI DELETE /api/bi-views/{id}
Testar visualização BI POST /api/bi-views/{id}/test
Obter imagem da visualização BI GET /api/bi-views/{id}/image

Conexões: o acesso reutilizável de um projeto à Microsoft e ao Google

9 operações com seus parâmetros, modelos de solicitação e respostas.

Listar conexões GET /api/connections
Criar conexão POST /api/connections
Obter conexão GET /api/connections/{id}
Atualizar conexão PATCH /api/connections/{id}
Excluir conexão DELETE /api/connections/{id}
Testar conexão POST /api/connections/{id}/test
Conectar uma conexão POST /api/connections/{id}/connect
Concluir o consentimento de uma conexão da Microsoft GET /oauth/connections/microsoft/callback
Concluir o consentimento de uma conexão do Google GET /oauth/connections/google/callback

Eventos duráveis do projeto

2 operações com seus parâmetros, modelos de solicitação e respostas.

Listar eventos GET /api/events
Eventos do fluxo GET /stream/project

Notificações: avisos por e-mail e por webhook assinado sobre mudanças de estado da tela

13 operações com seus parâmetros, modelos de solicitação e respostas.

Listar notificações GET /api/notifications
Criar notificação POST /api/notifications
Obter notificação GET /api/notifications/{id}
Atualizar notificação PATCH /api/notifications/{id}
Excluir notificação DELETE /api/notifications/{id}
Rotacionar segredo da notificação POST /api/notifications/{id}/rotate-secret
Testar notificação POST /api/notifications/{id}/test
Listar entregas da notificação GET /api/notifications/{id}/deliveries
Listar tentativas de entrega da notificação GET /api/notifications/{id}/deliveries/{delivery_id}/attempts
Reinscrever uma pessoa em uma notificação DELETE /api/notifications/{id}/unsubscribed/{user_id}
Mostrar o cancelamento de inscrição em uma notificação GET /api/notifications/unsubscribe
Cancelar a inscrição em uma notificação POST /api/notifications/unsubscribe
Reinscrever-se em uma notificação POST /api/notifications/resubscribe

Alertas: problemas de tela abertos, reconhecimento, adiamento e silenciamentos

6 operações com seus parâmetros, modelos de solicitação e respostas.

Listar alertas GET /api/alerts
Obter alerta GET /api/alerts/{id}
Reconhecer alerta POST /api/alerts/{id}/acknowledge
Listar silenciamentos de alerta GET /api/alert-mutes
Criar silenciamento de alerta POST /api/alert-mutes
Excluir silenciamento de alerta DELETE /api/alert-mutes/{id}

Relatórios: resumos por pasta e tag, arquivos CSV, XLSX e PDF e programações de e-mail

8 operações com seus parâmetros, modelos de solicitação e respostas.

Listar os tipos de relatório GET /api/reports
Obter um relatório GET /api/reports/{kind}
Listar as assinaturas de relatórios GET /api/report-subscriptions
Criar assinatura de relatório POST /api/report-subscriptions
Obter uma assinatura de relatório GET /api/report-subscriptions/{id}
Atualizar uma assinatura de relatório PATCH /api/report-subscriptions/{id}
Excluir assinatura de relatório DELETE /api/report-subscriptions/{id}
Enviar uma assinatura de relatório POST /api/report-subscriptions/{id}/send

Registro de auditoria: cada alteração de configuração com seu antes e depois, uma cadeia de hashes para verificar e exportação em CSV, XLSX e PDF

4 operações com seus parâmetros, modelos de solicitação e respostas.

Listar o registro de auditoria GET /api/audit
Obter o cabeçalho de auditoria GET /api/audit/head
Verificar o registro de auditoria GET /api/audit/verify
Obter uma entrada de auditoria GET /api/audit/{id}

Webhooks: entrega de eventos assinados

9 operações com seus parâmetros, modelos de solicitação e respostas.

Listar webhooks GET /api/webhooks
Criar webhook POST /api/webhooks
Obter webhook GET /api/webhooks/{id}
Atualizar webhook PATCH /api/webhooks/{id}
Excluir webhook DELETE /api/webhooks/{id}
Rotacionar segredo do webhook POST /api/webhooks/{id}/rotate-secret
Testar webhook POST /api/webhooks/{id}/test
Listar entregas de webhook GET /api/webhooks/{id}/deliveries
Listar tentativas de entrega de webhook GET /api/webhooks/{id}/deliveries/{delivery_id}/attempts

Gatilhos de alerta CAP

12 operações com seus parâmetros, modelos de solicitação e respostas.

Listar gatilhos GET /api/triggers
Criar gatilho POST /api/triggers
Obter gatilho GET /api/triggers/{id}
Atualizar um gatilho PATCH /api/triggers/{id}
Excluir gatilho DELETE /api/triggers/{id}
Rotacionar segredo do gatilho POST /api/triggers/{id}/rotate-secret
Testar gatilho POST /api/triggers/{id}/test
Limpar gatilho POST /api/triggers/{id}/clear
Receber Trigger CAP POST /api/triggers/{id}/cap
Receber um envio de gatilho de sobreposição POST /api/triggers/{id}/overlay
Head Trigger Overlay HEAD /api/triggers/{id}/overlay
Listar as entregas de um gatilho GET /api/triggers/{id}/deliveries

Agregados de reprodução

4 operações com seus parâmetros, modelos de solicitação e respostas.

Listar agregados de reprodução GET /api/playback
Listar execuções de reprodução GET /api/playback/plays
Obter totais de reprodução GET /api/playback/totals
Obter completude da reprodução GET /api/playback/completeness

Feedback: bugs e solicitações de recursos

6 operações com seus parâmetros, modelos de solicitação e respostas.

Listar relatórios de bugs GET /api/feedback/bugs
Relatar bug POST /api/feedback/bugs
Listar solicitações de recursos GET /api/feedback/features
Solicitar recurso POST /api/feedback/features
Obter tópico de feedback GET /api/feedback/{id}
Responder à thread de feedback POST /api/feedback/{id}/responses

Suporte

9 operações com seus parâmetros, modelos de solicitação e respostas.

Enviar uma mensagem de contato pelo site POST /website/support-messages
Status do suporte GET /api/support/status
Listar conversas de suporte GET /api/support/conversations
Criar conversa de suporte POST /api/support/conversations
Listar mensagens de suporte GET /api/support/conversations/{id}/messages
Responder à conversa de suporte POST /api/support/conversations/{id}/messages
Leia conversa de suporte PUT /api/support/conversations/{id}/read
Fechar conversa de suporte POST /api/support/conversations/{id}/close
Mensagens de suporte do fluxo GET /stream/support

Solicitações e reservas de demonstração do site

7 operações com seus parâmetros, modelos de solicitação e respostas.

Enviar solicitação de demonstração do site POST /website/demo-requests
Obter solicitação de demonstração do site GET /website/demo-request
Obter calendário de demonstração do site GET /website/demo-calendar
Obter horários de demonstração do site GET /website/demo-slots
Agendar demonstração do site POST /website/demo-bookings
Solicitar revisão de demonstração do site POST /website/demo-review
Convite para demonstração do site Exchange POST /website/demo-session

Transferência do navegador da página inicial

6 operações com seus parâmetros, modelos de solicitação e respostas.

Reivindicar link do navegador POST /api/project/browser-links/claim
Obter status do link do navegador GET /screen/browser-links
Iniciar link do navegador POST /screen/browser-links
Eventos de link do navegador do fluxo GET /stream/browser-links/events
Continuar link do navegador GET /screen/browser-links/continue
Obter página de configuração do link do navegador GET /setup

Códigos de configuração do site

1 operação com seus parâmetros, seu modelo de solicitação e suas respostas.

Obter o código de configuração do visitante POST /website/setup-codes

Pareamento e sessões do Player

12 operações com seus parâmetros, modelos de solicitação e respostas.

Iniciar sessão de pareamento POST /screen/pairing-sessions
Eventos de pareamento do fluxo GET /stream/pairing-events
Concluir sessão de pareamento POST /screen/pairing-sessions/complete
Criar sessão de tempo de execução anônima POST /screen/sessions
Criar sessão de tempo de execução do dispositivo POST /screen/device-sessions
Iniciar sessão de pareamento nativa POST /screen/native/pairing-sessions
Eventos nativos de pareamento do fluxo GET /stream/native/pairing-events
Concluir sessão de pareamento nativo POST /screen/native/pairing-sessions/complete
Criar desafio de identidade nativa POST /screen/native/identity/challenges
Criar sessão de tempo de execução de identidade nativa POST /screen/native/identity/sessions
Criar sessão de execução do link da tela POST /screen/link-sessions
Redefinir identidade nativa POST /screen/native/identity/reset

Manifesto, relatórios e eventos de tempo de execução

24 operações com seus parâmetros, modelos de solicitação e respostas.

Provisionamento do navegador Exchange POST /screen/browser-provisioning/exchanges
Obter runtime Chrome GET /screen/chrome
Obter manifesto de runtime GET /screen/manifest
Eventos de runtime do fluxo GET /stream/events
Criar relatório de tempo de execução POST /screen/reports
Colocar captura de tela do tempo de execução PUT /screen/screenshot
Resolver Adslots POST /screen/adslots/resolve
Relatar eventos de espaço publicitário POST /screen/adslots/events
Colocar observação do tempo de execução PUT /screen/observation
Colocar saúde do tempo de execução PUT /screen/health
Colocar armazenamento do tempo de execução PUT /screen/storage
Colocar status do tempo de execução PUT /screen/status
Colocar etiqueta da tela do tempo de execução PUT /screen/screen-label
Enviar resultado de comando de runtime POST /screen/commands/{command_id}/result
Entrar na sessão ao vivo POST /screen/live/{live_id}/join
Oferta da sessão ao vivo POST /screen/live/{live_id}/offer
Sinal de vida da sessão ao vivo POST /screen/live/{live_id}/heartbeat
Sessão ao vivo parada POST /screen/live/{live_id}/stopped
Obter playlists de tela de runtime GET /screen/playlists
Colocar playlist da tela do tempo de execução PUT /screen/playlist
Desparear Runtime POST /screen/unpair
Lançar versão do aplicativo POST /screen/manifests/{manifest_revision}/releases/{release_id}/launch
Resolver todos os seletores de mídia dinâmicos para um loop de playlist POST /screen/manifests/{manifest_revision}/selectors/resolve
Obter dados do cartão de runtime GET /screen/card-data/{key}

K/V de aplicativo em tempo de execução

4 operações com seus parâmetros, modelos de solicitação e respostas.

Listar KV em tempo de execução GET /screen/apps/{application_id}/kv
Obter runtime KV GET /screen/apps/{application_id}/kv/{key}
Colocar KV do tempo de execução PUT /screen/apps/{application_id}/kv/{key}
Excluir KV de runtime DELETE /screen/apps/{application_id}/kv/{key}

Conteúdo protegido e ativos de lançamento

8 operações com seus parâmetros, modelos de solicitação e respostas.

Obter conteúdo de decisão de anúncio GET /screen/ad-decisions/{decision_id}
Conteúdo de decisão de anúncio principal HEAD /screen/ad-decisions/{decision_id}
Obter mídia protegida estável GET /media/{media_id}
Mídia protegida estável principal HEAD /media/{media_id}
Obter mídia protegida GET /media/manifests/{manifest_revision}/{media_id}
Obter pacote de app web nativo GET /screen/manifests/{manifest_revision}/releases/{release_id}/package
Pacote de app web nativo principal HEAD /screen/manifests/{manifest_revision}/releases/{release_id}/package
Consumir Ticket de Lançamento ou Obter Ativo de Versão GET /{asset_path}

Painel de pessoas e projetos

94 operações com seus parâmetros, modelos de solicitação e respostas.

Inspecionar convite do Dashboard POST /api/invitations/inspect
Iniciar convite de painel Passkey POST /api/invitations/passkey-options
Verificar e-mail de convite do Dashboard POST /api/invitations/email-verifications
Obter inscrição de convite do dashboard GET /api/invitations/signup
Aceitar convite do dashboard POST /api/invitations/accept
Iniciar passkey de cadastro do dashboard POST /api/signups/passkey-options
Criar cadastro no dashboard POST /api/signups
Trocar projeto do dashboard PUT /api/session/project
Listar membros no dashboard GET /api/members
Remover membro do Dashboard DELETE /api/members/{user_id}
Listar atividade dos membros GET /api/members/{user_id}/activity
Obter dados do usuário do dashboard GET /api/me
Excluir eu do dashboard DELETE /api/me
Iniciar reautenticação do painel POST /api/me/reauthentications
Definir senha do dashboard PUT /api/me/password
Listar passkeys no dashboard GET /api/me/passkeys
Iniciar registro Passkey do painel POST /api/me/passkeys/options
Concluir registro de passkey do Dashboard POST /api/me/passkeys/complete
Renomear passkey do dashboard PATCH /api/me/passkeys/{id}
Excluir passkey do dashboard DELETE /api/me/passkeys/{id}
Obter e-mail do dashboard GET /api/me/email
Alterar e-mail do Dashboard POST /api/me/email/change
Solicitar verificação de e-mail do dashboard POST /api/me/email/verification
Colocar perfil de cadastro do dashboard PUT /api/me/signup-profile
Obter uso de aplicativo do dashboard GET /api/applications/{id}/usage
Colocar inventário de publicidade do painel POST /api/advertising/inventory/{screen_id}
Obter uso de mídia do dashboard GET /api/media/{id}/usage
Obter miniatura de mídia do dashboard GET /api/media/{id}/thumbnail
Miniatura de mídia do painel principal HEAD /api/media/{id}/thumbnail
Verificação de e-mail do painel Peek GET /api/email/verify
Verificar e-mail do Dashboard POST /api/email/verify
Iniciar afirmação Passkey do painel POST /api/webauthn/assertions
Concluir afirmação de passkey do Dashboard POST /api/webauthn/assertions/complete
Criar sessão do dashboard POST /api/sessions
Obter sessão do dashboard GET /api/session
Sair da sessão do Dashboard POST /api/logout
Registrar etapa de onboarding POST /api/onboarding/steps
Listar agentes no dashboard GET /api/agents
Listar eventos de agentes no dashboard GET /api/agents/{id}/events
Desconectar agente do dashboard POST /api/agents/{id}/disconnect
Listar notas de agentes no dashboard GET /api/agents/{id}/notes
Resolver nota do agente do dashboard POST /api/agents/{id}/notes/{note_id}/resolve
Excluir nota do agente do dashboard DELETE /api/agents/{id}/notes/{note_id}
Listar conexões de agentes no dashboard GET /api/agent-connections/pending
Pesquisar conexão do agente no Dashboard POST /api/agent-connections/lookup
Obter conexão do agente do dashboard GET /api/agent-connections/{id}
Aprovar conexão do agente no dashboard POST /api/agent-connections/{id}/approve
Negar conexão do agente do Dashboard POST /api/agent-connections/{id}/deny
Obter boot do dashboard GET /api/dashboard/boot
Obter resumo do dashboard GET /api/summary
Obter status de pagamento do dashboard GET /api/billing/payout-status
Obter recibo do dashboard GET /api/billing/receipts/{id}
Obter saldo do dashboard GET /api/balance
Criar pré-visualização de aplicativo do dashboard POST /api/applications/{id}/preview-launches
Obter organização do dashboard GET /api/organizations/{org_id}
Dashboard Organizações Projetos GET /api/organizations/{org_id}/projects
Listar revendedores no dashboard GET /api/resellers
Registrar revendedor POST /api/resellers
Obter revendedor do dashboard GET /api/resellers/{reseller_id}
Listar clientes de revendedor no dashboard GET /api/resellers/{reseller_id}/customers
Criar cliente de revendedor do dashboard POST /api/resellers/{reseller_id}/customers
Obter cliente de revendedor do dashboard GET /api/resellers/{reseller_id}/customers/{org_id}
Definir plano de cliente de revendedor do dashboard PUT /api/resellers/{reseller_id}/customers/{org_id}/plan
Listar projetos de clientes de revendedor no dashboard GET /api/resellers/{reseller_id}/customers/{org_id}/projects
Entrar em projeto de cliente de revendedor do dashboard POST /api/resellers/{reseller_id}/customers/{org_id}/projects/{project_id}/access
Obter extrato de revendedor do dashboard GET /api/resellers/{reseller_id}/statement
Encerrar revendedor da organização do dashboard DELETE /api/organizations/{org_id}/reseller
Dashboard Organizações Descoberta GET /api/organizations/{org_id}/discovery
Dashboard Organizações Iniciar Domínio POST /api/organizations/{org_id}/domain-challenges
Dashboard Organizações Verificar Domínio POST /api/organizations/{org_id}/domain-verification
Dashboard Organizações Administradores GET /api/organizations/{org_id}/admins
Dashboard Organizações Definir Administradores PUT /api/organizations/{org_id}/admins
Dashboard Organizações Pessoas GET /api/organizations/{org_id}/people
Dashboard Organizações Listar Convites de Administrador GET /api/organizations/{org_id}/admin-invitations
Dashboard Organizações Criar Convites de Administrador POST /api/organizations/{org_id}/admin-invitations
Dashboard Organizações Revogar Convite de Administrador POST /api/organizations/{org_id}/admin-invitations/{invitation_id}/revoke
Dashboard Organizações Listar Convites de Membro GET /api/organizations/{org_id}/member-invitations
Dashboard Organizações Criar Convites de Membro POST /api/organizations/{org_id}/member-invitations
Dashboard Organizações Revogar Convite de Membro POST /api/organizations/{org_id}/member-invitations/{invitation_id}/revoke
Dashboard Organizações Remover Membro DELETE /api/organizations/{org_id}/members/{user_id}
Dashboard Organizações Definir Política de Convidados PUT /api/organizations/{org_id}/guest-policy
Dashboard Organizações Definir Biblioteca PUT /api/organizations/{org_id}/library
Dashboard Organizações Definir Acesso ao Projeto POST /api/organizations/{org_id}/project-access
Dashboard Organizações Entrar em Projeto POST /api/organizations/{org_id}/projects/{project_id}/access
Dashboard Organizações Definir Proprietário do Projeto PUT /api/organizations/{org_id}/projects/{project_id}/owner
Dashboard Organizações Remover Membro do Projeto DELETE /api/organizations/{org_id}/projects/{project_id}/members/{user_id}
Dashboard Organizações Remover Um Domínio DELETE /api/organizations/{org_id}/domains/{domain}
Definir aprovador de membro do dashboard PUT /api/members/{user_id}/approver
Definir escopo de telas de membro do dashboard PUT /api/members/{user_id}/screen-scope
Limpar escopo de telas de membro do dashboard DELETE /api/members/{user_id}/screen-scope
Definir escopo de telas de agente do dashboard PUT /api/agents/{id}/screen-scope
Limpar escopo de telas de agente do dashboard DELETE /api/agents/{id}/screen-scope
Definir escopo de upload de membro do dashboard PUT /api/members/{user_id}/upload-scope
Limpar escopo de upload de membro do dashboard DELETE /api/members/{user_id}/upload-scope

Ciclo de vida da API, desativações e limites de taxa

Famílias de URL são /api, /screen, /stream, /media, /website, /agentid. Alterações compatíveis dentro de um major:

Endpoints e métodos aditivos.
Membros opcionais da solicitação.
Novos códigos de problema.
Novos campos somente onde o esquema publicado permite campos desconhecidos.
Remover uma operação que apenas responde um erro, ou que nenhum cliente chama.
Remover um campo de resposta que nenhum cliente utiliza.

Essas mudanças exigem uma nova major:

Remoção ou renomeação de uma rota ou campo funcional que clientes chamam.
Tipo, significado ou alterações de autorização.
Tornando entrada opcional obrigatória.
Adicionando um membro a um enum fechado.
Adicionando um campo a um objeto de resposta fechado.

Uma nova versão major sobrepõe por pelo menos 180 dias. O aviso de descontinuação é de pelo menos 90 dias, e uma operação obsoleta permanece disponível por pelo menos 90 dias a partir da data efetiva da Depreciação RFC 9745, a menos que um compromisso publicado posterior controle.

Nenhuma operação está atualmente obsoleta.

Sinais do ciclo de vida são:

OpenAPI deprecated true on the operation.
Descontinuação RFC 9745 com sua data efetiva.
Encerramento RFC 8594 uma vez que a data de encerramento esteja fixa.
Link com rel=deprecation para documentação de migração.

Campos de limite de taxa

Operações com controles de janela fixa divulgados declaram x-rate-limit-policies. Respostas admitidas elegíveis podem incluir os membros opcionais da lista de campos estruturados RateLimit-Policy e RateLimit. Repetições exatas e implantações sem admissão compartilhada podem omiti-los. Negativas de janela fixa os incluem; negativas de concorrência e orçamento de bytes podem omiti-los. Esses campos seguem draft-ietf-httpapi-ratelimit-headers-11, um Internet-Draft e não um RFC. Em cada 429, Retry-After é autoritativo.

Problemas RFC 9457

Erros usam application/problem+json. Ramificam em status e estável code; tratam detail como explicação. Gerado a partir de problems.yaml.

project_required

400 · Selecione um projeto

tipo: https://screenrig.ai/problems/project-required

free_organization_limit

409 · Limite de organização gratuita atingido

tipo: https://screenrig.ai/problems/free-organization-limit

organization_plan_required

409 · Organização precisa de um plano antes de admitir telas

tipo: https://screenrig.ai/problems/organization-plan-required

project_name_conflict

409 · Nome do projeto já usado na organização

tipo: https://screenrig.ai/problems/project-name-conflict

project_delete_blocked

409 · Projeto não pode ser excluído no estado atual

tipo: https://screenrig.ai/problems/project-delete-blocked

owner_required

409 · Uma pessoa responsável é necessária

tipo: https://screenrig.ai/problems/owner-required

owner_cannot_leave

409 · Proprietário do projeto não pode sair

tipo: https://screenrig.ai/problems/owner-cannot-leave

internal_error

500 · Erro interno do servidor

tipo: https://screenrig.ai/problems/internal-error

invalid_request

400 · Solicitação inválida

tipo: https://screenrig.ai/problems/invalid-request

unauthorized

401 · Autenticação é necessária

tipo: https://screenrig.ai/problems/unauthorized

credential_retired

401 · Credencial foi aposentada

tipo: https://screenrig.ai/problems/credential-retired

client_update_required

410 · Atualize o plugin ou CLI do screenRIG

tipo: https://screenrig.ai/problems/client-update-required

forbidden

403 · Solicitação não permitida

tipo: https://screenrig.ai/problems/forbidden

insufficient_access

403 · Este nível de acesso não pode fazer isso

tipo: https://screenrig.ai/problems/insufficient-access

outside_upload_scope

403 · Fora das playlists e pastas deste uploader

tipo: https://screenrig.ai/problems/outside-upload-scope

outside_screen_scope

403 · Fora das telas deste membro

tipo: https://screenrig.ai/problems/outside-screen-scope

protected_target

409 · Uma tela protegida não é alterada desta forma

tipo: https://screenrig.ai/problems/protected-target

second_approver_required

403 · É preciso um segundo aprovador para decidir esta revisão

tipo: https://screenrig.ai/problems/second-approver-required

reserved_item

403 · Esta campanha está reservada

tipo: https://screenrig.ai/problems/reserved-item

approver_required

403 · Apenas um aprovador pode fazer isso

tipo: https://screenrig.ai/problems/approver-required

review_not_pending

409 · Revisão não está mais pendente

tipo: https://screenrig.ai/problems/review-not-pending

review_stale

409 · O alvo mudou depois desta proposta

tipo: https://screenrig.ai/problems/review-stale

review_blocked

409 · Outra revisão deve ser decidida primeiro

tipo: https://screenrig.ai/problems/review-blocked

playlist_not_approved

409 · Playlist não tem versão aprovada

tipo: https://screenrig.ai/problems/playlist-not-approved

media_pending_review

409 · Item de mídia está aguardando revisão de uma pessoa

tipo: https://screenrig.ai/problems/media-pending-review

media_sync_source_refused

409 · A origem da sincronização de mídia recusou a requisição

tipo: https://screenrig.ai/problems/media-sync-source-refused

media_sync_source_unavailable

500 · Não foi possível acessar a origem da sincronização de mídia

tipo: https://screenrig.ai/problems/media-sync-source-unavailable

canva_not_configured

409 · O Canva não está configurado

tipo: https://screenrig.ai/problems/canva-not-configured

canva_reconnect_required

409 · A conta do Canva precisa ser conectada

tipo: https://screenrig.ai/problems/canva-reconnect-required

dropbox_not_configured

409 · O Dropbox não está configurado

tipo: https://screenrig.ai/problems/dropbox-not-configured

dropbox_reconnect_required

409 · A conta do Dropbox precisa ser conectada

tipo: https://screenrig.ai/problems/dropbox-reconnect-required

google_drive_not_configured

409 · O Google Drive não está configurado

tipo: https://screenrig.ai/problems/google-drive-not-configured

media_sync_sharer_not_member

403 · A pasta não foi compartilhada por um membro do projeto

tipo: https://screenrig.ai/problems/media-sync-sharer-not-member

not_found

404 · Recurso não encontrado

tipo: https://screenrig.ai/problems/not-found

method_not_allowed

405 · Método não permitido

tipo: https://screenrig.ai/problems/method-not-allowed

idempotency_mismatch

409 · Chave de idempotência não corresponde à solicitação original

tipo: https://screenrig.ai/problems/idempotency-mismatch

credential_issuance_expired

410 · Emissão de credencial expirou

tipo: https://screenrig.ai/problems/credential-issuance-expired

user_email_conflict

409 · Endereço de e-mail pertence a outra pessoa

tipo: https://screenrig.ai/problems/user-email-conflict

provisioning_invalid

404 · Provisionamento do navegador inválido

tipo: https://screenrig.ai/problems/provisioning-invalid

provisioning_expired

410 · Provisionamento do navegador expirou

tipo: https://screenrig.ai/problems/provisioning-expired

provisioning_consumed

409 · Provisionamento do navegador consumido

tipo: https://screenrig.ai/problems/provisioning-consumed

provisioning_exchange_mismatch

409 · Troca de provisionamento do navegador incompatível

tipo: https://screenrig.ai/problems/provisioning-exchange-mismatch

browser_already_paired

409 · Navegador já pareado

tipo: https://screenrig.ai/problems/browser-already-paired

handoff_code_invalid

404 · Código de transferência do navegador inválido

tipo: https://screenrig.ai/problems/handoff-code-invalid

handoff_code_expired

410 · Código de transferência do navegador expirou

tipo: https://screenrig.ai/problems/handoff-code-expired

handoff_session_rate_limited

429 · Sessão de transferência do navegador com limite de taxa

tipo: https://screenrig.ai/problems/handoff-session-rate-limited

handoff_session_conflict

409 · Conflito de sessão de transferência do navegador

tipo: https://screenrig.ai/problems/handoff-session-conflict

browser_link_not_claimed

409 · Link do navegador não reivindicado

tipo: https://screenrig.ai/problems/browser-link-not-claimed

browser_link_project_mismatch

403 · Projeto do link do navegador não corresponde

tipo: https://screenrig.ai/problems/browser-link-project-mismatch

origin_not_allowed

403 · Origem não permitida

tipo: https://screenrig.ai/problems/origin-not-allowed

resource_conflict

409 · Estado do recurso conflita com a solicitação

tipo: https://screenrig.ai/problems/resource-conflict

card_not_found

404 · Cartão não encontrado

tipo: https://screenrig.ai/problems/card-not-found

card_invalid

400 · Posicionamento do cartão inválido

tipo: https://screenrig.ai/problems/card-invalid

card_layout_invalid

400 · Layout do cartão inválido

tipo: https://screenrig.ai/problems/card-layout-invalid

card_layout_conflict

400 · Cartões na página reivindicam o mesmo lugar

tipo: https://screenrig.ai/problems/card-layout-conflict

card_data_invalid

409 · Documento de dados do cartão não cabe em um cartão que o lê

tipo: https://screenrig.ai/problems/card-data-invalid

source_limit_reached

409 · Organização atingiu o máximo de fontes de dados

type: https://screenrig.ai/problems/source-limit-reached

source_target_unsupported

422 · A fonte de dados não pode preencher este cartão

type: https://screenrig.ai/problems/source-target-unsupported

source_target_taken

409 · Outra fonte de dados já preenche este cartão

type: https://screenrig.ai/problems/source-target-taken

source_busy

409 · Uma sincronização da fonte de dados está em andamento

type: https://screenrig.ai/problems/source-busy

source_has_no_rooms

409 · Este tipo de fonte de dados não oferece salas

type: https://screenrig.ai/problems/source-has-no-rooms

source_secret_required

400 · Um segredo da fonte de dados está ausente ou não é mais válido

type: https://screenrig.ai/problems/source-secret-required

source_test_failed

422 · A prévia da fonte de dados falhou

type: https://screenrig.ai/problems/source-test-failed

connection_app_not_configured

409 · O aplicativo do screenRIG não está configurado para este provedor

tipo: https://screenrig.ai/problems/connection-app-not-configured

connection_limit_reached

409 · Organização atingiu o máximo de conexões

tipo: https://screenrig.ai/problems/connection-limit-reached

card_media_invalid

400 · Referência de mídia do cartão não nomeia uma imagem pronta

tipo: https://screenrig.ai/problems/card-media-invalid

revision_conflict

412 · Revisão do recurso não corresponde

tipo: https://screenrig.ai/problems/revision-conflict

invalid_range

416 · Intervalo de bytes solicitado não é satisfatório

tipo: https://screenrig.ai/problems/invalid-range

quota_exceeded

413 · Cota de conteúdo do projeto excedida

tipo: https://screenrig.ai/problems/quota-exceeded

payment_required

402 · Crédito de uso é necessário

tipo: https://screenrig.ai/problems/payment-required

reseller_generation_limit

402 · Limite de geração de imagens do revendedor atingido

tipo: https://screenrig.ai/problems/reseller-generation-limit

feature_not_in_plan

402 · Este recurso não está no plano do projeto

tipo: https://screenrig.ai/problems/feature-not-in-plan

rate_limited

429 · Taxa de solicitação muito alta

tipo: https://screenrig.ai/problems/rate-limited

revocation_unavailable

500 · Estado de revogação da credencial indisponível

tipo: https://screenrig.ai/problems/revocation-unavailable

dependency_unavailable

500 · Dependência necessária está indisponível

tipo: https://screenrig.ai/problems/dependency-unavailable

dependency_timeout

500 · Dependência necessária não respondeu a tempo

tipo: https://screenrig.ai/problems/dependency-timeout

schema_incompatible

500 · Esquema do banco de dados é incompatível

tipo: https://screenrig.ai/problems/schema-incompatible

not_ready

500 · Serviço não está pronto

tipo: https://screenrig.ai/problems/not-ready

server_draining

421 · Serviço está drenando

tipo: https://screenrig.ai/problems/server-draining

manifest_degraded

500 · Projeção do manifesto em tempo de execução está degradada

tipo: https://screenrig.ai/problems/manifest-degraded

screenshot_unavailable

409 · Captura de tela não está disponível

tipo: https://screenrig.ai/problems/screenshot-unavailable

identity_invalid

400 · Chave pública do player inválida

tipo: https://screenrig.ai/problems/identity-invalid

identity_conflict

409 · Chave pública do player não corresponde à inscrição

tipo: https://screenrig.ai/problems/identity-conflict

enrollment_bound

409 · Chave pública do player já está vinculada a um projeto

tipo: https://screenrig.ai/problems/enrollment-bound

proof_invalid

401 · Prova de identidade do player inválida

tipo: https://screenrig.ai/problems/proof-invalid

screen_archived

409 · Tela está arquivada

tipo: https://screenrig.ai/problems/screen-archived

screen_archive_required

409 · Arquive a tela em vez de excluí-la ou desvinculá-la

tipo: https://screenrig.ai/problems/screen-archive-required

passkey_invalid

401 · Cerimônia de passkey inválida

tipo: https://screenrig.ai/problems/passkey-invalid

passkey_unknown

401 · Esta passkey não está mais registrada

tipo: https://screenrig.ai/problems/passkey-unknown

passkeys_disabled

403 · Passkeys estão desativadas neste servidor

tipo: https://screenrig.ai/problems/passkeys-disabled

application_in_use

409 · Um manifesto ativo ainda referencia uma versão do aplicativo

tipo: https://screenrig.ai/problems/application-in-use

agent_connection_invalid

404 · Conexão do agente inválida

tipo: https://screenrig.ai/problems/agent-connection-invalid

agent_connection_code_mismatch

400 · O código não corresponde a este login

tipo: https://screenrig.ai/problems/agent-connection-code-mismatch

agent_connection_expired

410 · Conexão do agente expirou

tipo: https://screenrig.ai/problems/agent-connection-expired

agent_connection_conflict

409 · Conexão do agente já resolvida

tipo: https://screenrig.ai/problems/agent-connection-conflict

agent_connection_not_approved

409 · Conexão do agente não aprovada

tipo: https://screenrig.ai/problems/agent-connection-not-approved

agent_limit_exceeded

409 · Limite de agentes excedido

tipo: https://screenrig.ai/problems/agent-limit-exceeded

agent_lockout_risk

409 · Desconectar o último agente ativo pode causar bloqueio

tipo: https://screenrig.ai/problems/agent-lockout-risk

recovery_ambiguous

409 · Identificador do dispositivo está vinculado a mais de uma tela

tipo: https://screenrig.ai/problems/recovery-ambiguous

recovery_expired

410 · Oferta de recuperação da tela expirou

tipo: https://screenrig.ai/problems/recovery-expired

recovery_not_offered

404 · Nenhuma recuperação de tela pendente

tipo: https://screenrig.ai/problems/recovery-not-offered

invitation_limit_reached

409 · Organização atingiu o máximo de convites pendentes

tipo: https://screenrig.ai/problems/invitation-limit-reached

organization_admin_limit

409 · Limite de administradores da organização atingido

tipo: https://screenrig.ai/problems/organization-admin-limit

library_no_screens

409 · Um projeto com telas não pode ser a Biblioteca

tipo: https://screenrig.ai/problems/library-no-screens

guest_not_allowed

403 · A organização não admite esta pessoa como convidado

tipo: https://screenrig.ai/problems/guest-not-allowed

managed_member

409 · Um provedor de identidade gerencia esta pessoa

tipo: https://screenrig.ai/problems/managed-member

organization_admin_member

409 · Este membro é um administrador da organização

tipo: https://screenrig.ai/problems/organization-admin-member

member_owns_projects

409 · Este membro é proprietário de projetos na organização

tipo: https://screenrig.ai/problems/member-owns-projects

managed_elsewhere

409 · Outra organização gerencia esta pessoa

tipo: https://screenrig.ai/problems/managed-elsewhere

version_required

409 · Playlist requer uma versão mais recente da API

tipo: https://screenrig.ai/problems/version-required

price_change_pending

409 · Campanha está pausada até que novas tarifas sejam aceitas

tipo: https://screenrig.ai/problems/price-change-pending

quote_stale

409 · Cotação de publicidade está desatualizada ou expirada

tipo: https://screenrig.ai/problems/quote-stale

insufficient_credits

402 · Créditos elegíveis são insuficientes

tipo: https://screenrig.ai/problems/insufficient-credits

self_deal

409 · Um projeto não pode comprar publicidade em sua própria rede

tipo: https://screenrig.ai/problems/self-deal

goal_overbooked

409 · A meta é maior que as reproduções disponíveis

tipo: https://screenrig.ai/problems/goal-overbooked

invitation_invalid

404 · Convite inválido

tipo: https://screenrig.ai/problems/invitation-invalid

invitation_expired

410 · Convite expirou

tipo: https://screenrig.ai/problems/invitation-expired

invitation_consumed

409 · Convite já foi aceito

tipo: https://screenrig.ai/problems/invitation-consumed

invitation_email_mismatch

403 · Convite pertence a um endereço de e-mail diferente

tipo: https://screenrig.ai/problems/invitation-email-mismatch

reauthentication_required

401 · Prova de login recente é necessária

tipo: https://screenrig.ai/problems/reauthentication-required

member_limit_reached

409 · Projeto atingiu o máximo de membros

tipo: https://screenrig.ai/problems/member-limit-reached

project_limit_reached

409 · Organização atingiu o máximo de projetos

type: https://screenrig.ai/problems/project-limit-reached

billed_by_reseller

409 · A organização é cobrada por meio do seu revendedor

tipo: https://screenrig.ai/problems/billed-by-reseller

reseller_conflict

409 · A organização não pode assumir esse papel de revendedor

tipo: https://screenrig.ai/problems/reseller-conflict

last_credential

409 · Último método de login não pode ser removido

tipo: https://screenrig.ai/problems/last-credential

sso_required

403 · Este endereço faz login pelo seu provedor de identidade

tipo: https://screenrig.ai/problems/sso-required

no_project

409 · Nenhum projeto atual selecionado

tipo: https://screenrig.ai/problems/no-project

feature_unavailable

404 · Este recurso não está disponível neste servidor

tipo: https://screenrig.ai/problems/feature-unavailable

user_binding_stale

409 · Vinculação de e-mail do usuário que reivindica está desatualizada

tipo: https://screenrig.ai/problems/user-binding-stale

session_expired

401 · Sessão de runtime expirou ou não está mais atual

tipo: https://screenrig.ai/problems/session-expired

credential_revoked

401 · Credencial do dispositivo não vincula mais este dispositivo a uma tela

tipo: https://screenrig.ai/problems/credential-revoked

screen_link_invalid

401 · Link da tela é inválido

tipo: https://screenrig.ai/problems/screen-link-invalid

screen_link_not_found

404 · Tela não tem link

tipo: https://screenrig.ai/problems/screen-link-not-found

proof_clock_skew

401 · Prova de identidade do player está fora da janela de tempo aceita

tipo: https://screenrig.ai/problems/proof-clock-skew

key_retired

401 · Chave do player foi substituída e sua janela de tolerância foi encerrada

tipo: https://screenrig.ai/problems/key-retired

assignment_not_found

404 · Tela não tem atribuição de playlist

tipo: https://screenrig.ai/problems/assignment-not-found

upgrade_required

403 · Versão do player está abaixo do mínimo suportado

tipo: https://screenrig.ai/problems/upgrade-required

reboot_unsupported

409 · Tela não pode reiniciar remotamente

tipo: https://screenrig.ai/problems/reboot-unsupported

command_unsupported

409 · Tela não pode fazer isso remotamente

type: https://screenrig.ai/problems/command-unsupported

play_page_unsupported

409 · Tela não pode reproduzir uma página sob solicitação

tipo: https://screenrig.ai/problems/play-page-unsupported

identify_unsupported

409 · Tela não pode se identificar

tipo: https://screenrig.ai/problems/identify-unsupported

page_not_on_screen

409 · Página não está na playlist que a tela está reproduzindo

tipo: https://screenrig.ai/problems/page-not-on-screen

live_unsupported

409 · A tela não pode exibir a visualização ao vivo

tipo: https://screenrig.ai/problems/live-unsupported

live_unavailable

409 · A visualização ao vivo não está disponível para esta tela

tipo: https://screenrig.ai/problems/live-unavailable

live_not_ready

409 · A tela ainda não está publicando

tipo: https://screenrig.ai/problems/live-not-ready

live_session_ended

410 · A sessão ao vivo terminou

tipo: https://screenrig.ai/problems/live-session-ended

wall_unsupported

409 · Tela não pode montar um videowall

tipo: https://screenrig.ai/problems/wall-unsupported

playlist_format_mismatch

409 · Formato da playlist não corresponde ao videowall da tela

tipo: https://screenrig.ai/problems/playlist-format-mismatch

primitive_locked

403 · Um elemento bloqueado só pode ser alterado por quem pode aprovar

tipo: https://screenrig.ai/problems/primitive-locked

playlist_is_template

409 · A playlist é um modelo

tipo: https://screenrig.ai/problems/playlist-is-template

webhook_limit_reached

409 · Organização atingiu o máximo de webhooks

tipo: https://screenrig.ai/problems/webhook-limit-reached

alert_not_open

409 · Alerta não está aberto

tipo: https://screenrig.ai/problems/alert-not-open

alert_mute_limit_reached

409 · Organização atingiu o máximo de silenciamentos

tipo: https://screenrig.ai/problems/alert-mute-limit-reached

notification_limit_reached

409 · Limite de notificações da organização atingido

type: https://screenrig.ai/problems/notification-limit-reached

notification_covers_other_projects

409 · Notificação cobre outros projetos

tipo: https://screenrig.ai/problems/notification-covers-other-projects

report_subscription_limit_reached

409 · Organização atingiu o máximo de assinaturas de relatórios

type: https://screenrig.ai/problems/report-subscription-limit-reached

fleet_link_limit_reached

409 · Organização atingiu o máximo de links de frota

tipo: https://screenrig.ai/problems/fleet-link-limit-reached

webhook_url_rejected

400 · URL do webhook deve ser HTTPS em um host público da Internet

tipo: https://screenrig.ai/problems/webhook-url-rejected

notification_destination_rejected

400 · O destino da notificação não é válido para o canal

tipo: https://screenrig.ai/problems/notification-destination-rejected

document_not_shared

400 · O documento pede que os espectadores façam login

type: https://screenrig.ai/problems/document-not-shared

note_contains_credential

422 · Texto da nota contém uma credencial

tipo: https://screenrig.ai/problems/note-contains-credential

note_rejected

422 · Texto da nota foi rejeitado

tipo: https://screenrig.ai/problems/note-rejected

note_not_open

409 · Nota não está aberta

tipo: https://screenrig.ai/problems/note-not-open

note_limit_reached

409 · Organização atingiu o máximo de notas abertas

tipo: https://screenrig.ai/problems/note-limit-reached

trigger_limit_reached

409 · Organização atingiu o máximo de gatilhos

tipo: https://screenrig.ai/problems/trigger-limit-reached

bi_upstream_refused

409 · O sistema de BI recusou a conexão

tipo: https://screenrig.ai/problems/bi-upstream-refused

bi_upstream_unavailable

500 · Não foi possível acessar o sistema de BI

tipo: https://screenrig.ai/problems/bi-upstream-unavailable

bi_web_unavailable

409 · Este servidor não tem renderizador de páginas

tipo: https://screenrig.ai/problems/bi-web-unavailable

schedule_import_invalid

422 · A importação tem linhas com erros

tipo: https://screenrig.ai/problems/schedule-import-invalid

schedule_import_stale

409 · O projeto mudou desde a prévia

tipo: https://screenrig.ai/problems/schedule-import-stale

campaign_limit_reached

409 · Organização atingiu o máximo de campanhas

tipo: https://screenrig.ai/problems/campaign-limit-reached

kv_webhook_limit_reached

409 · Aplicativo atingiu o máximo de webhooks chave/valor

tipo: https://screenrig.ai/problems/kv-webhook-limit-reached

support_conversation_closed

409 · Conversa de suporte está encerrada

tipo: https://screenrig.ai/problems/support-conversation-closed

submission_too_short

422 · Envio é muito curto para agir

tipo: https://screenrig.ai/problems/submission-too-short

submission_unclear

422 · Envio não descreve um problema ou solicitação

tipo: https://screenrig.ai/problems/submission-unclear

submission_rejected

422 · Envio não foi aceito

tipo: https://screenrig.ai/problems/submission-rejected

submission_screening_unavailable

500 · Envio não pode ser exibido no momento

tipo: https://screenrig.ai/problems/submission-screening-unavailable

demo_slot_unavailable

409 · Tempo de demonstração não está mais disponível

tipo: https://screenrig.ai/problems/demo-slot-unavailable

agentid_claim_invalid

400 · Reivindicação AgentID inválida ou expirada

tipo: https://screenrig.ai/problems/agentid-claim-invalid

agentid_already_enrolled

409 · AgentID já está registrado

tipo: https://screenrig.ai/problems/agentid-already-enrolled

account_exists

409 · Este e-mail já tem uma conta screenRIG

tipo: https://screenrig.ai/problems/account-exists

email_verification_required

403 · Verifique seu e-mail para continuar

tipo: https://screenrig.ai/problems/email-verification-required

unverified_account_replacement

409 · Este reset cria uma conta nova e vazia

tipo: https://screenrig.ai/problems/unverified-account-replacement

app_store_transaction_invalid

422 · Não foi possível verificar a compra na App Store

tipo: https://screenrig.ai/problems/app-store-transaction-invalid

app_store_account_mismatch

409 · A compra pertence a outra organização

tipo: https://screenrig.ai/problems/app-store-account-mismatch

education_not_eligible

403 · A organização não é elegível ao plano Education

tipo: https://screenrig.ai/problems/education-not-eligible

app_store_plan_conflict

409 · A organização já tem um plano

tipo: https://screenrig.ai/problems/app-store-plan-conflict

Diagnóstico e fonte do contrato

Os diagnósticos CLI integrados mantêm autorização, cookies, detalhes de upload assinados, identificadores de objetos e conteúdo do cliente fora dos resultados retidos. O documento bruto OpenAPI é a fonte de verdade HTTP.

Índice do esquema

Nomes gerados, campos obrigatórios e descrições do esquema; use OpenAPI bruto para JSON Schema completo.

Índice do esquema