数字标牌 REST API 参考

选择正确的服务

端点决定基础 URL 和凭证。以下请求模板使用声明的服务 URL。

你正在做什么	服务	身份验证
管理屏幕和内容	`api.screenrig.ai`	Agent 持有者令牌
运行播放器	`play.screenrig.ai`	浏览器 Cookie 或原生播放器凭据
管理登录和项目	`screenrig.ai/dashboard`	控制台Cookie
从身份提供者预配人员	`api.screenrig.ai/scim/v2`	组织 SCIM 令牌
加载应用发布版本	其确切主机位于 `apps.screenrig.ai` 下	启动票据或发布cookie

原生播放器在设置期间使用 ScreenRig-Pairing，之后使用 ScreenRig-Session。这些请求不得包含 Cookie。浏览器端点使用自己的 Cookie。

下面使用的身份验证名称

projectBearer: 捆绑 CLI 使用的活动代理令牌，绑定到唯一一个项目。
功能区域: 每个智能体凭证包含固定的区域集：screens、content、playlists、advertising、reports 和 project。凭证仅调用其区域内的路由；reports 还可读取任何区域。请求指定缺失区域时返回 403 forbidden，详情为“此智能体凭证缺少 <name> 功能。”请连接具备所需功能的新智能体安装以恢复。
revocableAgentBearer: 调用代理令牌，接受重试自身断开连接。
配对、设备和运行时 Cookie: Browser 播放器凭据。每个端点会指定可接受的 cookie。
dashboard 会话 cookie: 已登录人员的会话和选定项目。独立的 __Host-screenrig-signup Cookie 绑定链接邀请注册、电子邮件验证、凭证选项和接受。两个 Cookie 均非代理凭证。可批准的人员使用它在控制台的页面编辑器中创建和替换播放列表。
primitiveCapability: 从播放列表原语短期访问单个应用的键值存储。
demoSession: 私有网站演示会话，独立于项目和仪表板凭据。网站在接收或私有邀请后设置；流程标识符不授权访问。
scimBearer: 组织的 SCIM 预配令牌，仅被 /scim/v2 路由接受。它绝不是项目、智能体或控制台凭证。
ssoTransaction: 将单点登录绑定到发起它的浏览器的 Cookie。
operatorBearer: 服务操作员访问。

人员、项目和邀请

某人有一个登录，可属于多个项目。注册总是创建新项目并向其联系邮箱发送项目成员邀请。智能体建议项目名称；每个智能体令牌绑定该项目。

控制台列出该人的项目，并切换所选项目以进行 Cookie 认证操作。个人电子邮件和通行密钥属于登录，不属于项目。

邀请支持创建、列出、撤销和接受流程。项目成员默认通过电子邮件接收；明确请求的成员链接仅返回给其创建者。广告买家邀请仅限电子邮件。电子邮件邀请七天后过期，成员链接二十四小时后过期。新用户创建通行密钥；现有用户在接受前登录。链接注册会验证用户电子邮件后创建登录。

登录重置仅限邮箱，1小时后过期，并替换该人的登录凭据，同时撤销其其他会话。请求确认不会透露邮箱是否有登录。打开控制台是导航行为，不是授权。

常见请求语义

幂等：当端点接受Idempotency-Key时，丢失响应后重用该键和相同请求；不匹配则返回409 idempotency_mismatch。
修订： 当接口要求 If-Match 时，发送当前资源修订；过时写入返回 412 revision_conflict。
游标：列表和 SSE 游标是不可见的。
操作：上传可能在receiving开始，然后使用queued、running、succeeded、failed或cancelled。
SSE： 使用最后的游标或 Last-Event-ID 恢复。一个 stream.resync_required 帧表示重新获取权威状态并从其提供的头游标恢复。
限制：权限发布活动限制；速率限制返回429 rate_limited。

凭证持久性属于插件流程。 捆绑的 CLI 读取可替换插件目录外的平台配置。

上传生命周期

应用

提交已构建的确定性归档，等待验证、提取和不可变发布。screenRIG 处理打包的静态输出。

媒体

声明确切的类型、大小和哈希；严格遵循签名的原始 PUT 方法和头；提交并等待。将签名的 URL 和头视为凭证。

运行时和受保护内容

配对、设备/运行时会话、清单、报告、事件、启动票据和运行时 K/V 均存在于受信任的播放器源。清单媒体支持合同定义的范围；发布资产使用精确的隔离主机。授权的本地播放器会话通过清单和发布绑定的受保护路径接收规范化的不可变 webapp 包。

内容遵循当前屏幕权限。 发布、包和 K/V 访问权限源自当前屏幕清单授权；媒体服务于拥有该项目的屏幕。原生包权限绑定当前屏幕、清单版本、发布身份、包哈希、大小、类型和设备会话；存储保持私有，交付由服务器中介。

完成端点清单

41 个分组共 740 个操作，由 api/openapi.yaml 生成。每个分组都有独立页面，列出每个操作的参数、请求字段、请求模板和响应。

服务元数据、能力和文档搜索

6 个操作，含各自的参数、请求模板和响应。

获取 Health GET /.health
获取准备状态 GET /.ready
获取版本 GET /.version
获取功能 GET /api/capabilities
搜索官方文档 GET /api/docs/search
读取官方文档页面或章节 GET /api/docs/page

项目、邀请和登录

147 个操作，含各自的参数、请求模板和响应。

