OpenAPI YAMLOpenAPI JSON问题 YAMLAPI 概览
此分组有 3 个操作,由 api/openapi.yaml 生成。可按路径、操作或认证筛选。每个端点都会列出其输入;展开后可查看请求模板和响应代码。模板需要您自己的值和符合架构的请求体。
用你的值替换大写占位符。对于JSON请求,请保存符合request.json模式的请求体。Cookie示例使用经过身份验证会话的本地Cookie存储。
智能体安装和连接
撤销代理身份
撤销全局身份、所有身份凭证和项目令牌及其待处理连接。使用已撤销的身份凭证精确重放将成功且无其他状态变更。项目所有权和内容保持不变。不接受 Cookie、Origin、查询或请求体。此路由不计入 API 计量。
携带 identity 范围的代理访问 JWT,其授权持有身份访问权限(只读、提议或管理,取决于令牌项目的访问级别),撤销相同及该身份的所有 OAuth 授权;其令牌在几秒内被拒绝。撤销后使用相同 JWT 重试为无操作成功。
请求模板和响应
curl --request POST 'https://api.screenrig.ai/api/agent-identity/revoke'响应
| 状态 | 含义 | 正文和头部 |
|---|---|---|
| 204 | 身份已撤销。 | 无正文;头部:Cache-Control |
| 默认 | 稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After,500 not_ready 或 dependency_unavailable 携带 5 秒,500 manifest_degraded 携带 60 秒,除非处理程序设置了更具体的值。 | 问题 (application/problem+json) |
获取当前智能体
返回与调用项目持有者关联的代理安装及 connection_ready。当至少一名成员拥有 passkey 或密码时,项目即为就绪。身份状态为诊断信息,不计入 API 计量。
参数
| 名称 | 发送 | 必需? | 描述 |
|---|---|---|---|
| ScreenRig-Project | header | 可选 | 已弃用一个版本。必须与 JWT 项目授权保持一致;添加弃用和警告头。无令牌交换。 |
请求模板和响应
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/agents/self'响应
| 状态 | 含义 | 正文和头部 |
|---|---|---|
| 200 | 当前智能体和项目连接就绪状态。 | AgentSelfStatus(application/json);头信息:Cache-Control |
| 默认 | 稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After,500 not_ready 或 dependency_unavailable 携带 5 秒,500 manifest_degraded 携带 60 秒,除非处理程序设置了更具体的值。 | 问题 (application/problem+json) |
断开当前智能体连接
仅撤销调用项目的成员资格及其项目令牌,保留全局身份、其他成员资格、项目和内容。使用相同的加密有效撤销承载者重复调用为无操作成功。断开最后一个活动智能体将返回 agent_lockout_risk,除非明确允许 allow_last_agent。不计入 API 计量。
代理访问 JWT(包括只读)断开代理与其令牌项目的连接;成员关系结束,项目同意离开代理授权,该身份/项目对旧访问令牌被切断。令牌中的其他项目继续工作。断开后使用相同 JWT 重试为无操作成功。
参数
| 名称 | 发送 | 必需? | 描述 |
|---|---|---|---|
| ScreenRig-Project | header | 可选 | 已弃用一个版本。必须与 JWT 项目授权保持一致;添加弃用和警告头。无令牌交换。 |
请求主体字段
| 字段 | 描述 |
|---|---|
| allow_last_agent(可选,布尔值) | 显式接受最后活跃代理持有者的丢失。注册的控制台 passkey 保持独立管理权限。默认:false |
请求模板和响应
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/agents/self/disconnect'响应
| 状态 | 含义 | 正文和头部 |
|---|---|---|
| 204 | 智能体已断开连接。 | 无正文;头部:Cache-Control |
| 401 | 稳定的 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) |
| 默认 | 稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After,500 not_ready 或 dependency_unavailable 携带 5 秒,500 manifest_degraded 携带 60 秒,除非处理程序设置了更具体的值。 | 问题 (application/problem+json) |