浏览器交接 API 参考：端点与示例

OpenAPI YAML OpenAPI JSON 问题 YAML API 概览

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

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

主页浏览器交接

POST/api/project/browser-links/claim¶

认领浏览器链接

认领一个经过身份验证的项目的浏览器链接代码，并原子性创建一个首次 pairing_pending 屏幕及其现有浏览器配置授权。注册仍限于项目。响应仅包含安全元数据，绝不包含配置令牌、片段 URL、Cookie 或证明。

身份验证: projectBearer
请求主体: BrowserLinkClaimRequest
操作 ID: claimBrowserLink

参数

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

请求主体字段

字段	描述
code（必填，字符串）	模式："^[23456789ABCDEFGHJKMNPQRSTUVWXYZ]{3}-?[23456789ABCDEFGHJKMNPQRSTUVWXYZ]{3}$"

请求模板和响应

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/project/browser-links/claim'

响应

状态	含义	正文和头部
201	精确的重放安全无片段浏览器链接声明。	BrowserLinkClaim（application/json）；头部：Cache-Control，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)
403	稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	问题 (application/problem+json)
404	稳定的 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)
410	稳定的 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
500	稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	问题 (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/screen/browser-links¶

获取浏览器链接状态

只读轮询回退，仅通过拥有的 apex 浏览器链接 cookie 认证。返回安全状态元数据和固定续传路径，绝不返回配置 URL 或令牌。

身份验证: browserLinkCookie
请求主体: 无
操作 ID: getBrowserLinkStatus

请求模板和响应

shell · 请求模板

curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/screen/browser-links'

响应

状态	含义	正文和头部
200	已认领安全状态。	BrowserLinkStatus（application/json）；头部：Cache-Control，Referrer-Policy
202	浏览器链接已存在但尚未认领。	BrowserLinkStatus（application/json）；头部：Cache-Control，Referrer-Policy
401	面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	运行时问题（application/problem+json）
410	面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	运行时问题（application/problem+json）
默认	面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	运行时问题（application/problem+json）

POST/screen/browser-links¶

开始浏览器链接

严格同源无 JavaScript 兼容 POST，创建或重用 24 小时未认领的浏览器链接会话。认领后创建独立的 10 分钟受保护预配传输窗口；Cookie 播放器配对持续 24 小时。

原生配对是一个独立的七十二小时未认领定位器；已认领的原生交付保持持久，直到签署完成或明确在播放器上重置。它设置了精确的 apex 主机专用 Secure HttpOnly SameSite=Strict Path=/ __Host-screenrig-browser-link Cookie，无 Domain。

JSON 客户端接收 201；Accept text/html 接收无主体 303 重定向至 /setup。无不安全的本地主机回退；开发需配置 HTTPS 回环源。

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

请求模板和响应

shell · 请求模板

curl --request POST 'https://screenrig.ai/screen/browser-links'

响应

状态	含义	正文和头部
201	安全浏览器链接代码/状态元数据。	BrowserLinkSession（application/json）；头部：Cache-Control，Referrer-Policy，Set-Cookie，RateLimit-Policy，RateLimit
303	No-JavaScript 表单续传至只读设置页面。	无正文；头部：Location、Cache-Control、Referrer-Policy、Set-Cookie
403	面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	运行时问题（application/problem+json）
409	面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	运行时问题（application/problem+json）
429	面向播放器的运行时或内容路由上的稳定 rate_limited 问题，采用运行时文档格式（RuntimeProblem）。仅在权威 Retry-After 间隔后重试。固定窗口拒绝还包括适用的 RateLimit-Policy 和 RateLimit 成员；并发和字节预算拒绝省略这些可选披露。	运行时问题（application/problem+json）；头部：Retry-After，RateLimit-Policy，RateLimit
500	面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	运行时问题（application/problem+json）
默认	面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	运行时问题（application/problem+json）

GET/stream/browser-links/events¶

流浏览器链接事件

仅拥有 Cookie 可重放的 SSE，带有 Last-Event-ID。事件数据仅包含安全状态字段。绝不包含配置 URL/令牌，也不使用项目事件流。

身份验证: browserLinkCookie
请求主体: 无
操作 ID: streamBrowserLinkEvents

参数

名称	发送	必需？	描述
Last-Event-ID	header	可选	在 after 缺失时使用持久游标。

请求模板和响应

shell · 请求模板

curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/stream/browser-links/events'

响应

状态	含义	正文和头部
200	浏览器链接已发出/已声明状态 SSE。	字符串（text/event-stream）；头部：Cache-Control、Referrer-Policy、X-Accel-Buffering
400	面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	运行时问题（application/problem+json）
401	面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	运行时问题（application/problem+json）
410	面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	运行时问题（application/problem+json）
默认	面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	运行时问题（application/problem+json）

GET/screen/browser-links/continue¶

继续浏览器链接

仅导航的拥有 cookie 认证的 GET。认领后返回无主体的 303，敏感 Location 为精确的播放器 /s/<public_id>#provision=<token> URL。Location 不通过 CORS、JSON、SSE、轮询、日志、追踪、指标、分析、事件或错误暴露，仅在短暂交付修复窗口内幂等。

身份验证: browserLinkCookie
请求主体: 无
操作 ID: continueBrowserLink

请求模板和响应

shell · 请求模板

curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/screen/browser-links/continue'

响应

状态	含义	正文和头部
303	无正文重定向到播放器配置片段。	无正文；头部：Location、Cache-Control、Referrer-Policy
401	面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	运行时问题（application/problem+json）
409	面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	运行时问题（application/problem+json）
410	面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	运行时问题（application/problem+json）
默认	面向播放器的运行时、内容或探测路由上的稳定 RFC 9457 问题响应，采用运行时文档格式（RuntimeProblem）。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	运行时问题（application/problem+json）

GET/setup¶

获取浏览器链接设置页面

只读设置说明。无代码时，拥有的浏览器链接 cookie 提供状态。有代码时，返回仅公开说明，代码无效或过期返回通用 404。接受 text/markdown 或 format=markdown 选择 Markdown 格式。无配置 URL 或令牌返回。

身份验证: browserLinkCookie 或无
请求主体: 无
操作 ID: getBrowserLinkSetupPage

参数

名称	发送	必需？	描述
code	查询	可选	公共设置代码用于无副作用的设置指令；无需 Cookie。
格式	查询	可选

请求模板和响应

shell · 请求模板

curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/setup'

响应

状态	含义	正文和头部
200	安全无索引设置HTML。	字符串（text/html）；头部：Cache-Control、Referrer-Policy、X-Robots-Tag
401	稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	问题 (application/problem+json)
410	稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	问题 (application/problem+json)
默认	稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。	问题 (application/problem+json)