预览项目删除代理 GET /api/project/deletion-preview
转移项目所有者智能体 PUT /api/project/owner
移动项目代理 POST /api/project/move
允许项目移动智能体 GET /api/project/moves
列出智能体项目 GET /api/projects
创建智能体项目 POST /api/projects
列出邀请 GET /api/invitations
创建邀请 POST /api/invitations
撤销邀请 POST /api/invitations/{id}/revoke
请求登录重置 POST /api/sign-in-resets
注册 CLI POST /api/enrollments
开始智能体 ID 登录 GET /agentid/start
完成Agent ID登录 GET /agentid/callback
获取项目 GET /api/project
更新项目 PATCH /api/project
删除项目智能体 DELETE /api/project
获取项目功能 GET /api/project/capabilities
列出组织审计 GET /api/organizations/{org_id}/audit
列出组织通知 GET /api/organizations/{org_id}/notifications
创建组织通知 POST /api/organizations/{org_id}/notifications
获取组织通知 GET /api/organizations/{org_id}/notifications/{id}
更新组织通知 PATCH /api/organizations/{org_id}/notifications/{id}
删除组织通知 DELETE /api/organizations/{org_id}/notifications/{id}
轮换组织通知密钥 POST /api/organizations/{org_id}/notifications/{id}/rotate-secret
测试组织通知 POST /api/organizations/{org_id}/notifications/{id}/test
列出组织通知投递记录 GET /api/organizations/{org_id}/notifications/{id}/deliveries
列出组织通知投递尝试 GET /api/organizations/{org_id}/notifications/{id}/deliveries/{delivery_id}/attempts
重新订阅某人的组织通知 DELETE /api/organizations/{org_id}/notifications/{id}/unsubscribed/{user_id}
列出项目中的报告类型 GET /api/projects/{project_id}/reports
列出项目中的报告订阅 GET /api/projects/{project_id}/report-subscriptions
在项目中创建报告订阅 POST /api/projects/{project_id}/report-subscriptions
列出项目中的卡片 GET /api/projects/{project_id}/cards
创建项目卡片 POST /api/projects/{project_id}/cards
创建组织门户 POST /api/organizations/{org_id}/billing/portal-sessions
设置组织自动充值 PUT /api/organizations/{org_id}/billing/auto-top-up
获取组织付款 GET /api/organizations/{org_id}/billing/payments
创建组织结账 POST /api/organizations/{org_id}/billing/credit-checkouts
获取组织账单余额 GET /api/organizations/{org_id}/billing/balance
获取组织账单对账单 GET /api/organizations/{org_id}/billing/statement
获取组织账单使用情况 GET /api/organizations/{org_id}/billing/usage
Agent 组织列表 GET /api/organizations
Agent 组织重命名 PATCH /api/organizations/{org_id}
设置项目审核策略 PUT /api/project/review-policy
项目内预览项目删除代理 GET /api/projects/{project_id}/project/deletion-preview
在项目中转移项目所有者智能体 PUT /api/projects/{project_id}/project/owner
在项目中移动项目代理 POST /api/projects/{project_id}/project/move
允许项目内移动智能体 GET /api/projects/{project_id}/project/moves
列出项目中的邀请 GET /api/projects/{project_id}/invitations
在项目中创建邀请 POST /api/projects/{project_id}/invitations
在项目中获取项目 GET /api/projects/{project_id}/project
更新项目中的项目 PATCH /api/projects/{project_id}/project
删除项目中的项目智能体 DELETE /api/projects/{project_id}/project
列出项目中的应用 GET /api/projects/{project_id}/applications
在项目中上传应用 POST /api/projects/{project_id}/applications
在项目中创建应用程序上传 POST /api/projects/{project_id}/applications/uploads
列出项目中的播放列表 V2 GET /api/projects/{project_id}/playlists
在项目中创建播放列表 V2 POST /api/projects/{project_id}/playlists
列出项目中的屏幕 GET /api/projects/{project_id}/screens
列出项目中的屏幕文件夹 GET /api/projects/{project_id}/screen-folders
在项目中创建屏幕文件夹 POST /api/projects/{project_id}/screen-folders
在项目中移动屏幕 POST /api/projects/{project_id}/screens/move
获取项目中的排程日历 GET /api/projects/{project_id}/schedule/calendar
项目内获取排程导入模板 GET /api/projects/{project_id}/schedule/imports/template
项目内预览排程导入 POST /api/projects/{project_id}/schedule/imports/preview
项目内提交排程导入 POST /api/projects/{project_id}/schedule/imports
在项目中认领浏览器链接 POST /api/projects/{project_id}/project/browser-links/claim
在项目中配对屏幕 POST /api/projects/{project_id}/screens/pair
在项目中配置屏幕 POST /api/projects/{project_id}/screens/provision
在项目中应用屏幕操作 POST /api/projects/{project_id}/screens/actions
在项目中开始标签页共享 POST /api/projects/{project_id}/tab-shares
列出项目中的活动 GET /api/projects/{project_id}/campaigns
在项目中创建活动 POST /api/projects/{project_id}/campaigns
列出项目的连接 GET /api/projects/{project_id}/connections
在项目中创建连接 POST /api/projects/{project_id}/connections
列出项目中的BI 连接 GET /api/projects/{project_id}/bi-connections
在项目中创建 BI 连接 POST /api/projects/{project_id}/bi-connections
列出项目中的BI 视图 GET /api/projects/{project_id}/bi-views
在项目中创建 BI 视图 POST /api/projects/{project_id}/bi-views
列出项目中的触发器 GET /api/projects/{project_id}/triggers
在项目中创建触发器 POST /api/projects/{project_id}/triggers
列出项目中的事件 GET /api/projects/{project_id}/events
在项目中获取项目功能 GET /api/projects/{project_id}/project/capabilities
获取项目中的账单余额 GET /api/projects/{project_id}/billing/balance
获取项目中的账单明细 GET /api/projects/{project_id}/billing/statement
获取项目中的账单使用情况 GET /api/projects/{project_id}/billing/usage
获取项目中的广告网络 GET /api/projects/{project_id}/advertising/network
在项目中创建广告网络 POST /api/projects/{project_id}/advertising/network
在项目中设置广告默认费率 POST /api/projects/{project_id}/advertising/network/rate
列出项目中的广告库存 GET /api/projects/{project_id}/advertising/inventory
列出项目中的广告时段 GET /api/projects/{project_id}/advertising/slots
在项目中创建广告位 POST /api/projects/{project_id}/advertising/slots
列出项目中的广告会员 GET /api/projects/{project_id}/advertising/memberships
列出项目中加入的广告网络 GET /api/projects/{project_id}/advertising/networks
列出项目中的广告创意 GET /api/projects/{project_id}/advertising/creatives
在项目中创建广告创意 POST /api/projects/{project_id}/advertising/creatives
列出项目中的广告活动 GET /api/projects/{project_id}/advertising/campaigns
在项目中创建广告活动 POST /api/projects/{project_id}/advertising/campaigns
列出项目中的广告评论 GET /api/projects/{project_id}/advertising/reviews
获取项目中的广告支出 GET /api/projects/{project_id}/advertising/reports/spend
获取项目中的广告投放 GET /api/projects/{project_id}/advertising/reports/delivery
列出项目中的播放汇总 GET /api/projects/{project_id}/playback
列出项目中的播放记录 GET /api/projects/{project_id}/playback/plays
在项目中获取播放总计 GET /api/projects/{project_id}/playback/totals
获取项目中的播放完整度 GET /api/projects/{project_id}/playback/completeness
在项目中获取 Health 趋势 GET /api/projects/{project_id}/health/trend
在项目中获取项目正常运行时间 GET /api/projects/{project_id}/uptime/daily
列出项目中的卡片类型 GET /api/projects/{project_id}/card-types
列出项目中的卡片数据 GET /api/projects/{project_id}/card-data
列出项目中的媒体 GET /api/projects/{project_id}/media
在项目中创建媒体生成 POST /api/projects/{project_id}/media/generations
列出项目中的媒体文件夹 GET /api/projects/{project_id}/media-folders
在项目中创建媒体文件夹 POST /api/projects/{project_id}/media-folders
在项目中移动媒体 POST /api/projects/{project_id}/media/move
在项目中创建媒体上传 POST /api/projects/{project_id}/media/uploads
项目内预览选择器 POST /api/projects/{project_id}/selectors/preview
列出项目中的错误报告 GET /api/projects/{project_id}/feedback/bugs
在项目中报告错误 POST /api/projects/{project_id}/feedback/bugs
列出项目中的功能请求 GET /api/projects/{project_id}/feedback/features
请求项目中的功能 POST /api/projects/{project_id}/feedback/features
列出项目中的服务客户端 GET /api/projects/{project_id}/service-clients
在项目中创建服务客户端 POST /api/projects/{project_id}/service-clients
列出项目中的媒体同步账户 GET /api/projects/{project_id}/media-sync-accounts
在项目中创建媒体同步账户 POST /api/projects/{project_id}/media-sync-accounts
列出项目中的媒体同步 GET /api/projects/{project_id}/media-syncs
在项目中创建媒体同步 POST /api/projects/{project_id}/media-syncs
列出项目中的车队链接 GET /api/projects/{project_id}/fleet-links
在项目中创建车队链接 POST /api/projects/{project_id}/fleet-links
列出项目中的 webhook GET /api/projects/{project_id}/webhooks
在项目中创建 webhook POST /api/projects/{project_id}/webhooks
列出项目中的警报 GET /api/projects/{project_id}/alerts
列出项目中的警报静音 GET /api/projects/{project_id}/alert-mutes
在项目中创建警报静音 POST /api/projects/{project_id}/alert-mutes
列出项目中的通知 GET /api/projects/{project_id}/notifications
在项目中创建通知 POST /api/projects/{project_id}/notifications
列出项目中的备注 GET /api/projects/{project_id}/notes
在项目中添加备注 POST /api/projects/{project_id}/notes
项目中的支持状态 GET /api/projects/{project_id}/support/status
列出项目中的支持对话 GET /api/projects/{project_id}/support/conversations
在项目中创建支持对话 POST /api/projects/{project_id}/support/conversations
列出项目中的评论 GET /api/projects/{project_id}/reviews
项目范围获取卡数据 GET /api/projects/{project_id}/card-data/{key}
项目范围放置卡数据 PUT /api/projects/{project_id}/card-data/{key}
项目范围删除卡数据 DELETE /api/projects/{project_id}/card-data/{key}
项目范围获取订阅 GET /api/projects/{project_id}/feeds/{family}
项目范围列出广告加入库存 GET /api/projects/{project_id}/advertising/networks/{seller_project_id}/inventory
项目范围获取当前智能体 GET /api/projects/{project_id}/agents/self
项目范围断开当前智能体 POST /api/projects/{project_id}/agents/self/disconnect

套餐、额度余额及账单

6 个操作，含各自的参数、请求模板和响应。

获取账单余额 GET /api/billing/balance
获取账单明细 GET /api/billing/statement
获取账单使用情况 GET /api/billing/usage
获取 App Store 购买选项 GET /api/organizations/{organization_id}/app-store/offer
记录 App Store 交易 POST /api/organizations/{organization_id}/app-store/transactions
接收 App Store 通知 POST /api/app-store/notifications

智能体安装和连接

3 个操作，含各自的参数、请求模板和响应。

撤销代理身份 POST /api/agent-identity/revoke
获取当前智能体 GET /api/agents/self
断开当前智能体连接 POST /api/agents/self/disconnect

OAuth 登录、令牌和撤销

10 个操作，含各自的参数、请求模板和响应。

Oauth 令牌 POST /oauth/token
Oauth 设备授权 POST /oauth/device_authorization
Oauth 授权 GET /oauth/authorize
Oauth 撤销 POST /oauth/revoke
Oauth 授权服务器元数据 GET /.well-known/oauth-authorization-server
Oauth 受保护资源 MCP GET /.well-known/oauth-protected-resource/mcp
Oauth 受保护资源 API GET /.well-known/oauth-protected-resource/api
获取仪表板 OAuth 授权 GET /api/oauth/authorizations/{id}
批准仪表板 OAuth 授权 POST /api/oauth/authorizations/{id}/approve
拒绝 Dashboard OAuth 授权 POST /api/oauth/authorizations/{id}/deny

单点登录：登录路由、身份提供者和策略

13 个操作，含各自的参数、请求模板和响应。

发现控制台 SSO POST /api/sso/discovery
开始控制台 SSO POST /api/sso/starts
接收控制台 SSO OIDC 回调 POST /api/sso/oidc/{connection_id}/callback
获取控制台 SSO SAML 元数据 GET /api/sso/saml/{connection_id}
接收控制台 SSO SAML 断言 POST /api/sso/saml/{connection_id}/acs
完成控制台 SSO POST /api/sso/finish
开始控制台会话 SSO POST /api/session/sso-starts
控制台组织获取身份提供者 GET /api/organizations/{org_id}/identity-provider
控制台组织设置身份提供者 PUT /api/organizations/{org_id}/identity-provider
控制台组织移除身份提供者 DELETE /api/organizations/{org_id}/identity-provider
控制台组织测试身份提供者 POST /api/organizations/{org_id}/identity-provider/tests
控制台组织设置 SSO 策略 PUT /api/organizations/{org_id}/sso-policy
控制台组织取消 SSO 移除 DELETE /api/organizations/{org_id}/sso-policy/removal

用户预配：SCIM 2.0、令牌和群组绑定

24 个操作，含各自的参数、请求模板和响应。

控制台组织获取 SCIM GET /api/organizations/{org_id}/scim
控制台组织设置 SCIM PUT /api/organizations/{org_id}/scim
控制台组织创建 SCIM 令牌 POST /api/organizations/{org_id}/scim/tokens
控制台组织撤销 SCIM 令牌 DELETE /api/organizations/{org_id}/scim/tokens/{token_id}
控制台组织列出 SCIM 群组 GET /api/organizations/{org_id}/scim/groups
控制台组织列出 SCIM 事件 GET /api/organizations/{org_id}/scim/events
列出控制台群组绑定 GET /api/project/group-bindings
创建控制台群组绑定 POST /api/project/group-bindings
删除控制台群组绑定 DELETE /api/project/group-bindings/{binding_id}
获取 SCIM ServiceProviderConfig GET /scim/v2/ServiceProviderConfig
列出 SCIM 资源类型 GET /scim/v2/ResourceTypes
列出 SCIM schema GET /scim/v2/Schemas
列出 SCIM 用户 GET /scim/v2/Users
创建 SCIM 用户 POST /scim/v2/Users
获取 SCIM 用户 GET /scim/v2/Users/{id}
替换 SCIM 用户 PUT /scim/v2/Users/{id}
修补 SCIM 用户 PATCH /scim/v2/Users/{id}
删除 SCIM 用户 DELETE /scim/v2/Users/{id}
列出 SCIM 群组 GET /scim/v2/Groups
创建 SCIM 群组 POST /scim/v2/Groups
获取 SCIM 群组 GET /scim/v2/Groups/{id}
替换 SCIM 群组 PUT /scim/v2/Groups/{id}
修补 SCIM 群组 PATCH /scim/v2/Groups/{id}
删除 SCIM 群组 DELETE /scim/v2/Groups/{id}

