screenRIG
登录开始使用

API 参考

支持 API

支持

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

OpenAPI YAMLOpenAPI JSON问题 YAMLAPI 概览

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

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

支持

POST/website/support-messages

发送网站联系留言

用于网站联系表单的同源匿名JSON接收接口。需要网站的Origin请求头，以及由20至128个字母、数字、连字符或下划线组成的Idempotency-Key。不创建账户或会话。在确认接收前保存留言和回复邮箱，由支持服务将其发送到配置的Slack支持频道。

访客提供的邮箱是联系信息，不能作为身份证明。完全相同的重试返回相同的确认且不会再次发送；使用同一个键更改正文会返回idempotency_mismatch。

每个客户端IP每小时最多发送10条新留言（IPv6按/64分组），每个邮箱每天最多3条，全局每小时最多200条；所有请求共享每个IP每分钟120次的限制。以Retry-After为准。发送失败时留言保留在队列中，已送达记录在30天后过期。

身份验证
无
请求主体
object
操作 ID
submitWebsiteSupportMessage

参数

名称发送必需？描述
来源header必填
Idempotency-Keyheader必填

请求主体字段

字段描述
email（必填，字符串）maxLength：254 格式：“email”
message（必填，字符串）保留段落和缩进的原文留言；拒绝仅包含空白字符的文本。minLength: 1 maxLength: 4000
website（可选，字符串）反垃圾信息字段，请留空。maxLength: 200
请求模板和响应
shell · 请求模板
curl --request POST --header 'Origin: https://screenrig.ai' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/website/support-messages'

响应

状态含义正文和头部
202留言已保存以供发送，或已确认完全相同的重试。不包含联系信息。对象 (application/json); 请求头：Cache-Control
默认

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

问题 (application/problem+json)
GET/api/support/status

支持状态

任何活跃项目的可用性和时间。chat_allowed 对所有活跃项目均为真，包括 Standard。当真人可按请求加入聊天时，human_available 为真（Education、Premium 和 Enterprise）；Standard 和 Plus 提供文档和 AI 支持。staffed 表示工作人员当前是否在工作时间内。Luna 在所有套餐上都会立即回答。

身份验证
projectBearer 或 dashboardSession
请求主体
无
操作 ID
supportStatus

参数

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

响应

状态含义正文和头部
200支持结果。SupportStatus（application/json）
默认

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

问题 (application/problem+json)
GET/api/support/conversations

列出支持对话

项目对话，最新优先，最多100条。员工未读计数基于每个认证人员或智能体。

身份验证
projectBearer 或 dashboardSession
请求主体
无
操作 ID
listSupportConversations

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
before查询可选来自前一页下一游标的会话 ID。
请求模板和响应
shell · 请求模板
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/support/conversations'

响应

状态含义正文和头部
200支持结果。SupportConversationList（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/support/conversations

创建支持对话

所有套餐均可使用；Luna 首先立即回答。在真人可加入的地方（支持状态中的 human_available），请求真人会为工作人员暂停 Luna；在 Standard 和 Plus 上该请求会被忽略，由 Luna 回答。存储或 Slack 之前进行筛选。

少于8个字符或3个单词的开场消息返回 submission_too_short；非问题或非疑问句返回 submission_unclear；垃圾信息、含大量链接的文本、提示注入和不安全文本返回 submission_rejected。拒绝的文本不会被保留或发送给 Luna，问题详情也不会重复。

除 ScreenRig 凭证（承载令牌、云和 API 密钥、私钥）外，凭证形状的文本在存储前被替换为 [已编辑]；ScreenRig 凭证材料返回 invalid_request。新对话在一个 Slack 线程中开始；后续内容保持在该线程内。相同密钥的请求在 24 小时内可重放，包括拒绝。

身份验证
projectBearer 或 dashboardSession
请求主体
SupportWrite
操作 ID
createSupportConversation

参数

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

请求主体字段

