Referencia API

API de Almacenamiento de la aplicación

K/V de aplicación en tiempo de ejecución

Referencia HTTP. Generada a partir del contrato backend. Explore los endpoints abajo o descargue OpenAPI.

Este grupo tiene 4 operaciones, generadas a partir de api/openapi.yaml. Filtre por ruta, acción o autenticación. Cada endpoint indica sus entradas; despliéguelo para ver una plantilla de solicitud y los códigos de respuesta. Las plantillas necesitan sus propios valores y un cuerpo válido según el esquema.

Reemplace los marcadores en mayúsculas con sus valores. Para una solicitud JSON, guarde un cuerpo que coincida con el esquema en request.json. Los ejemplos de cookies usan un frasco de cookies local de una sesión autenticada.

K/V de aplicación en tiempo de ejecución

GET/screen/apps/{application_id}/kv

Listar KV de tiempo de ejecución

Devuelve como máximo 200 entradas en orden ascendente de clave y no pagina; un espacio de nombres con más claves solo se lista parcialmente. Lista metadatos para una aplicación que el contenido actual de la pantalla contiene.

El KV de tiempo de ejecución está autorizado por la sesión de tiempo de ejecución del Player (kv.read, y kv.write para escrituras) y la concesión actual de la pantalla, que debe tener una versión lista de la aplicación; se ignora un encabezado ScreenRig-Primitive-Capability. Los cuadros subidos nunca llaman a estas rutas y deben usar el puente SDK padre validado.

Autenticación
runtimeCookie O nativeSessionAuthorization
Cuerpo de la solicitud
ninguno
ID de operación
listRuntimeKV

Parámetros

NombreEnviar¿Requerido?Descripción
application_idrutarequerido
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv'

Respuestas

EstadoSignificadoCuerpo y encabezados
200KV de aplicación autorizada por manifiestoRuntimeKVList (application/json)
predeterminado

Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

RuntimeProblem (application/problem+json)
GET/screen/apps/{application_id}/kv/{key}

Obtener KV de ejecución

Autenticación
runtimeCookie O nativeSessionAuthorization
Cuerpo de la solicitud
ninguno
ID de operación
getRuntimeKV

Parámetros

NombreEnviar¿Requerido?Descripción
application_idrutarequerido
keyrutarequerido
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Valor KV de aplicación autorizada por manifiestoRuntimeKVEntry (application/json)
predeterminado

Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

RuntimeProblem (application/problem+json)
PUT/screen/apps/{application_id}/kv/{key}

Poner KV de ejecución

Autenticación
pairedRuntimeCookie O nativeSessionAuthorization
Cuerpo de la solicitud
RuntimeKVWrite
ID de operación
putRuntimeKV

Parámetros

NombreEnviar¿Requerido?Descripción
application_idrutarequerido
keyrutarequerido
If-MatchencabezadoopcionalRevisión positiva opcional de recurso. Omitir para crear o sobrescribir una clave; una revisión obsoleta suministrada es revision_conflict.
Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Campos del cuerpo de la solicitud

CampoDescripción
value_base64 (requerido, cadena)maxLength: 1398104
content_type (opcional, cadena)predeterminado: "application/octet-stream" minLength: 1 maxLength: 127
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
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'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Mutación KV de dispositivo vinculadoRuntimeKVEntry (application/json); encabezados: RateLimit-Policy, RateLimit
predeterminado

Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

RuntimeProblem (application/problem+json)
ELIMINAR/screen/apps/{application_id}/kv/{key}

Eliminar KV en tiempo de ejecución

Autenticación
pairedRuntimeCookie O nativeSessionAuthorization
Cuerpo de la solicitud
ninguno
ID de operación
deleteRuntimeKV

Parámetros

NombreEnviar¿Requerido?Descripción
application_idrutarequerido
keyrutarequerido
If-MatchencabezadoopcionalRevisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.
Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'

Respuestas

EstadoSignificadoCuerpo y encabezados
204Eliminación KV de dispositivo vinculadosin cuerpo; encabezados: RateLimit-Policy, RateLimit
predeterminado

Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

RuntimeProblem (application/problem+json)