服务客户端

9 个操作，含各自的参数、请求模板和响应。

列出服务客户端 GET /api/service-clients
创建服务客户端 POST /api/service-clients
获取服务客户端 GET /api/service-clients/{id}
更新服务客户端 PATCH /api/service-clients/{id}
添加服务客户端密钥 POST /api/service-clients/{id}/keys
移除服务客户端密钥 POST /api/service-clients/{id}/keys/{kid}/remove
添加服务客户端密钥秘密 POST /api/service-clients/{id}/secrets
移除服务客户端密钥秘密 POST /api/service-clients/{id}/secrets/{secret_id}/remove
撤销服务客户端 POST /api/service-clients/{id}/revoke

应用和操作

11 个操作，含各自的参数、请求模板和响应。

列出应用 GET /api/applications
上传应用 POST /api/applications
上传应用发布 POST /api/applications/{id}/releases
创建应用程序上传 POST /api/applications/uploads
创建应用程序版本上传 POST /api/applications/{id}/uploads
提交应用程序上传 POST /api/applications/uploads/{id}/commit
获取应用程序 GET /api/applications/{id}
重命名应用 PATCH /api/applications/{id}
删除应用 DELETE /api/applications/{id}
获取操作 GET /api/operations/{id}
取消操作 POST /api/operations/{id}/cancel

媒体上传

38 个操作，含各自的参数、请求模板和响应。

列出媒体 GET /api/media
创建媒体生成 POST /api/media/generations
列出媒体文件夹 GET /api/media-folders
创建媒体文件夹 POST /api/media-folders
获取媒体文件夹 GET /api/media-folders/{id}
更新媒体文件夹 PATCH /api/media-folders/{id}
删除媒体文件夹 DELETE /api/media-folders/{id}
移动媒体 POST /api/media/move
创建媒体上传 POST /api/media/uploads
提交媒体上传 POST /api/media/uploads/{id}/commit
预览选择器 POST /api/selectors/preview
获取媒体 GET /api/media/{id}
补丁媒体 PATCH /api/media/{id}
删除媒体 DELETE /api/media/{id}
补丁媒体标签 PATCH /api/media/{id}/tags
补丁媒体可用性 PATCH /api/media/{id}/availability
替换媒体 POST /api/media/{id}/replace
列出媒体版本 GET /api/media/{id}/versions
删除媒体版本 DELETE /api/media/{id}/versions/{version}
恢复媒体版本 POST /api/media/{id}/versions/{version}/restore
导出媒体内容 GET /api/media/{id}/content
媒体内容头部 HEAD /api/media/{id}/content
列出媒体同步账户 GET /api/media-sync-accounts
创建媒体同步账户 POST /api/media-sync-accounts
获取媒体同步账户 GET /api/media-sync-accounts/{id}
更新媒体同步账户 PATCH /api/media-sync-accounts/{id}
删除媒体同步账户 DELETE /api/media-sync-accounts/{id}
测试媒体同步账户 POST /api/media-sync-accounts/{id}/test
连接媒体同步账户 POST /api/media-sync-accounts/{id}/connect
列出媒体同步设计 GET /api/media-sync-accounts/{id}/designs
完成 Canva 授权 GET /api/canva/callback
完成 Dropbox 授权 GET /api/dropbox/callback
列出媒体同步 GET /api/media-syncs
创建媒体同步 POST /api/media-syncs
获取媒体同步 GET /api/media-syncs/{id}
更新媒体同步 PATCH /api/media-syncs/{id}
删除媒体同步 DELETE /api/media-syncs/{id}
运行媒体同步 POST /api/media-syncs/{id}/run

播放列表

16 个操作，含各自的参数、请求模板和响应。

列出播放列表 V2 GET /api/playlists
创建播放列表 V2 POST /api/playlists
获取播放列表 V2 GET /api/playlists/{id}
更新播放列表 V2 PUT /api/playlists/{id}
补丁播放列表 PATCH /api/playlists/{id}
删除播放列表 V2 DELETE /api/playlists/{id}
补丁播放列表结构 PATCH /api/playlists/{id}/structure
列出播放列表修订 GET /api/playlists/{id}/revisions
获取播放列表修订 GET /api/playlists/{id}/revisions/{revision}
提升播放列表修订 POST /api/playlists/{id}/revisions/{revision}/promote
更新播放列表的值 PATCH /api/playlists/{id}/values
列出播放列表实例 GET /api/playlists/{id}/instances
展开播放列表模板 POST /api/playlists/{id}/expand
添加播放列表页面 POST /api/playlists/{id}/pages
替换播放列表页面 PUT /api/playlists/{id}/pages/{page_id}
移除播放列表页面 DELETE /api/playlists/{id}/pages/{page_id}

屏幕

84 个操作，含各自的参数、请求模板和响应。

列出屏幕 GET /api/screens
列出屏幕文件夹 GET /api/screen-folders
创建屏幕文件夹 POST /api/screen-folders
获取屏幕文件夹 GET /api/screen-folders/{id}
更新屏幕文件夹 PATCH /api/screen-folders/{id}
删除屏幕文件夹 DELETE /api/screen-folders/{id}
移动屏幕 POST /api/screens/move
获取排程日历 GET /api/schedule/calendar
配对屏幕 POST /api/screens/pair
配置屏幕 POST /api/screens/provision
应用屏幕操作 POST /api/screens/actions
获取屏幕 GET /api/screens/{id}
更新屏幕 PATCH /api/screens/{id}
删除屏幕 DELETE /api/screens/{id}
补丁屏幕标签 PATCH /api/screens/{id}/tags
部分更新屏幕字段 PATCH /api/screens/{id}/fields
部分更新屏幕位置 PATCH /api/screens/{id}/location
修改屏幕的详细程度 PATCH /api/screens/{id}/verbosity
修改屏幕设备设置 PATCH /api/screens/{id}/device-settings
修改屏幕名称 PATCH /api/screens/{id}/name
修改屏幕播放列表 PATCH /api/screens/{id}/playlist
轮换屏幕公钥 ID POST /api/screens/{id}/public-id/rotate
获取屏幕链接 GET /api/screens/{id}/link
创建屏幕链接 POST /api/screens/{id}/link
删除屏幕链接 DELETE /api/screens/{id}/link
确认屏幕恢复 POST /api/screens/{id}/recovery/confirm
替换屏幕 POST /api/screens/{id}/replace
归档屏幕 POST /api/screens/{id}/archive
取消归档屏幕 POST /api/screens/{id}/unarchive
重新加载屏幕 POST /api/screens/{id}/reload
获取屏幕播放列表排程 GET /api/screens/{id}/playlist-schedule
设置屏幕播放列表排程 PUT /api/screens/{id}/playlist-schedule
清除屏幕播放列表排程 DELETE /api/screens/{id}/playlist-schedule
预览屏幕播放列表排程 POST /api/screens/{id}/playlist-schedule/preview
列出屏幕播放列表排程修订 GET /api/screens/{id}/playlist-schedule/revisions
恢复屏幕播放列表排程修订 POST /api/screens/{id}/playlist-schedule/revisions/{revision}/restore
设置屏幕接管 POST /api/screens/{id}/takeover
清除屏幕接管 DELETE /api/screens/{id}/takeover
开始标签页共享 POST /api/tab-shares
获取标签页共享 GET /api/tab-shares/{id}
停止标签页共享 DELETE /api/tab-shares/{id}
播放屏幕页面 POST /api/screens/{id}/play-page
标识屏幕 POST /api/screens/{id}/identify
暂停屏幕 POST /api/screens/{id}/suspend
恢复屏幕 POST /api/screens/{id}/resume
重启屏幕 POST /api/screens/{id}/reboot
清除屏幕缓存 POST /api/screens/{id}/clear-cache
重启屏幕应用 POST /api/screens/{id}/restart-app
更新屏幕播放器 POST /api/screens/{id}/update
列出屏幕命令 GET /api/screens/{id}/commands
取消屏幕命令 POST /api/screens/{id}/commands/{command_id}/cancel
设置屏幕显示 POST /api/screens/{id}/display
清除屏幕显示 DELETE /api/screens/{id}/display
获取屏幕显示排程 GET /api/screens/{id}/display-schedule
设置屏幕显示排程 PUT /api/screens/{id}/display-schedule
清除屏幕显示排程 DELETE /api/screens/{id}/display-schedule
获取屏幕重启排程 GET /api/screens/{id}/reboot-schedule
设置屏幕重启排程 PUT /api/screens/{id}/reboot-schedule
清除屏幕重启排程 DELETE /api/screens/{id}/reboot-schedule
屏幕后提示 POST /api/screens/{id}/toast
预测屏幕存储 POST /api/screens/{id}/storage-forecast
说明屏幕活动 GET /api/screens/{id}/campaigns
获取屏幕截图 GET /api/screens/{id}/screenshot
请求屏幕截图 POST /api/screens/{id}/screenshot
获取屏幕截图状态 GET /api/screens/{id}/screenshot/status
获取屏幕实时会话 GET /api/screens/{id}/live
启动屏幕实时会话 POST /api/screens/{id}/live
停止屏幕实时会话 DELETE /api/screens/{id}/live
创建屏幕实时查看者 POST /api/screens/{id}/live/viewers
应答屏幕实时查看者 PUT /api/screens/{id}/live/viewers/{viewer_id}
启动屏幕实时帧 POST /api/screens/{id}/live/frames
获取屏幕实时帧 GET /api/screens/{id}/live/frame
连接实时帧 GET /live/frames
获取屏幕健康历史 GET /api/screens/{id}/health/history
获取屏幕正常运行时间 GET /api/screens/{id}/uptime
获取屏幕状态 GET /api/screens/{id}/presence
获取 Health 趋势 GET /api/health/trend
获取项目正常运行时间 GET /api/uptime/daily
列出车队链接 GET /api/fleet-links
创建车队链接 POST /api/fleet-links
获取车队链接 GET /api/fleet-links/{id}
更新车队链接 PATCH /api/fleet-links/{id}
删除车队链接 DELETE /api/fleet-links/{id}
轮换 Fleet Link POST /api/fleet-links/{id}/rotate

