OpenAPI YAMLOpenAPI JSON问题 YAMLAPI 概览
此分组有 6 个操作，由 api/openapi.yaml 生成。可按路径、操作或认证筛选。每个端点都会列出其输入；展开后可查看请求模板和响应代码。模板需要您自己的值和符合架构的请求体。
用你的值替换大写占位符。对于JSON请求，请保存符合request.json模式的请求体。Cookie示例使用经过身份验证会话的本地Cookie存储。
服务元数据、能力和文档搜索
获取 Health
请求模板和响应
curl --request GET 'https://api.screenrig.ai/.health'响应
| 状态 | 含义 | 正文和头部 |
|---|---|---|
| 200 | 在线 | HealthResponse（application/json） |
获取准备状态
服务就绪。正在排空的主机以 421 server_draining 和 Retry-After: 1 响应。必需依赖失败以 500 not_ready 和 Retry-After 响应。实时数据库架构不满足此版本（缺少所需索引或两分钟以上不同）以 500 schema_incompatible 响应且无 Retry-After：等待不会清除该状态。
请求模板和响应
curl --request GET 'https://api.screenrig.ai/.ready'响应
| 状态 | 含义 | 正文和头部 |
|---|---|---|
| 200 | 就绪 | ReadyResponse（application/json） |
| 421 | 面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。 | 运行时问题（application/problem+json） |
| 500 | 面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。 | 运行时问题（application/problem+json） |
获取版本
请求模板和响应
curl --request GET 'https://api.screenrig.ai/.version'响应
| 状态 | 含义 | 正文和头部 |
|---|---|---|
| 200 | 版本 | VersionResponse（application/json） |
获取功能
请求模板和响应
curl --request GET 'https://api.screenrig.ai/api/capabilities'响应
| 状态 | 含义 | 正文和头部 |
|---|---|---|
| 200 | 功能和归档限制 | 功能（application/json） |
搜索官方文档
搜索 screenRIG 官方文档，包括 screenrig.ai/docs 的页面、问题类型、定价和其他面向客户的页面，按匹配度从高到低返回章节，最多 limit 条（默认 8 条）。公开：无需凭据，调用从不计费。
命中项的 url 是其页面（页面有片段时附带该章节的片段），section 是标题，snippet 显示匹配处周围的文本；用 getDocsPage 读取页面或章节。限制为每个客户端 IP 每分钟 120 次请求（IPv6 按 /64 分组）。
语料库每 15 分钟重新加载；首次加载前，该路由返回 500 not_ready 并带 Retry-After。
参数
| 名称 | 发送 | 必需？ | 描述 |
|---|---|---|---|
| q | 查询 | 必填 | 文字、命令或选项，或错误代码，1 到 200 个字符。 |
| 限制 | 查询 | 可选 |
请求模板和响应
curl --request GET 'https://api.screenrig.ai/api/docs/search?q=Q'响应
| 状态 | 含义 | 正文和头部 |
|---|---|---|
| 200 | 匹配的章节，最佳匹配在前。无匹配时为空。 | DocsSearchResponse（application/json）；头部：RateLimit-Policy，RateLimit |
| 默认 | 稳定的 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 |
读取官方文档页面或章节
以 Markdown 返回一个官方文档页面；指定 section 时，返回该页面的一个章节及其下的各级章节。url 是页面的地址，即 searchDocs 返回的形式、其 .md 形式或仅其路径，可带或不带 #fragment（未给出 section 时，片段指明章节）。section 是页面的标题或锚点，或标题的一部分。
章节在 48 KiB 以内的行尾处截断，并带 truncated true；超过 48 KiB 的整页返回其简介和大纲，并带 truncated true。sections 列出接下来要读的标题（页面的标题，或该章节自己的子标题）。未知的页面和章节返回 404 not_found。
公开，从不计费，并与 searchDocs 一样限制为每个客户端 IP 每分钟 120 次请求。
参数
| 名称 | 发送 | 必需？ | 描述 |
|---|---|---|---|
| url | 查询 | 必填 | 页面的地址，1 到 500 个字符。 |
| section | 查询 | 可选 | 页面的标题或锚点，最多 200 个字符。 |
请求模板和响应
curl --request GET 'https://api.screenrig.ai/api/docs/page?url=URL'响应
| 状态 | 含义 | 正文和头部 |
|---|---|---|
| 200 | 以 Markdown 形式返回的页面或章节。 | DocsPage（application/json）；头部：RateLimit-Policy，RateLimit |
| 默认 | 稳定的 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 |