screenRIG
登录开始使用

API 参考

应用存储 API

运行时应用 K/V

HTTP 参考。 由后端契约生成。浏览以下端点或下载 OpenAPI。

OpenAPI YAMLOpenAPI JSON问题 YAMLAPI 概览

此分组有 4 个操作，由 api/openapi.yaml 生成。可按路径、操作或认证筛选。每个端点都会列出其输入；展开后可查看请求模板和响应代码。模板需要您自己的值和符合架构的请求体。

用你的值替换大写占位符。对于JSON请求，请保存符合request.json模式的请求体。Cookie示例使用经过身份验证会话的本地Cookie存储。

运行时应用 K/V

GET/screen/apps/{application_id}/kv

列出运行时键值

返回最多 200 条按键升序排列的条目，不分页；键数超出时仅部分列出。列出屏幕当前内容持有的应用元数据。

运行时 KV 由播放器的运行时会话授权（kv.read，写入时为 kv.write）及屏幕当前授权，必须持有应用的就绪版本；忽略 ScreenRig-Primitive-Capability 头。上传的帧从不调用这些路由，必须使用验证的父 SDK 桥接。

身份验证
runtimeCookie 或 nativeSessionAuthorization
请求主体
无
操作 ID
listRuntimeKV

参数

名称发送必需？描述
application_id路径必填
请求模板和响应
shell · 请求模板
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv'

响应

状态含义正文和头部
200清单授权应用 KV运行时KV列表（application/json）
默认

面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

运行时问题（application/problem+json）
GET/screen/apps/{application_id}/kv/{key}

获取运行时 KV

身份验证
runtimeCookie 或 nativeSessionAuthorization
请求主体
无
操作 ID
getRuntimeKV

参数

名称发送必需？描述
application_id路径必填
key路径必填
请求模板和响应
shell · 请求模板
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'

响应

状态含义正文和头部
200清单授权应用 KV 值运行时KV条目（application/json）
默认

面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

运行时问题（application/problem+json）
PUT/screen/apps/{application_id}/kv/{key}

放置运行时 KV

身份验证
pairedRuntimeCookie 或 nativeSessionAuthorization
请求主体
运行时KV写入
操作 ID
putRuntimeKV

参数

名称发送必需？描述
application_id路径必填
key路径必填
If-Matchheader可选可选正资源修订。省略则创建或覆盖键；提供的过期修订为 revision_conflict。
Idempotency-Keyheader可选省略以进行新操作。提供并重用密钥以去重重试；CLI 自动管理密钥。

请求主体字段

字段描述
value_base64（必填，字符串）maxLength：1398104
content_type（可选，字符串）默认：“application/octet-stream” minLength：1 maxLength：127
请求模板和响应
shell · 请求模板
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'

响应

状态含义正文和头部
200已配对设备 KV 变更运行时KV条目（application/json）；头部：RateLimit-Policy，RateLimit
默认

面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

运行时问题（application/problem+json）
删除/screen/apps/{application_id}/kv/{key}

删除运行时 KV

身份验证
pairedRuntimeCookie 或 nativeSessionAuthorization
请求主体
无
操作 ID
deleteRuntimeKV

参数

名称发送必需？描述
application_id路径必填
key路径必填
If-Matchheader可选可选正资源修订。省略则写入当前资源；提供的过期修订为 revision_conflict。
Idempotency-Keyheader可选省略以进行新操作。提供并重用密钥以去重重试；CLI 自动管理密钥。
请求模板和响应
shell · 请求模板
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'

响应

状态含义正文和头部
204已配对设备 KV 删除无正文；头部：RateLimit-Policy、RateLimit
默认

面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

运行时问题（application/problem+json）