活动

10 个操作，含各自的参数、请求模板和响应。

列出活动 GET /api/campaigns
创建活动 POST /api/campaigns
预览活动 POST /api/campaigns/preview
获取活动 GET /api/campaigns/{id}
更新活动 PATCH /api/campaigns/{id}
删除活动 DELETE /api/campaigns/{id}
列出活动修订 GET /api/campaigns/{id}/revisions
恢复活动修订 POST /api/campaigns/{id}/revisions/{revision}/restore
提升活动 POST /api/campaigns/{id}/promote
列出活动屏幕 GET /api/campaigns/{id}/screens

排程导入：排程行工作表

3 个操作，含各自的参数、请求模板和响应。

获取排程导入模板 GET /api/schedule/imports/template
预览排程导入 POST /api/schedule/imports/preview
提交排程导入 POST /api/schedule/imports

代理更改的审核

7 个操作，含各自的参数、请求模板和响应。

列出评论 GET /api/reviews
获取审核 GET /api/reviews/{id}
定位审查 GET /api/reviews/{id}/locate
批准审核 POST /api/reviews/{id}/approve
拒绝审核 POST /api/reviews/{id}/reject
请求审核更改 POST /api/reviews/{id}/request-changes
撤回审核 POST /api/reviews/{id}/withdraw

私有广告网络和广告活动

46 个操作，含各自的参数、请求模板和响应。

获取广告网络 GET /api/advertising/network
创建广告网络 POST /api/advertising/network
设置广告默认费率 POST /api/advertising/network/rate
列出广告库存 GET /api/advertising/inventory
放置广告库存 PUT /api/advertising/inventory/{screen_id}
列出广告时段 GET /api/advertising/slots
创建广告位 POST /api/advertising/slots
更新广告时段 POST /api/advertising/slots/{id}
列出广告会员 GET /api/advertising/memberships
更新广告会员 POST /api/advertising/memberships/{id}
撤销广告会员资格 POST /api/advertising/memberships/{id}/revoke
列出加入的广告网络 GET /api/advertising/networks
列出加入的广告库存 GET /api/advertising/networks/{seller_project_id}/inventory
列出广告创意 GET /api/advertising/creatives
创建广告创意 POST /api/advertising/creatives
获取广告创意 GET /api/advertising/creatives/{id}
列出卖方广告活动 GET /api/advertising/seller-campaigns
获取卖方广告活动 GET /api/advertising/seller-campaigns/{id}
列出广告活动 GET /api/advertising/campaigns
创建广告活动 POST /api/advertising/campaigns
获取广告活动 GET /api/advertising/campaigns/{id}
更新广告活动 POST /api/advertising/campaigns/{id}
报价广告活动 POST /api/advertising/campaigns/{id}/quote
激活广告活动 POST /api/advertising/campaigns/{id}/activate
暂停广告活动 POST /api/advertising/campaigns/{id}/pause
恢复广告活动 POST /api/advertising/campaigns/{id}/resume
接受广告费率 POST /api/advertising/campaigns/{id}/accept-rates
列出广告评论 GET /api/advertising/reviews
批准广告审核 POST /api/advertising/reviews/{id}/approve
拒绝广告审核 POST /api/advertising/reviews/{id}/reject
获取广告支出 GET /api/advertising/reports/spend
获取广告投放 GET /api/advertising/reports/delivery
列出广告直接活动 GET /api/advertising/direct-campaigns
创建广告直接活动 POST /api/advertising/direct-campaigns
获取广告直接活动 GET /api/advertising/direct-campaigns/{id}
更新广告直接活动 POST /api/advertising/direct-campaigns/{id}
暂停广告直接活动 POST /api/advertising/direct-campaigns/{id}/pause
恢复广告直接活动 POST /api/advertising/direct-campaigns/{id}/resume
结束广告直接活动 POST /api/advertising/direct-campaigns/{id}/end
获取广告直接活动报告 GET /api/advertising/direct-campaigns/{id}/report
估算广告可用量 POST /api/advertising/availability
获取广告填充统计 GET /api/advertising/reports/fill
获取广告审核 GET /api/advertising/reviews/{id}
获取广告审核内容 GET /api/advertising/reviews/{id}/content
广告审核内容头部 HEAD /api/advertising/reviews/{id}/content
请求广告审核更改 POST /api/advertising/reviews/{id}/request-changes

9 个操作，含各自的参数、请求模板和响应。

获取屏幕评论 GET /api/comment/screen/{id}
放置屏幕评论 PUT /api/comment/screen/{id}
删除屏幕评论 DELETE /api/comment/screen/{id}
获取播放列表评论 GET /api/comment/playlist/{id}
放置播放列表评论 PUT /api/comment/playlist/{id}
删除播放列表评论 DELETE /api/comment/playlist/{id}
获取播放列表页面评论 GET /api/comment/playlist/{id}/page/{page_id}
放置播放列表页面评论 PUT /api/comment/playlist/{id}/page/{page_id}
删除播放列表页面评论 DELETE /api/comment/playlist/{id}/page/{page_id}

项目备注由智能体共享

5 个操作，含各自的参数、请求模板和响应。

列出备注 GET /api/notes
添加备注 POST /api/notes
获取备注 GET /api/notes/{id}
确认备注 POST /api/notes/{id}/confirm
解析备注 POST /api/notes/{id}/resolve

应用键值存储

9 个操作，含各自的参数、请求模板和响应。

列出 KV GET /api/applications/{application_id}/kv
获取 KV GET /api/applications/{application_id}/kv/{key}
放置 KV PUT /api/applications/{application_id}/kv/{key}
删除 KV DELETE /api/applications/{application_id}/kv/{key}
列出 KVWebhook GET /api/applications/{application_id}/kv-webhooks
创建 KVWebhook POST /api/applications/{application_id}/kv-webhooks
删除 KVWebhook DELETE /api/applications/{application_id}/kv-webhooks/{webhook_id}
轮换 KVWebhook 密钥 POST /api/applications/{application_id}/kv-webhooks/{webhook_id}/rotate-secret
接收 KVWebhook POST /api/applications/{application_id}/kv-webhooks/{webhook_id}/write

内置卡片的数据

22 个操作，含各自的参数、请求模板和响应。

列出卡片类型 GET /api/card-types
获取卡片类型 GET /api/card-types/{id}
列出卡片 GET /api/cards
创建卡片 POST /api/cards
获取卡片 GET /api/cards/{id}
补丁卡 PATCH /api/cards/{id}
删除卡片 DELETE /api/cards/{id}
获取实例数据 GET /api/cards/{id}/data
放置实例数据 PUT /api/cards/{id}/data
列出卡片 Webhook GET /api/cards/{id}/kv-webhooks
创建卡片 Webhook POST /api/cards/{id}/kv-webhooks
更新卡片 Webhook PATCH /api/cards/{id}/kv-webhooks/{webhook_id}
删除卡片 Webhook DELETE /api/cards/{id}/kv-webhooks/{webhook_id}
轮换卡片 Webhook 密钥 POST /api/cards/{id}/kv-webhooks/{webhook_id}/rotate-secret
列出卡片 Webhook 投递记录 GET /api/cards/{id}/kv-webhooks/{webhook_id}/deliveries
接收卡片 Webhook POST /api/cards/{id}/kv-webhooks/{webhook_id}/write
Head Card KVWebhook HEAD /api/cards/{id}/kv-webhooks/{webhook_id}/write
列出卡片数据 GET /api/card-data
获取卡片数据 GET /api/card-data/{key}
放置卡片数据 PUT /api/card-data/{key}
删除卡片数据 DELETE /api/card-data/{key}
获取信息流 GET /api/feeds/{family}

数据源：让卡片保持最新的地址

10 个操作，含各自的参数、请求模板和响应。

列出数据源预设 GET /api/source-presets
获取数据源预设 GET /api/source-presets/{name}
列出数据源 GET /api/sources
创建数据源 POST /api/sources
测试数据源 POST /api/sources/test
获取数据源 GET /api/sources/{source_id}
更新数据源 PATCH /api/sources/{source_id}
删除数据源 DELETE /api/sources/{source_id}
获取数据源的房间 GET /api/sources/{source_id}/rooms
立即同步数据源 POST /api/sources/{source_id}/refresh

BI 仪表板：Power BI、Tableau 和需要登录的网页的连接与视图

14 个操作，含各自的参数、请求模板和响应。

列出 BI 连接 GET /api/bi-connections
创建 BI 连接 POST /api/bi-connections
获取 BI 连接 GET /api/bi-connections/{id}
更新 BI 连接 PATCH /api/bi-connections/{id}
删除 BI 连接 DELETE /api/bi-connections/{id}
测试 BI 连接 POST /api/bi-connections/{id}/test
浏览 BI 连接 GET /api/bi-connections/{id}/browse
列出 BI 视图 GET /api/bi-views
创建 BI 视图 POST /api/bi-views
获取 BI 视图 GET /api/bi-views/{id}
更新 BI 视图 PATCH /api/bi-views/{id}
删除 BI 视图 DELETE /api/bi-views/{id}
测试 BI 视图 POST /api/bi-views/{id}/test
获取 BI 视图图像 GET /api/bi-views/{id}/image

连接：项目可重复使用的 Microsoft 和 Google 访问权限

9 个操作，含各自的参数、请求模板和响应。

列出连接 GET /api/connections
创建连接 POST /api/connections
获取连接 GET /api/connections/{id}
更新连接 PATCH /api/connections/{id}
删除连接 DELETE /api/connections/{id}
测试连接 POST /api/connections/{id}/test
建立连接 POST /api/connections/{id}/connect
完成 Microsoft 连接授权 GET /oauth/connections/microsoft/callback
完成 Google 连接授权 GET /oauth/connections/google/callback

