screenRIG
登录开始使用

API 参考

反馈 API

反馈：错误报告和功能请求

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

OpenAPI YAMLOpenAPI JSON问题 YAMLAPI 概览

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

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

反馈：错误报告和功能请求

GET/api/feedback/bugs

列出错误报告

返回调用项目自己的错误报告，最新优先，最多一百条。不会返回其他项目的提交。通过反馈 ID 读取拥有的线程。v1 中无分页游标。每条提交包含其状态及员工/代理回复，最早的先显示。

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

参数

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

响应

状态含义正文和头部
200错误报告归调用项目所有。FeedbackList（application/json）
默认

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

问题 (application/problem+json)
POST/api/feedback/bugs

报告错误

针对调用项目记录一条错误报告。提交的字段不可更新或删除；可在同一反馈线程回复中添加更正或更多信息。

携带相同 Idempotency-Key 的精确重试在 24 小时内返回原始提交，避免重复创建；同一密钥下不同正文返回 idempotency_mismatch。每次提交存储前均经过筛查。

正文少于 12 字符或 3 词返回 submission_too_short；描述无问题或请求的文本（随机字符、键盘乱敲）返回 submission_unclear；垃圾邮件、链接过多文本、提示注入和恶意文本返回 submission_rejected。

拒绝的提交不会被存储，其问题详情中不会重复提交的文本，在相同的 Idempotency-Key 下的精确重试会返回相同的拒绝。

切勿在标题、正文或上下文中放置凭证、Cookie、授权头、完成随机数、签名 URL 或对象密钥；凭证形文本（ScreenRig 令牌、JWT、承载令牌、云和 API 密钥、私钥）在存储提交前替换为[已编辑]，响应中带有编辑文本。

当筛选模型暂时不可用时，提交被接受并等待后台重新筛选；在一小时内多次接受后，项目将收到 submission_screening_unavailable（500，Retry-After）并稍后重试相同请求。

身份验证
projectBearer
请求主体
FeedbackWrite
操作 ID
reportBug

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
Idempotency-Keyheader必填

请求主体字段

字段描述
标题（必填，字符串）单行摘要。前后空白被修剪，控制字符被拒绝。minLength：1 maxLength：120
body（必填，字符串）完整描述。仅接受换行和制表符作为控制字符。minLength：1 maxLength：4000
context（可选，FeedbackContext）

已关闭诊断信封。每个成员为可选受限标量，结构上不允许嵌套，未知成员将被拒绝并返回 invalid_request。该结构存在以防客户端持久化参数值、凭证或自由格式环境数据。

请求模板和响应
shell · 请求模板
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/feedback/bugs'

响应

状态含义正文和头部
201已存储的错误报告。完全幂等的重试返回相同提交。FeedbackSubmission（application/json）；头部：RateLimit-Policy，RateLimit
400

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

问题 (application/problem+json)
409

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

问题 (application/problem+json)
422

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

问题 (application/problem+json)
429

稳定的 rate_limited 问题。仅在权威 Retry-After 间隔后重试。固定窗口拒绝还包括适用的 RateLimit-Policy 和 RateLimit 成员；并发和字节预算拒绝省略这些可选披露。

问题 (application/problem+json)；头部：Retry-After，RateLimit-Policy，RateLimit
默认

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

问题 (application/problem+json)
GET/api/feedback/features

列出功能请求

返回调用项目自己的功能请求，最新优先，最多一百条。不会返回其他项目的提交。通过反馈 ID 读取拥有的线程。v1 中无分页游标。每条提交包含其状态及员工/代理回复，最早的先显示。

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

参数

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

响应

状态含义正文和头部
200调用项目拥有的功能请求。FeedbackList（application/json）
默认

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

问题 (application/problem+json)
POST/api/feedback/features

请求功能

针对调用项目记录一条功能请求。提交的字段不可更新或删除；可在同一反馈线程回复中添加更正或更多信息。

携带相同 Idempotency-Key 的精确重试在 24 小时内返回原始提交，避免重复创建；同一密钥下不同正文返回 idempotency_mismatch。每次提交存储前均经过筛查。