字段描述
body（必填，字符串）minLength：1 maxLength：4000
human_requested（可选，布尔值）

请求真人，这会暂停 Luna 并等待工作人员。仅在真人可加入的地方计数（human_available：Education、Premium 和 Enterprise）；在 Standard 和 Plus 上会被忽略，由 Luna 回答。默认：false

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

响应

状态含义正文和头部
201支持结果。SupportSubmission（application/json）
422消息被筛选拒绝：submission_too_short 或 submission_unclear（仅限开头消息）或 submission_rejected。详情不重复文本。问题 (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/support/conversations/{id}/messages

列出支持消息

项目对话中的消息，升序排列，最多 100 条。超过最后一条消息序列后继续分页查看旧对话。阅读不影响员工未读状态。

身份验证
projectBearer 或 dashboardSession
请求主体
无
操作 ID
listSupportMessages

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
id路径必填
after查询可选项目支持消息序列；严格从此位置继续。
请求模板和响应
shell · 请求模板
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/support/conversations/RESOURCE_ID/messages'

响应

状态含义正文和头部
200支持结果。SupportMessageList（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/support/conversations/{id}/messages

回复支持对话

向开放对话添加客户消息。跟进无最小长度，且单独不会因不清楚而被拒绝（“谢谢”，“是”）；会进行安全、提示注入和链接垃圾邮件筛查，拒绝时返回 submission_rejected，凭证形文本按新对话处理。

拒绝的文本不会被保留，拒绝会在同一密钥下重播 24 小时。

身份验证
projectBearer 或 dashboardSession
请求主体
SupportWrite
操作 ID
replySupportConversation

参数

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

请求主体字段

字段描述
body（必填，字符串）minLength：1 maxLength：4000
human_requested（可选，布尔值）

请求真人，这会暂停 Luna 并等待工作人员。仅在真人可加入的地方计数（human_available：Education、Premium 和 Enterprise）；在 Standard 和 Plus 上会被忽略，由 Luna 回答。默认：false

请求模板和响应
shell · 请求模板
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/support/conversations/RESOURCE_ID/messages'

响应

状态含义正文和头部
201支持结果。SupportSubmission（application/json）
422消息被筛选拒绝：submission_too_short 或 submission_unclear（仅限开头消息）或 submission_rejected。详情不重复文本。问题 (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/support/conversations/{id}/read

读取支持对话

通过序列单调确认此阅读器的消息。不能确认超过对话的 last_sequence。

身份验证
projectBearer 或 dashboardSession
请求主体
SupportRead
操作 ID
readSupportConversation

参数

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

请求主体字段

字段描述
sequence（必填，整数）最小值：0
请求模板和响应
shell · 请求模板
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/support/conversations/RESOURCE_ID/read'

响应

状态含义正文和头部
200支持结果。SupportRead（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/support/conversations/{id}/close

关闭支持对话

结束此项目对话并取消待处理的 AI 回复。可重复；保留历史。工作人员可在 Slack 中重新打开。

身份验证
projectBearer 或 dashboardSession
请求主体
无
操作 ID
closeSupportConversation

参数

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

响应

状态含义正文和头部
200对话已关闭。SupportConversation（application/json）
默认

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

问题 (application/problem+json)
GET/stream/support

流支持消息

所有计划的项目支持消息作为可恢复 SSE。事件为 support.message；ID 是项目支持序列，数据为 SupportMessage。after 优先于 Last-Event-ID。光标 0 重放历史。员工、客户和 AI 消息通过角色区分。流会重新验证凭据和活动项目访问权限。

未发送截图或凭证数据。

身份验证
projectBearer 或 dashboardSession
请求主体
无
操作 ID
streamSupportMessages

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
after查询可选项目支持消息序列；严格从此位置继续。
Last-Event-IDheader可选
请求模板和响应
shell · 请求模板
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/stream/support'

响应

状态含义正文和头部
200支持消息 SSE。字符串（text/event-stream）
默认

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

问题 (application/problem+json)