持久项目事件

2 个操作，含各自的参数、请求模板和响应。

列出事件 GET /api/events
流事件 GET /stream/project

通知：在屏幕状态变化时发送电子邮件和带签名的 Webhook 提醒

13 个操作，含各自的参数、请求模板和响应。

列出通知 GET /api/notifications
创建通知 POST /api/notifications
获取通知 GET /api/notifications/{id}
更新通知 PATCH /api/notifications/{id}
删除通知 DELETE /api/notifications/{id}
轮换通知密钥 POST /api/notifications/{id}/rotate-secret
测试通知 POST /api/notifications/{id}/test
列出通知投递记录 GET /api/notifications/{id}/deliveries
列出通知投递尝试 GET /api/notifications/{id}/deliveries/{delivery_id}/attempts
重新订阅某人的通知 DELETE /api/notifications/{id}/unsubscribed/{user_id}
显示取消订阅通知页面 GET /api/notifications/unsubscribe
取消订阅通知 POST /api/notifications/unsubscribe
重新订阅通知 POST /api/notifications/resubscribe

警报：未解决的屏幕问题、确认、暂缓与静音

6 个操作，含各自的参数、请求模板和响应。

列出警报 GET /api/alerts
获取警报 GET /api/alerts/{id}
确认警报 POST /api/alerts/{id}/acknowledge
列出警报静音 GET /api/alert-mutes
创建警报静音 POST /api/alert-mutes
删除警报静音 DELETE /api/alert-mutes/{id}

报告：按文件夹和标签的汇总、CSV、XLSX 和 PDF 文件以及邮件定时发送

8 个操作，含各自的参数、请求模板和响应。

列出报告类型 GET /api/reports
获取报告 GET /api/reports/{kind}
列出报告订阅 GET /api/report-subscriptions
创建报告订阅 POST /api/report-subscriptions
获取报告订阅 GET /api/report-subscriptions/{id}
更新报告订阅 PATCH /api/report-subscriptions/{id}
删除报告订阅 DELETE /api/report-subscriptions/{id}
发送报告订阅 POST /api/report-subscriptions/{id}/send

审计日志：每一次配置变更及其变更前和变更后、可验证的哈希链，以及 CSV、XLSX 和 PDF 导出

4 个操作，含各自的参数、请求模板和响应。

列出审计日志 GET /api/audit
获取审计链头 GET /api/audit/head
验证审计日志 GET /api/audit/verify
获取审计条目 GET /api/audit/{id}

Webhooks：签名事件传递

9 个操作，含各自的参数、请求模板和响应。

列出 webhook GET /api/webhooks
创建 webhook POST /api/webhooks
获取 webhook GET /api/webhooks/{id}
更新 Webhook PATCH /api/webhooks/{id}
删除 Webhook DELETE /api/webhooks/{id}
轮换 Webhook 密钥 POST /api/webhooks/{id}/rotate-secret
测试 Webhook POST /api/webhooks/{id}/test
列出 webhook 交付记录 GET /api/webhooks/{id}/deliveries
列出 webhook 交付尝试 GET /api/webhooks/{id}/deliveries/{delivery_id}/attempts

CAP 警报触发器

12 个操作，含各自的参数、请求模板和响应。

列出触发器 GET /api/triggers
创建触发器 POST /api/triggers
获取触发器 GET /api/triggers/{id}
更新触发器 PATCH /api/triggers/{id}
删除触发器 DELETE /api/triggers/{id}
轮换触发器密钥 POST /api/triggers/{id}/rotate-secret
测试触发器 POST /api/triggers/{id}/test
清除触发器 POST /api/triggers/{id}/clear
接收触发 CAP POST /api/triggers/{id}/cap
接收叠加层触发器的推送 POST /api/triggers/{id}/overlay
Head Trigger Overlay HEAD /api/triggers/{id}/overlay
列出触发器的投递记录 GET /api/triggers/{id}/deliveries

播放汇总

4 个操作，含各自的参数、请求模板和响应。

列出播放汇总 GET /api/playback
列出播放记录 GET /api/playback/plays
获取播放总计 GET /api/playback/totals
获取播放完整度 GET /api/playback/completeness

反馈：错误报告和功能请求

6 个操作，含各自的参数、请求模板和响应。

列出错误报告 GET /api/feedback/bugs
报告错误 POST /api/feedback/bugs
列出功能请求 GET /api/feedback/features
请求功能 POST /api/feedback/features
获取反馈线程 GET /api/feedback/{id}
回复反馈线程 POST /api/feedback/{id}/responses

支持

9 个操作，含各自的参数、请求模板和响应。

发送网站联系留言 POST /website/support-messages
支持状态 GET /api/support/status
列出支持对话 GET /api/support/conversations
创建支持对话 POST /api/support/conversations
列出支持消息 GET /api/support/conversations/{id}/messages
回复支持对话 POST /api/support/conversations/{id}/messages
读取支持对话 PUT /api/support/conversations/{id}/read
关闭支持对话 POST /api/support/conversations/{id}/close
流支持消息 GET /stream/support

网站演示请求和预订

7 个操作，含各自的参数、请求模板和响应。

提交网站演示请求 POST /website/demo-requests
获取网站演示请求 GET /website/demo-request
获取网站演示日历 GET /website/demo-calendar
获取网站演示时段 GET /website/demo-slots
预订网站演示 POST /website/demo-bookings
请求网站演示审核 POST /website/demo-review
交换网站演示邀请 POST /website/demo-session

主页浏览器交接

6 个操作，含各自的参数、请求模板和响应。

认领浏览器链接 POST /api/project/browser-links/claim
获取浏览器链接状态 GET /screen/browser-links
开始浏览器链接 POST /screen/browser-links
流浏览器链接事件 GET /stream/browser-links/events
继续浏览器链接 GET /screen/browser-links/continue
获取浏览器链接设置页面 GET /setup

网站设置码

1 个操作，含其参数、请求模板和响应。

获取访客的设置码 POST /website/setup-codes

播放器配对和会话

12 个操作，含各自的参数、请求模板和响应。

开始配对会话 POST /screen/pairing-sessions
流配对事件 GET /stream/pairing-events
完成配对会话 POST /screen/pairing-sessions/complete
创建匿名运行时会话 POST /screen/sessions
创建设备运行时会话 POST /screen/device-sessions
开始本地配对会话 POST /screen/native/pairing-sessions
流原生配对事件 GET /stream/native/pairing-events
完成本地配对会话 POST /screen/native/pairing-sessions/complete
创建本地身份验证挑战 POST /screen/native/identity/challenges
创建本地身份验证运行时会话 POST /screen/native/identity/sessions
创建屏幕链接运行时会话 POST /screen/link-sessions
重置本地身份 POST /screen/native/identity/reset

运行时清单、报告和事件

24 个操作，含各自的参数、请求模板和响应。

交换浏览器配置 POST /screen/browser-provisioning/exchanges
获取运行时 Chrome GET /screen/chrome
获取运行时清单 GET /screen/manifest
流运行时事件 GET /stream/events
创建运行时报告 POST /screen/reports
放置运行时截图 PUT /screen/screenshot
解析广告位 POST /screen/adslots/resolve
报告广告位事件 POST /screen/adslots/events
放置运行时观察 PUT /screen/observation
放置运行时健康状态 PUT /screen/health
放置运行时存储 PUT /screen/storage
放置运行时状态 PUT /screen/status
放置运行时屏幕标签 PUT /screen/screen-label
提交运行时命令结果 POST /screen/commands/{command_id}/result
加入实时会话 POST /screen/live/{live_id}/join
实时会话提议 POST /screen/live/{live_id}/offer
实时会话心跳 POST /screen/live/{live_id}/heartbeat
实时会话已停止 POST /screen/live/{live_id}/stopped
获取运行时屏幕播放列表 GET /screen/playlists
放置运行时屏幕播放列表 PUT /screen/playlist
取消配对运行时 POST /screen/unpair
启动应用发布 POST /screen/manifests/{manifest_revision}/releases/{release_id}/launch
解析一个播放列表循环中的所有动态媒体选择器 POST /screen/manifests/{manifest_revision}/selectors/resolve
获取运行时卡片数据 GET /screen/card-data/{key}

运行时应用 K/V

4 个操作，含各自的参数、请求模板和响应。

列出运行时键值 GET /screen/apps/{application_id}/kv
获取运行时 KV GET /screen/apps/{application_id}/kv/{key}
放置运行时 KV PUT /screen/apps/{application_id}/kv/{key}
删除运行时 KV DELETE /screen/apps/{application_id}/kv/{key}

受保护内容和发布资产

8 个操作，含各自的参数、请求模板和响应。

获取广告决策内容 GET /screen/ad-decisions/{decision_id}
头部广告决策内容 HEAD /screen/ad-decisions/{decision_id}
获取稳定受保护媒体 GET /media/{media_id}
稳定受保护媒体头部 HEAD /media/{media_id}
获取受保护媒体 GET /media/manifests/{manifest_revision}/{media_id}
获取本地 Web 应用包 GET /screen/manifests/{manifest_revision}/releases/{release_id}/package
原生 Web 应用包头部 HEAD /screen/manifests/{manifest_revision}/releases/{release_id}/package
使用启动票据或获取发布资产 GET /{asset_path}

人员和项目控制台

94 个操作，含各自的参数、请求模板和响应。

