screenRIG
登录开始使用

API 参考

网站演示 API

网站演示请求和预订

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

OpenAPI YAMLOpenAPI JSON问题 YAMLAPI 概览

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

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

网站演示请求和预订

POST/website/demo-requests

提交网站演示请求

同源匿名网站接收。在分类之前保存请求和独立的交付任务。Idempotency-Key 是独立随机的私有重试 UUID，仅保存在浏览器内存中。它不是公共 flow_id。匹配的重试设置相同的 HttpOnly screenrig_demo cookie 并返回保存的请求，无需再次提交。

请求和响应不记录在负载日志中。国家不选择时区。不创建项目或控制台登录。

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

参数

名称发送必需？描述
来源header必填同源浏览器请求；配置的阶段源在阶段环境中被接受。
Idempotency-Keyheader必填
f查询可选非秘密漏斗尝试 ID，与请求体 flow_id 相同。
src查询可选允许列表中的来源，与正文来源相同。

请求主体字段

字段描述
email（必填，字符串）maxLength：254 格式：“email”
country（必填，字符串）ISO 3166-1 国家代码；与时区分开保存。模式："^[A-Z]{2}$"
screen_range（必填，字符串）允许：“1_10”、“11_50”、“51_250”、“251_plus”、“unknown”
组织（必填，字符串）允许值：“small_mid”、“large_corporation”、“agency_network”
budget（必填，字符串）自报的年度标牌预算（美元）。允许值：“under_2995”、“2995_19994”、“19995_plus”、“unknown”
时区（必填，字符串）IANA 时区，浏览器检测不可用时为空；调度需要明确时区。maxLength：100
source（必填，DemoSource）允许：“home_hero”、“home_paid_plans”、“pricing_plus”、“pricing_education”、“pricing_premium”、“pricing_enterprise”、“resellers”、“direct”
flow_id（必填，字符串）随机非秘密分析尝试 ID，绝非授权。模式："^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
请求模板和响应
shell · 请求模板
curl --request POST --cookie-jar cookies.txt --header 'Origin: https://screenrig.ai' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/website/demo-requests'

响应

状态含义正文和头部
201请求已持久保存。设置私有演示会话 cookie。DemoResult（application/json）
200匹配已保存请求的幂等重放。DemoResult（application/json）
默认

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

问题 (application/problem+json)
GET/website/demo-request

获取网站演示请求

绑定 Cookie 的保存请求。请求 ID 或公共流程 ID 不授予访问权限。无存储。

身份验证
demoSession
请求主体
无
操作 ID
getWebsiteDemoRequest
请求模板和响应
shell · 请求模板
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/website/demo-request'

响应

状态含义正文和头部
200已保存的演示请求和预订状态。DemoResult（application/json）
默认

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

问题 (application/problem+json)
GET/website/demo-calendar

获取网站演示日历

此浏览器确认预订的私有日历下载。重新检查保存的事件；无请求 ID 或公共流程 ID 授权访问。无存储。

身份验证
demoSession
请求主体
无
操作 ID
getWebsiteDemoCalendar
请求模板和响应
shell · 请求模板
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/website/demo-calendar'

响应

状态含义正文和头部
200可导入的日历事件，具有稳定身份和确认时间。字符串（text/calendar）
默认

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

问题 (application/problem+json)
GET/website/demo-slots

获取网站演示时段

最多四个真实可用的 30 分钟时段，尽可能在不同日期和时间变化，使用访客可编辑的 IANA 时区。私有时段 ID 在 JSON 正文中返回，绝不通过 URL 查询发送。未配置日历或无合理时区重叠时返回空列表。

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

参数

名称发送必需？描述
时区查询必填
刷新查询可选提供替代方案以替换之前基于 cookie 的批次。
请求模板和响应
shell · 请求模板
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/website/demo-slots?timezone=TIMEZONE'

响应

状态含义正文和头部
200真实可用插槽或空列表。DemoSlots（application/json）
默认

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

问题 (application/problem+json)
POST/website/demo-bookings

预订网站演示

重新检查绑定 cookie 的插槽，原子性保留主机缓冲单元并在配置的本地或 Google 日历中创建稳定事件。确认需要真实事件和保存的预订。模糊的提供者失败保持待定以便持久调和，无第二事件或错误预订页面。

身份验证
demoSession
请求主体
object
操作 ID
bookWebsiteDemo

参数

名称发送必需？描述
来源header必填同源浏览器请求；配置的阶段源在阶段环境中被接受。
f查询可选非秘密漏斗尝试 ID，与保存的 flow_id 相同。
src查询可选已保存的白名单源。

请求主体字段

字段描述
slot_id（必填，字符串）仅限重放已确认的绑定 Cookie 预订。模式："^([A-Za-z0-9_-]{20,128})?$"
时区（必填，字符串）maxLength：100
请求模板和响应
shell · 请求模板
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Origin: https://screenrig.ai' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/website/demo-bookings'

响应

状态含义正文和头部
201日历事件和预订已确认并保存。DemoResult（application/json）
200已确认预订重播。DemoResult（application/json）
202预订待服务方对账，未计入已确认预订分析。DemoResult（application/json）
409

稳定的 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)
POST/website/demo-review

请求网站演示审核

标记现有的按需请求以供团队审核，无需另行问卷。迟来的分类器回复无法撤销此选择。

身份验证
demoSession
请求主体
object
操作 ID
requestWebsiteDemoReview

参数

名称发送必需？描述
来源header必填同源浏览器请求；配置的阶段源在阶段环境中被接受。
请求模板和响应
shell · 请求模板
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Origin: https://screenrig.ai' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/website/demo-review'

响应

状态含义正文和头部
200当前保存的请求，已请求审核。DemoResult（application/json）
默认

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

问题 (application/problem+json)
POST/website/demo-session

交换网站演示邀请

交换通过电子邮件发送的七天预订邀请，换取仅限浏览器的 HttpOnly 演示会话。网站在任何请求前移除其邀请片段，仅在此私有 POST 正文中发送令牌，绝不通过 URL、重定向、分析标记或日志发送。多个浏览器会话可访问同一邀请绑定请求。

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

参数

名称发送必需？描述
来源header必填同源浏览器请求；配置的阶段源在阶段环境中被接受。

请求主体字段

字段描述
令牌（必填，字符串）模式："^[A-Za-z0-9_-]{20,128}$"
请求模板和响应
shell · 请求模板
curl --request POST --cookie-jar cookies.txt --header 'Origin: https://screenrig.ai' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/website/demo-session'

响应

状态含义正文和头部
200Cookie 设置并返回保存的演示请求。DemoResult（application/json）
默认

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

问题 (application/problem+json)