Armazenamento do aplicativo: referência da API, endpoints e exemplos

OpenAPI YAML OpenAPI JSON problemas YAML Visão geral da API

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

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

GET/screen/apps/{application_id}/kv¶

Listar KV em tempo de execução

Retorna no máximo 200 entradas em ordem crescente de chave e não faz paginação; um namespace com mais chaves é listado parcialmente. Lista metadados para um aplicativo que o conteúdo atual da tela possui.

KV de tempo de execução é autorizado pela sessão de tempo de execução do Player (kv.read, e kv.write para gravações) e pela concessão atual da tela, que deve conter uma versão pronta do aplicativo; um cabeçalho ScreenRig-Primitive-Capability é ignorado. Frames enviados nunca chamam essas rotas e devem usar a ponte SDK pai validada.

Autenticação: runtimeCookie OU nativeSessionAuthorization
Corpo da solicitação: nenhum
ID da operação: listRuntimeKV

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
application_id	caminho	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv'

Respostas

Status	Significado	Corpo e cabeçalhos
200	KV de aplicativo autorizado pelo manifesto	Lista RuntimeKV (application/json)
padrão	Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema Runtime (application/problem+json)

GET/screen/apps/{application_id}/kv/{key}¶

Obter runtime KV

Autenticação: runtimeCookie OU nativeSessionAuthorization
Corpo da solicitação: nenhum
ID da operação: getRuntimeKV

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
application_id	caminho	obrigatório
key	caminho	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Valor KV de aplicativo autorizado pelo manifesto	Entrada RuntimeKV (application/json)
padrão	Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema Runtime (application/problem+json)

PUT/screen/apps/{application_id}/kv/{key}¶

Colocar KV do tempo de execução

Autenticação: pairedRuntimeCookie OU nativeSessionAuthorization
Corpo da solicitação: Gravação RuntimeKV
ID da operação: putRuntimeKV

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
application_id	caminho	obrigatório
key	caminho	obrigatório
If-Match	cabeçalho	opcional	Revisão positiva opcional do recurso. Omitir para criar ou sobrescrever uma chave; uma revisão obsoleta fornecida é revision_conflict.
Idempotency-Key	cabeçalho	opcional	Omitir 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

Campo	Descrição
value_base64 (obrigatório, string)	maxLength: 1398104
content_type (opcional, string)	padrão: "application/octet-stream" minLength: 1 maxLength: 127

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://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Mutação de KV do dispositivo emparelhado	Entrada RuntimeKV (application/json); cabeçalhos: RateLimit-Policy, RateLimit
padrão	Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema Runtime (application/problem+json)

EXCLUIR/screen/apps/{application_id}/kv/{key}¶

Excluir KV de runtime

Autenticação: pairedRuntimeCookie OU nativeSessionAuthorization
Corpo da solicitação: nenhum
ID da operação: deleteRuntimeKV

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
application_id	caminho	obrigatório
key	caminho	obrigatório
If-Match	cabeçalho	opcional	Revisão positiva opcional do recurso. Omitir para escrever o recurso atual; uma revisão obsoleta fornecida é revision_conflict.
Idempotency-Key	cabeçalho	opcional	Omitir 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://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'

Respostas

Status	Significado	Corpo e cabeçalhos
204	Exclusão de KV do dispositivo emparelhado	sem corpo; cabeçalhos: RateLimit-Policy, RateLimit
padrão	Resposta de problema estável RFC 9457 em runtime, conteúdo ou rota de probe voltada ao Player, no formato de documento runtime (RuntimeProblem). Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema Runtime (application/problem+json)