检查 Dashboard 邀请 POST /api/invitations/inspect
开始仪表板邀请通行密钥 POST /api/invitations/passkey-options
验证仪表盘邀请电子邮件 POST /api/invitations/email-verifications
获取仪表板邀请注册 GET /api/invitations/signup
接受控制台邀请 POST /api/invitations/accept
开始控制台注册通行密钥 POST /api/signups/passkey-options
创建控制台注册 POST /api/signups
切换仪表板项目 PUT /api/session/project
列出控制台成员 GET /api/members
移除控制台成员 DELETE /api/members/{user_id}
列出成员活动 GET /api/members/{user_id}/activity
获取仪表板我的信息 GET /api/me
删除仪表板我 DELETE /api/me
开始仪表板重新认证 POST /api/me/reauthentications
设置仪表板密码 PUT /api/me/password
列出控制台通行密钥 GET /api/me/passkeys
开始仪表板通行密钥注册 POST /api/me/passkeys/options
完成Dashboard通行密钥注册 POST /api/me/passkeys/complete
重命名控制台通行密钥 PATCH /api/me/passkeys/{id}
删除仪表板通行密钥 DELETE /api/me/passkeys/{id}
获取仪表板电子邮件 GET /api/me/email
更改控制台电子邮件 POST /api/me/email/change
请求控制台电子邮件验证 POST /api/me/email/verification
放置控制台注册资料 PUT /api/me/signup-profile
获取控制台应用使用情况 GET /api/applications/{id}/usage
放置仪表板广告库存 POST /api/advertising/inventory/{screen_id}
获取控制台媒体使用情况 GET /api/media/{id}/usage
获取仪表板媒体缩略图 GET /api/media/{id}/thumbnail
仪表板媒体缩略图头部 HEAD /api/media/{id}/thumbnail
Peek 控制台电子邮件验证 GET /api/email/verify
验证仪表盘电子邮件 POST /api/email/verify
开始仪表板通行密钥断言 POST /api/webauthn/assertions
完成Dashboard通行密钥断言 POST /api/webauthn/assertions/complete
创建控制台会话 POST /api/sessions
获取仪表板会话 GET /api/session
注销控制台会话 POST /api/logout
记录入门步骤 POST /api/onboarding/steps
列出控制台智能体 GET /api/agents
列出控制台智能体事件 GET /api/agents/{id}/events
断开控制台智能体连接 POST /api/agents/{id}/disconnect
列出控制台智能体备注 GET /api/agents/{id}/notes
解析控制台智能体备注 POST /api/agents/{id}/notes/{note_id}/resolve
删除仪表板智能体备注 DELETE /api/agents/{id}/notes/{note_id}
列出控制台智能体连接 GET /api/agent-connections/pending
查找控制台代理连接 POST /api/agent-connections/lookup
获取仪表板智能体连接 GET /api/agent-connections/{id}
批准仪表板智能体连接 POST /api/agent-connections/{id}/approve
拒绝 Dashboard 代理连接 POST /api/agent-connections/{id}/deny
获取控制台启动数据 GET /api/dashboard/boot
获取仪表板摘要 GET /api/summary
获取仪表板付款状态 GET /api/billing/payout-status
获取仪表板收据 GET /api/billing/receipts/{id}
获取仪表板余额 GET /api/balance
创建控制台应用预览启动 POST /api/applications/{id}/preview-launches
获取控制台组织 GET /api/organizations/{org_id}
控制台组织项目 GET /api/organizations/{org_id}/projects
列出控制台经销商 GET /api/resellers
注册经销商 POST /api/resellers
获取控制台经销商 GET /api/resellers/{reseller_id}
列出控制台经销商客户 GET /api/resellers/{reseller_id}/customers
创建控制台经销商客户 POST /api/resellers/{reseller_id}/customers
获取控制台经销商客户 GET /api/resellers/{reseller_id}/customers/{org_id}
设置控制台经销商客户套餐 PUT /api/resellers/{reseller_id}/customers/{org_id}/plan
列出控制台经销商客户项目 GET /api/resellers/{reseller_id}/customers/{org_id}/projects
加入控制台经销商客户项目 POST /api/resellers/{reseller_id}/customers/{org_id}/projects/{project_id}/access
获取控制台经销商对账单 GET /api/resellers/{reseller_id}/statement
结束控制台组织经销商 DELETE /api/organizations/{org_id}/reseller
控制台组织发现 GET /api/organizations/{org_id}/discovery
控制台组织启动域名 POST /api/organizations/{org_id}/domain-challenges
控制台组织验证域名 POST /api/organizations/{org_id}/domain-verification
控制台组织管理员 GET /api/organizations/{org_id}/admins
控制台组织设置管理员 PUT /api/organizations/{org_id}/admins
控制台组织成员 GET /api/organizations/{org_id}/people
控制台组织列出管理员邀请 GET /api/organizations/{org_id}/admin-invitations
控制台组织创建管理员邀请 POST /api/organizations/{org_id}/admin-invitations
控制台组织撤销管理员邀请 POST /api/organizations/{org_id}/admin-invitations/{invitation_id}/revoke
控制台组织列出成员邀请 GET /api/organizations/{org_id}/member-invitations
控制台组织创建成员邀请 POST /api/organizations/{org_id}/member-invitations
控制台组织撤销成员邀请 POST /api/organizations/{org_id}/member-invitations/{invitation_id}/revoke
控制台组织移除成员 DELETE /api/organizations/{org_id}/members/{user_id}
控制台组织设置访客策略 PUT /api/organizations/{org_id}/guest-policy
控制台组织设置媒体库 PUT /api/organizations/{org_id}/library
控制台组织设置项目访问 POST /api/organizations/{org_id}/project-access
控制台组织加入项目 POST /api/organizations/{org_id}/projects/{project_id}/access
控制台组织设置项目所有者 PUT /api/organizations/{org_id}/projects/{project_id}/owner
控制台组织移除项目成员 DELETE /api/organizations/{org_id}/projects/{project_id}/members/{user_id}
控制台组织移除一个域名 DELETE /api/organizations/{org_id}/domains/{domain}
设置仪表板成员审批人 PUT /api/members/{user_id}/approver
设置控制台成员屏幕范围 PUT /api/members/{user_id}/screen-scope
清除控制台成员屏幕范围 DELETE /api/members/{user_id}/screen-scope
设置控制台智能体屏幕范围 PUT /api/agents/{id}/screen-scope
清除控制台智能体屏幕范围 DELETE /api/agents/{id}/screen-scope
设置控制台成员上传范围 PUT /api/members/{user_id}/upload-scope
清除控制台成员上传范围 DELETE /api/members/{user_id}/upload-scope

API 生命周期、弃用和速率限制

URL系列包括/api、/screen、/stream、/media、/website、/agentid。主版本内兼容更改：

加法端点和方法。
可选请求成员。
新的问题代码。
仅在发布的架构允许未知字段时新增字段。
移除仅返回错误或无客户端调用的操作。
移除没有客户端使用的响应字段。

这些更改需要新的主版本：

工作路由或客户端调用字段的移除或重命名。
类型、含义或授权更改。
将可选输入设为必填。
向封闭枚举添加成员。
向封闭响应对象添加字段。

新主版本至少重叠 180 天。日落通知至少 90 天，弃用操作自 RFC 9745 弃用生效日起至少继续提供 90 天，除非后续发布的承诺另有规定。

当前无弃用操作。

生命周期信号包括：

OpenAPI 在操作上标记为已弃用。
RFC 9745 废弃及其生效日期。
RFC 8594 一旦确定日落日期即停止使用。
带有 rel=deprecation 的链接到迁移文档。

速率限制字段

带有公开固定窗口控制的操作声明了x-rate-limit-policies。符合条件的允许响应可能包括可选的RateLimit-Policy和RateLimit结构化字段列表成员。完全重放和无共享许可的部署可能省略它们。固定窗口拒绝包含它们；并发和字节预算拒绝可能省略它们。这些字段遵循draft-ietf-httpapi-ratelimit-headers-11，这是一个Internet-Draft而非RFC。在每个429上，Retry-After是权威的。

RFC 9457 问题

错误使用 application/problem+json。分支于 status 和稳定的 code；将 detail 视为说明。由 problems.yaml 生成。

project_required

400 · 请选择一个项目

类型：https://screenrig.ai/problems/project-required

free_organization_limit

409 · 免费组织限制已达上限

类型：https://screenrig.ai/problems/free-organization-limit

organization_plan_required

409 · 组织需要订阅计划后才能接纳屏幕

类型：https://screenrig.ai/problems/organization-plan-required

project_name_conflict

409 · 组织中项目名称已被使用

类型：https://screenrig.ai/problems/project-name-conflict

project_delete_blocked

409 · 当前状态下无法删除项目

类型：https://screenrig.ai/problems/project-delete-blocked

owner_required

409 · 需要负责人

类型：https://screenrig.ai/problems/owner-required

owner_cannot_leave

409 · 项目所有者无法离开

类型：https://screenrig.ai/problems/owner-cannot-leave

internal_error

500 · 服务器内部错误

类型：https://screenrig.ai/problems/internal-error

invalid_request

400 · 请求无效

类型：https://screenrig.ai/problems/invalid-request

unauthorized

401 · 需要身份验证

类型：https://screenrig.ai/problems/unauthorized

credential_retired

401 · 凭据已废止

类型：https://screenrig.ai/problems/credential-retired

client_update_required

410 · 请更新 screenRIG 插件或 CLI

类型：https://screenrig.ai/problems/client-update-required

forbidden

403 · 请求不被允许

类型：https://screenrig.ai/problems/forbidden

insufficient_access

403 · 此访问级别无法执行此操作

类型：https://screenrig.ai/problems/insufficient-access

outside_upload_scope

403 · 超出此上传者的播放列表和文件夹范围

类型：https://screenrig.ai/problems/outside-upload-scope

outside_screen_scope

403 · 超出此成员的屏幕范围

类型：https://screenrig.ai/problems/outside-screen-scope

protected_target

409 · 受保护的屏幕不能以这种方式更改

类型：https://screenrig.ai/problems/protected-target

second_approver_required

403 · 需要第二位审批人来决定此审核

类型：https://screenrig.ai/problems/second-approver-required

reserved_item

403 · 此活动已预留

类型：https://screenrig.ai/problems/reserved-item

approver_required

403 · 只有审批人可以执行此操作

类型：https://screenrig.ai/problems/approver-required

review_not_pending

409 · 审核不再处于待处理状态

类型：https://screenrig.ai/problems/review-not-pending

review_stale

409 · 提议之后主体已更改

类型：https://screenrig.ai/problems/review-stale

review_blocked

409 · 必须先决定另一个审核