正文少于 12 字符或 3 词返回 submission_too_short；描述无问题或请求的文本（随机字符、键盘乱敲）返回 submission_unclear；垃圾邮件、链接过多文本、提示注入和恶意文本返回 submission_rejected。

拒绝的提交不会被存储，其问题详情中不会重复提交的文本，在相同的 Idempotency-Key 下的精确重试会返回相同的拒绝。

切勿在标题、正文或上下文中放置凭证、Cookie、授权头、完成随机数、签名 URL 或对象密钥；凭证形文本（ScreenRig 令牌、JWT、承载令牌、云和 API 密钥、私钥）在存储提交前替换为[已编辑]，响应中带有编辑文本。

当筛选模型暂时不可用时，提交被接受并等待后台重新筛选；在一小时内多次接受后，项目将收到 submission_screening_unavailable（500，Retry-After）并稍后重试相同请求。

身份验证
projectBearer
请求主体
FeedbackWrite
操作 ID
requestFeature

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
Idempotency-Keyheader必填

请求主体字段

字段描述
标题（必填，字符串）单行摘要。前后空白被修剪，控制字符被拒绝。minLength：1 maxLength：120
body（必填，字符串）完整描述。仅接受换行和制表符作为控制字符。minLength：1 maxLength：4000
context（可选，FeedbackContext）

已关闭诊断信封。每个成员为可选受限标量，结构上不允许嵌套，未知成员将被拒绝并返回 invalid_request。该结构存在以防客户端持久化参数值、凭证或自由格式环境数据。

请求模板和响应
shell · 请求模板
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/feedback/features'

响应

状态含义正文和头部
201已存储的功能请求。完全幂等的重试返回相同提交。FeedbackSubmission（application/json）；头部：RateLimit-Policy，RateLimit
400

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

问题 (application/problem+json)
409

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

问题 (application/problem+json)
422

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

问题 (application/problem+json)
429

稳定的 rate_limited 问题。仅在权威 Retry-After 间隔后重试。固定窗口拒绝还包括适用的 RateLimit-Policy 和 RateLimit 成员；并发和字节预算拒绝省略这些可选披露。

问题 (application/problem+json)；头部：Retry-After，RateLimit-Policy，RateLimit
默认

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

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

获取反馈线程

读取拥有的反馈 ID 的原始报告及所有回复。ID 不授予项目权限。外来和缺失报告均返回 not_found。回复为不受信任的纯文本。

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

参数

名称发送必需？描述
id路径必填
请求模板和响应
shell · 请求模板
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/feedback/RESOURCE_ID'

响应

状态含义正文和头部
200所属项目的完整反馈线程，最早回复优先。FeedbackSubmission（application/json）
默认

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

问题 (application/problem+json)
POST/api/feedback/{id}/responses

回复反馈线程

追加对拥有的反馈报告的回复。已验证凭证提供作者身份；调用者不能设置作者、状态或修复版本。原始报告和早期回复保持不变。回复会重新打开 waiting_on_user、已修复、拒绝和重复报告；“计划中”报告保持其状态。允许简短跟进。

凭据形态已编辑，注入/垃圾邮件安全检查生效。最多 20 条回复，每条 1 至 2000 字符。回复、状态、事件及重试回执一起提交；精确重试在 24 小时内重放，消耗前限额，变更负载返回 idempotency_mismatch。

身份验证
projectBearer
请求主体
FeedbackReplyWrite
操作 ID
replyFeedbackThread

参数

名称发送必需？描述
id路径必填
Idempotency-Keyheader必填

请求主体字段

字段描述
文本（必填，字符串）纯文本；换行和制表符是唯一的控制字符。minLength：1 maxLength：2000
请求模板和响应
shell · 请求模板
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/feedback/RESOURCE_ID/responses'

响应

状态含义正文和头部
201已更新包含此回复的反馈线程。FeedbackSubmission（application/json）；头部：RateLimit-Policy，RateLimit
422

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

问题 (application/problem+json)
429

稳定的 rate_limited 问题。仅在权威 Retry-After 间隔后重试。固定窗口拒绝还包括适用的 RateLimit-Policy 和 RateLimit 成员；并发和字节预算拒绝省略这些可选披露。

问题 (application/problem+json)；头部：Retry-After，RateLimit-Policy，RateLimit
默认

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

问题 (application/problem+json)