screenRIG
登录开始使用

API 参考

评论 API

评论

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

OpenAPI YAMLOpenAPI JSON问题 YAMLAPI 概览

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

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

评论

GET/api/comment/screen/{id}

获取屏幕评论

指定屏幕的不透明智能体注释。ScreenRig 不读取或使用。它们不是授权信息，也不在运行时清单中。无注释屏幕返回 comments null。归档屏幕仍可访问。需认证的 /api control-plane 读取；消耗 1 额度。

身份验证
projectBearer
请求主体
无
操作 ID
getScreenComments

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
id路径必填
请求模板和响应
shell · 请求模板
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

响应

状态含义正文和头部
200评论评论（application/json）
403

outside_screen_scope - 调用方限定于屏幕，且请求所指明或涉及的屏幕、屏幕文件夹、选择器或受众超出了这些屏幕（docs/screen-scope.md）。范围之外的 ID 和不存在的 ID 得到相同的答复；errors[0].screen_scope 携带调用方的范围，写入会被整体拒绝，绝不会被缩小范围。

问题 (application/problem+json)
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
PUT/api/comment/screen/{id}

放置屏幕评论

替换指定屏幕上的不透明智能体评论。评论值必须是JSON对象，其紧凑UTF-8形式最多1024字节。仅评论字段采用最后写入者胜出；修订、updated_at和运行时清单保持不变。

身份验证
projectBearer
请求主体
CommentsWrite
操作 ID
putScreenComments

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
id路径必填
Idempotency-Keyheader可选省略以进行新操作。提供并重用密钥以去重重试；CLI 自动管理密钥。

请求主体字段

字段描述
comments（必填，对象）

不透明的智能体 JSON 对象。紧凑 UTF-8 序列化最多 1024 字节。允许嵌套对象、数组和字符串。数组、字符串、数字、布尔值和 null 作为注释值本身被拒绝。

请求模板和响应
shell · 请求模板
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

响应

状态含义正文和头部
200评论评论（application/json）
403

outside_screen_scope - 调用方限定于屏幕，且请求所指明或涉及的屏幕、屏幕文件夹、选择器或受众超出了这些屏幕（docs/screen-scope.md）。范围之外的 ID 和不存在的 ID 得到相同的答复；errors[0].screen_scope 携带调用方的范围，写入会被整体拒绝，绝不会被缩小范围。

问题 (application/problem+json)
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
删除/api/comment/screen/{id}

删除屏幕评论

取消设置屏幕评论。如果已经取消设置，则幂等。不会提升版本或重新生成运行时清单。

身份验证
projectBearer
请求主体
无
操作 ID
deleteScreenComments

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
id路径必填
Idempotency-Keyheader可选省略以进行新操作。提供并重用密钥以去重重试；CLI 自动管理密钥。
请求模板和响应
shell · 请求模板
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

响应

状态含义正文和头部
204未设置无正文
403

outside_screen_scope - 调用方限定于屏幕，且请求所指明或涉及的屏幕、屏幕文件夹、选择器或受众超出了这些屏幕（docs/screen-scope.md）。范围之外的 ID 和不存在的 ID 得到相同的答复；errors[0].screen_scope 携带调用方的范围，写入会被整体拒绝，绝不会被缩小范围。

问题 (application/problem+json)
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
GET/api/comment/playlist/{id}

获取播放列表评论

指定播放列表的不透明智能体注释。ScreenRig 不读取或使用。无注释播放列表返回 comments null。需认证的 /api control-plane 读取；消耗 1 额度。

身份验证
projectBearer
请求主体
无
操作 ID
getPlaylistComments

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
id路径必填
请求模板和响应
shell · 请求模板
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

响应

状态含义正文和头部
200评论评论（application/json）
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
PUT/api/comment/playlist/{id}

放置播放列表评论

替换指定播放列表上的不透明智能体评论。评论对象的紧凑UTF-8 JSON不得超过1024字节。仅评论字段最后写入生效；版本和运行时清单不变。

身份验证
projectBearer
请求主体
CommentsWrite
操作 ID
putPlaylistComments

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
id路径必填
Idempotency-Keyheader可选省略以进行新操作。提供并重用密钥以去重重试；CLI 自动管理密钥。

请求主体字段

字段描述
comments（必填，对象）

不透明的智能体 JSON 对象。紧凑 UTF-8 序列化最多 1024 字节。允许嵌套对象、数组和字符串。数组、字符串、数字、布尔值和 null 作为注释值本身被拒绝。

请求模板和响应
shell · 请求模板
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

响应

状态含义正文和头部
200评论评论（application/json）
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
删除/api/comment/playlist/{id}

删除播放列表评论

取消设置播放列表评论。若已取消设置则幂等。不会提升版本或重新生成运行时清单。

身份验证
projectBearer
请求主体
无
操作 ID
deletePlaylistComments

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
id路径必填
Idempotency-Keyheader可选省略以进行新操作。提供并重用密钥以去重重试；CLI 自动管理密钥。
请求模板和响应
shell · 请求模板
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

响应

状态含义正文和头部
204未设置无正文
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
GET/api/comment/playlist/{id}/page/{page_id}

获取播放列表页面评论

单个播放列表页面的不透明智能体注释，由页面 ID 字符串定位。无注释页面返回 comments null。缺少播放列表或页面返回 not_found。需认证的 /api control-plane 读取；消耗 1 额度。

身份验证
projectBearer
请求主体
无
操作 ID
getPlaylistPageComments

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
id路径必填
page_id路径必填播放列表页面 ID 字符串。
请求模板和响应
shell · 请求模板
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

响应

状态含义正文和头部
200评论评论（application/json）
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
PUT/api/comment/playlist/{id}/page/{page_id}

放置播放列表页面评论

替换单个播放列表页面上的不透明智能体评论。评论对象的紧凑UTF-8 JSON不得超过1024字节。仅该页面评论字段最后写入生效；播放列表版本和运行时清单不变。

身份验证
projectBearer
请求主体
CommentsWrite
操作 ID
putPlaylistPageComments

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
id路径必填
page_id路径必填播放列表页面 ID 字符串。
Idempotency-Keyheader可选省略以进行新操作。提供并重用密钥以去重重试；CLI 自动管理密钥。

请求主体字段

字段描述
comments（必填，对象）

不透明的智能体 JSON 对象。紧凑 UTF-8 序列化最多 1024 字节。允许嵌套对象、数组和字符串。数组、字符串、数字、布尔值和 null 作为注释值本身被拒绝。

请求模板和响应
shell · 请求模板
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

响应

状态含义正文和头部
200评论评论（application/json）
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
删除/api/comment/playlist/{id}/page/{page_id}

删除播放列表页面评论

取消设置一个播放列表页面的评论。若已取消设置则幂等。不会提升版本或重新生成运行时清单。

身份验证
projectBearer
请求主体
无
操作 ID
deletePlaylistPageComments

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
id路径必填
page_id路径必填播放列表页面 ID 字符串。
Idempotency-Keyheader可选省略以进行新操作。提供并重用密钥以去重重试；CLI 自动管理密钥。
请求模板和响应
shell · 请求模板
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

响应

状态含义正文和头部
204未设置无正文
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)