类型：https://screenrig.ai/problems/review-blocked

playlist_not_approved

409 · 播放列表无已批准版本

类型：https://screenrig.ai/problems/playlist-not-approved

media_pending_review

409 · 媒体项正在等待人员审核

类型：https://screenrig.ai/problems/media-pending-review

media_sync_source_refused

409 · 媒体同步来源拒绝了该请求

类型：https://screenrig.ai/problems/media-sync-source-refused

media_sync_source_unavailable

500 · 无法连接到媒体同步来源

类型：https://screenrig.ai/problems/media-sync-source-unavailable

canva_not_configured

409 · Canva 尚未配置

类型：https://screenrig.ai/problems/canva-not-configured

canva_reconnect_required

409 · 需要连接 Canva 账户

类型：https://screenrig.ai/problems/canva-reconnect-required

dropbox_not_configured

409 · Dropbox 未配置

类型：https://screenrig.ai/problems/dropbox-not-configured

dropbox_reconnect_required

409 · 需要连接 Dropbox 账户

类型：https://screenrig.ai/problems/dropbox-reconnect-required

google_drive_not_configured

409 · Google Drive 未配置

类型：https://screenrig.ai/problems/google-drive-not-configured

media_sync_sharer_not_member

403 · 该文件夹不是由项目成员共享的

类型：https://screenrig.ai/problems/media-sync-sharer-not-member

not_found

404 · 未找到资源

类型：https://screenrig.ai/problems/not-found

method_not_allowed

405 · 方法不被允许

类型：https://screenrig.ai/problems/method-not-allowed

idempotency_mismatch

409 · 幂等键与原始请求不匹配

类型：https://screenrig.ai/problems/idempotency-mismatch

credential_issuance_expired

410 · 凭证签发已过期

类型：https://screenrig.ai/problems/credential-issuance-expired

user_email_conflict

409 · 电子邮件地址属于其他人员

类型：https://screenrig.ai/problems/user-email-conflict

provisioning_invalid

404 · 浏览器配置无效

类型：https://screenrig.ai/problems/provisioning-invalid

provisioning_expired

410 · 浏览器配置已过期

类型：https://screenrig.ai/problems/provisioning-expired

provisioning_consumed

409 · 浏览器配置已使用

类型：https://screenrig.ai/problems/provisioning-consumed

provisioning_exchange_mismatch

409 · 浏览器配置交换不匹配

类型：https://screenrig.ai/problems/provisioning-exchange-mismatch

browser_already_paired

409 · 浏览器已配对

类型：https://screenrig.ai/problems/browser-already-paired

handoff_code_invalid

404 · 浏览器交接代码无效

类型：https://screenrig.ai/problems/handoff-code-invalid

handoff_code_expired

410 · 浏览器交接码已过期

类型：https://screenrig.ai/problems/handoff-code-expired

handoff_session_rate_limited

429 · 浏览器交接会话限流

类型：https://screenrig.ai/problems/handoff-session-rate-limited

handoff_session_conflict

409 · 浏览器交接会话冲突

类型：https://screenrig.ai/problems/handoff-session-conflict

browser_link_not_claimed

409 · 浏览器链接未被认领

类型：https://screenrig.ai/problems/browser-link-not-claimed

browser_link_project_mismatch

403 · 浏览器链接项目不匹配

类型：https://screenrig.ai/problems/browser-link-project-mismatch

origin_not_allowed

403 · 来源不被允许

类型：https://screenrig.ai/problems/origin-not-allowed

resource_conflict

409 · 资源状态与请求冲突

类型：https://screenrig.ai/problems/resource-conflict

card_not_found

404 · 找不到卡片

类型：https://screenrig.ai/problems/card-not-found

card_invalid

400 · 卡片位置无效

类型：https://screenrig.ai/problems/card-invalid

card_layout_invalid

400 · 卡片布局无效

类型：https://screenrig.ai/problems/card-layout-invalid

card_layout_conflict

400 · 页面上的卡片声明了相同的位置

类型：https://screenrig.ai/problems/card-layout-conflict

card_data_invalid

409 · 卡片数据文档不适合读取它的卡片

类型：https://screenrig.ai/problems/card-data-invalid

source_limit_reached

409 · 组织的数据源数量已达上限

type: https://screenrig.ai/problems/source-limit-reached

source_target_unsupported

422 · 该数据源无法填充这张卡片

type: https://screenrig.ai/problems/source-target-unsupported

source_target_taken

409 · 已有另一个数据源在填充这张卡片

type: https://screenrig.ai/problems/source-target-taken

source_busy

409 · 数据源的同步正在运行

type: https://screenrig.ai/problems/source-busy

source_has_no_rooms

409 · 此类数据源不提供房间

type: https://screenrig.ai/problems/source-has-no-rooms

source_secret_required

400 · 数据源的密钥缺失或已不再适用

type: https://screenrig.ai/problems/source-secret-required

source_test_failed

422 · 数据源预览失败

type: https://screenrig.ai/problems/source-test-failed

connection_app_not_configured

409 · 此提供商未配置 screenRIG 的应用

类型：https://screenrig.ai/problems/connection-app-not-configured

connection_limit_reached

409 · 组织已达到最大连接数

类型：https://screenrig.ai/problems/connection-limit-reached

card_media_invalid

400 · 卡片媒体引用未指定准备好的图像

类型：https://screenrig.ai/problems/card-media-invalid

revision_conflict

412 · 资源版本不匹配

类型：https://screenrig.ai/problems/revision-conflict

invalid_range

416 · 请求的字节范围不可满足

类型：https://screenrig.ai/problems/invalid-range

quota_exceeded

413 · 项目内容配额已超限

类型：https://screenrig.ai/problems/quota-exceeded

payment_required

402 · 需要使用额度

类型：https://screenrig.ai/problems/payment-required

reseller_generation_limit

402 · 已达到经销商的图像生成上限

类型：https://screenrig.ai/problems/reseller-generation-limit

feature_not_in_plan

402 · 此功能不在项目的计划中

类型：https://screenrig.ai/problems/feature-not-in-plan

rate_limited

429 · 请求速率过高

类型：https://screenrig.ai/problems/rate-limited

revocation_unavailable

500 · 凭证吊销状态不可用

类型：https://screenrig.ai/problems/revocation-unavailable

dependency_unavailable

500 · 所需依赖不可用

类型：https://screenrig.ai/problems/dependency-unavailable

dependency_timeout

500 · 所需依赖未及时响应

类型：https://screenrig.ai/problems/dependency-timeout

schema_incompatible

500 · 数据库架构不兼容

类型：https://screenrig.ai/problems/schema-incompatible

not_ready

500 · 服务尚未就绪

类型：https://screenrig.ai/problems/not-ready

server_draining

421 · 服务正在排空

类型：https://screenrig.ai/problems/server-draining

manifest_degraded

500 · 运行时清单投影已降级

类型：https://screenrig.ai/problems/manifest-degraded

screenshot_unavailable

409 · 截图不可用

类型：https://screenrig.ai/problems/screenshot-unavailable

identity_invalid

400 · 播放器公钥无效

类型：https://screenrig.ai/problems/identity-invalid

identity_conflict

409 · 播放器公钥与注册信息不匹配

类型：https://screenrig.ai/problems/identity-conflict

enrollment_bound

409 · 播放器公钥已绑定到项目

类型：https://screenrig.ai/problems/enrollment-bound

proof_invalid

401 · 播放器身份验证无效

类型：https://screenrig.ai/problems/proof-invalid

screen_archived

409 · 屏幕已归档

类型：https://screenrig.ai/problems/screen-archived

screen_archive_required

409 · 归档屏幕，而不是删除或解绑

类型：https://screenrig.ai/problems/screen-archive-required

passkey_invalid

401 · 通行密钥流程无效

类型：https://screenrig.ai/problems/passkey-invalid

passkey_unknown

401 · 此通行密钥已不再注册

类型：https://screenrig.ai/problems/passkey-unknown

passkeys_disabled

403 · 此服务器禁用通行密钥

类型：https://screenrig.ai/problems/passkeys-disabled

application_in_use

409 · 仍有活动清单引用应用发布

类型：https://screenrig.ai/problems/application-in-use

agent_connection_invalid

404 · 智能体连接无效

类型：https://screenrig.ai/problems/agent-connection-invalid

agent_connection_code_mismatch

400 · 代码与此登录不匹配

类型：https://screenrig.ai/problems/agent-connection-code-mismatch

agent_connection_expired

410 · 智能体连接已过期

类型：https://screenrig.ai/problems/agent-connection-expired

agent_connection_conflict

409 · 智能体连接已解决

类型：https://screenrig.ai/problems/agent-connection-conflict

agent_connection_not_approved

409 · 智能体连接未获批准

类型：https://screenrig.ai/problems/agent-connection-not-approved

agent_limit_exceeded

409 · 超过智能体限制

类型：https://screenrig.ai/problems/agent-limit-exceeded

agent_lockout_risk

409 · 断开最后一个活动智能体可能导致锁定

类型：https://screenrig.ai/problems/agent-lockout-risk

recovery_ambiguous

409 · 设备标识符已绑定到多个屏幕

类型：https://screenrig.ai/problems/recovery-ambiguous

recovery_expired

410 · 屏幕恢复提议已过期

类型：https://screenrig.ai/problems/recovery-expired

recovery_not_offered

404 · 没有待处理的屏幕恢复

类型：https://screenrig.ai/problems/recovery-not-offered

invitation_limit_reached

409 · 组织已达到最大未处理邀请数

类型：https://screenrig.ai/problems/invitation-limit-reached

organization_admin_limit

409 · 组织管理员限制已达上限

类型：https://screenrig.ai/problems/organization-admin-limit

library_no_screens

409 · 有屏幕的项目不能用作媒体库

类型：https://screenrig.ai/problems/library-no-screens

guest_not_allowed

403 · 组织不准许此人作为访客

类型：https://screenrig.ai/problems/guest-not-allowed

managed_member

409 · 身份提供者管理此人员

类型：https://screenrig.ai/problems/managed-member

organization_admin_member

409 · 此成员是组织管理员

