API 参考

设置码 API

网站设置码

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

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

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

网站设置码

POST/website/setup-codes

获取访客的设置码

来自网站智能体提示的匿名同源调用。返回请求中第一方访客 Cookie(sr_vid)对应的设置码,首次会生成:同一访客在其有效期内(自生成起 90 天)得到相同的码。

用户把它连同设置提示一起粘贴给自己的智能体,智能体将其交给 CLI 注册,从而把新项目与该次访问关联起来。需要网站的 Origin。没有恰好一个格式正确的访客 Cookie 的请求会得到 204,且不会生成任何内容。该码不授予任何权限,只用于标识一次访问。

每个客户端 IP 每小时最多生成 60 个新码(IPv6 按 /64 分组);所有请求共享每个 IP 每分钟 120 次的限制。以 Retry-After 为准。

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

参数

名称发送必需?描述
来源header必填
请求模板和响应
shell · 请求模板
curl --request POST --header 'Origin: https://screenrig.ai' 'https://screenrig.ai/website/setup-codes'

响应

状态含义正文和头部
200访客的设置码。WebsiteSetupCode(application/json);头信息:Cache-Control
204请求未携带访客 Cookie,因此没有可指明的访问。无正文;头部:Cache-Control
默认

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

问题 (application/problem+json)