类型：https://screenrig.ai/problems/organization-admin-member

member_owns_projects

409 · 此成员拥有组织中的项目

类型：https://screenrig.ai/problems/member-owns-projects

managed_elsewhere

409 · 另一个组织管理此人员

类型：https://screenrig.ai/problems/managed-elsewhere

version_required

409 · 播放列表需要更新的 API 版本

类型：https://screenrig.ai/problems/version-required

price_change_pending

409 · 广告活动暂停，等待接受新费率

类型：https://screenrig.ai/problems/price-change-pending

quote_stale

409 · 广告报价已过期或失效

类型：https://screenrig.ai/problems/quote-stale

insufficient_credits

402 · 可用额度不足

类型：https://screenrig.ai/problems/insufficient-credits

self_deal

409 · 项目不能在自己的网络中购买广告

类型：https://screenrig.ai/problems/self-deal

goal_overbooked

409 · 目标大于可用播放次数

type: https://screenrig.ai/problems/goal-overbooked

invitation_invalid

404 · 邀请无效

类型：https://screenrig.ai/problems/invitation-invalid

invitation_expired

410 · 邀请已过期

类型：https://screenrig.ai/problems/invitation-expired

invitation_consumed

409 · 邀请已被接受

类型：https://screenrig.ai/problems/invitation-consumed

invitation_email_mismatch

403 · 邀请属于不同的电子邮件地址

类型：https://screenrig.ai/problems/invitation-email-mismatch

reauthentication_required

401 · 需要新的登录证明

类型：https://screenrig.ai/problems/reauthentication-required

member_limit_reached

409 · 项目成员已达最大数

类型：https://screenrig.ai/problems/member-limit-reached

project_limit_reached

409 · 组织已达到最大项目数

type: https://screenrig.ai/problems/project-limit-reached

billed_by_reseller

409 · 该组织通过其经销商计费

类型：https://screenrig.ai/problems/billed-by-reseller

reseller_conflict

409 · 该组织不能承担该经销商角色

类型：https://screenrig.ai/problems/reseller-conflict

last_credential

409 · 无法移除最后一次登录方式

类型：https://screenrig.ai/problems/last-credential

sso_required

403 · 此地址通过其身份提供者登录

类型：https://screenrig.ai/problems/sso-required

no_project

409 · 未选择当前项目

类型：https://screenrig.ai/problems/no-project

feature_unavailable

404 · 此功能在此服务器上不可用

类型：https://screenrig.ai/problems/feature-unavailable

user_binding_stale

409 · 认领用户电子邮件绑定已过期

类型：https://screenrig.ai/problems/user-binding-stale

session_expired

401 · 运行时会话已过期或不再有效

类型：https://screenrig.ai/problems/session-expired

credential_revoked

401 · 设备凭据不再将此设备绑定到屏幕

类型：https://screenrig.ai/problems/credential-revoked

screen_link_invalid

401 · 屏幕链接无效

类型：https://screenrig.ai/problems/screen-link-invalid

screen_link_not_found

404 · 屏幕没有链接

类型：https://screenrig.ai/problems/screen-link-not-found

proof_clock_skew

401 · 播放器身份验证超出接受的时间窗口

类型：https://screenrig.ai/problems/proof-clock-skew

key_retired

401 · 播放器密钥已被替换且宽限期已结束

类型：https://screenrig.ai/problems/key-retired

assignment_not_found

404 · 屏幕没有播放列表分配

类型：https://screenrig.ai/problems/assignment-not-found

upgrade_required

403 · 播放器版本低于支持的最低版本

类型：https://screenrig.ai/problems/upgrade-required

reboot_unsupported

409 · 屏幕无法远程重启

类型：https://screenrig.ai/problems/reboot-unsupported

command_unsupported

409 · 屏幕无法远程执行此操作

类型：https://screenrig.ai/problems/command-unsupported

play_page_unsupported

409 · 屏幕无法按请求播放页面

类型：https://screenrig.ai/problems/play-page-unsupported

identify_unsupported

409 · 屏幕无法标识自身

类型：https://screenrig.ai/problems/identify-unsupported

page_not_on_screen

409 · 页面不在屏幕播放的播放列表中

类型：https://screenrig.ai/problems/page-not-on-screen

live_unsupported

409 · 屏幕无法显示实时视图

类型：https://screenrig.ai/problems/live-unsupported

live_unavailable

409 · 此屏幕无法使用实时视图

类型：https://screenrig.ai/problems/live-unavailable

live_not_ready

409 · 屏幕尚未开始推流

类型：https://screenrig.ai/problems/live-not-ready

live_session_ended

410 · 实时会话已结束

类型：https://screenrig.ai/problems/live-session-ended

wall_unsupported

409 · 屏幕无法布局视频墙

类型：https://screenrig.ai/problems/wall-unsupported

playlist_format_mismatch

409 · 播放列表格式与屏幕视频墙不匹配

类型：https://screenrig.ai/problems/playlist-format-mismatch

primitive_locked

403 · 已锁定的元素只有可以审批的人才能更改

类型：https://screenrig.ai/problems/primitive-locked

playlist_is_template

409 · 该播放列表是模板

类型：https://screenrig.ai/problems/playlist-is-template

webhook_limit_reached

409 · 组织已达到最大 webhook 数

类型：https://screenrig.ai/problems/webhook-limit-reached

alert_not_open

409 · 警报未处于打开状态

type: https://screenrig.ai/problems/alert-not-open

alert_mute_limit_reached

409 · 组织的静音数已达上限

type: https://screenrig.ai/problems/alert-mute-limit-reached

notification_limit_reached

409 · 组织的通知数已达上限

type: https://screenrig.ai/problems/notification-limit-reached

notification_covers_other_projects

409 · 通知覆盖其他项目

类型：https://screenrig.ai/problems/notification-covers-other-projects

report_subscription_limit_reached

409 · 组织的报告订阅数已达上限

type: https://screenrig.ai/problems/report-subscription-limit-reached

fleet_link_limit_reached

409 · 组织已达到最大车队链接数

类型：https://screenrig.ai/problems/fleet-link-limit-reached

webhook_url_rejected

400 · Webhook URL 必须是公共互联网主机上的 HTTPS

类型：https://screenrig.ai/problems/webhook-url-rejected

notification_destination_rejected

400 · 通知目标对其渠道无效

类型：https://screenrig.ai/problems/notification-destination-rejected

document_not_shared

400 · 该文档要求查看者登录

type: https://screenrig.ai/problems/document-not-shared

note_contains_credential

422 · 备注文本包含凭证

类型：https://screenrig.ai/problems/note-contains-credential

note_rejected

422 · 备注文本被拒绝

类型：https://screenrig.ai/problems/note-rejected

note_not_open

409 · 备注未开启

类型：https://screenrig.ai/problems/note-not-open

note_limit_reached

409 · 组织已达到最大未关闭备注数

类型：https://screenrig.ai/problems/note-limit-reached

trigger_limit_reached

409 · 组织已达到最大触发器数

类型：https://screenrig.ai/problems/trigger-limit-reached

bi_upstream_refused

409 · BI 系统拒绝了该连接

类型：https://screenrig.ai/problems/bi-upstream-refused

bi_upstream_unavailable

500 · 无法连接到 BI 系统

类型：https://screenrig.ai/problems/bi-upstream-unavailable

bi_web_unavailable

409 · 此服务器没有页面渲染器

类型：https://screenrig.ai/problems/bi-web-unavailable

schedule_import_invalid

422 · 导入含有错误行

类型：https://screenrig.ai/problems/schedule-import-invalid

schedule_import_stale

409 · 项目自预览后已更改

类型：https://screenrig.ai/problems/schedule-import-stale

campaign_limit_reached

409 · 组织已达到最大活动数量

type: https://screenrig.ai/problems/campaign-limit-reached

kv_webhook_limit_reached

409 · 应用已达到最大键值 webhook 数量

类型：https://screenrig.ai/problems/kv-webhook-limit-reached

support_conversation_closed

409 · 支持对话已关闭

类型：https://screenrig.ai/problems/support-conversation-closed

submission_too_short

422 · 提交内容过短无法处理

类型：https://screenrig.ai/problems/submission-too-short

submission_unclear

422 · 提交未描述问题或请求

类型：https://screenrig.ai/problems/submission-unclear

submission_rejected

422 · 提交未被接受

类型：https://screenrig.ai/problems/submission-rejected

submission_screening_unavailable

500 · 当前无法筛查提交内容

类型：https://screenrig.ai/problems/submission-screening-unavailable

demo_slot_unavailable

409 · 演示时间不再可用

类型：https://screenrig.ai/problems/demo-slot-unavailable

agentid_claim_invalid

400 · AgentID 声明无效或已过期

类型：https://screenrig.ai/problems/agentid-claim-invalid

agentid_already_enrolled

409 · AgentID 已注册

类型：https://screenrig.ai/problems/agentid-already-enrolled

account_exists

409 · 此电子邮件已有 screenRIG 账户

类型：https://screenrig.ai/problems/account-exists

email_verification_required

403 · 验证你的电子邮件以继续

类型：https://screenrig.ai/problems/email-verification-required

unverified_account_replacement

409 · 此重置会创建一个新的空账户

类型：https://screenrig.ai/problems/unverified-account-replacement

app_store_transaction_invalid

422 · 无法验证 App Store 购买

类型：https://screenrig.ai/problems/app-store-transaction-invalid

app_store_account_mismatch

409 · 该购买属于另一个组织

类型：https://screenrig.ai/problems/app-store-account-mismatch

education_not_eligible

403 · 组织不符合 Education 套餐的条件

类型：https://screenrig.ai/problems/education-not-eligible

app_store_plan_conflict

409 · 组织已拥有套餐

类型：https://screenrig.ai/problems/app-store-plan-conflict

诊断和合同源

捆绑的 CLI 诊断保持授权、Cookie、签名上传详情、对象标识符和客户内容不出现在保留输出中。原始 OpenAPI 文档是 HTTP 的真实来源。

架构索引

生成名称、必填字段和模式描述；完整 JSON Schema 请使用原始 OpenAPI。

架构索引