List Agents instances

GET/api/agents/v1

Lists the Agents instances this key can use within its organization and optional project restriction. Cloud owns the product directory and pagination; no runtime call is made, so a suspended or expired instance remains visible with its saved status. Use an instance ID from this page as the {instanceId} path value. Only owner or admin keys are allowed.

组织 API Key 鉴权

Authorization: Bearer $SINECLOUD_API_KEY

所需权限: agentRun

参数

limit · query · 可选: Maximum instances per page.
cursor · query · 可选: Unmodified nextCursor from the previous page.

响应

200: Agents instance page visible to this key.
401: Missing, invalid or revoked organization API key.
403: Product scope, instance, project, workspace or current entitlement denied.

正在加载 API 参考文档…

Agents · 接入与鉴权

基础 URLhttps://sinecloud.dev/api/agents/v1/{instanceId}

打开控制台 · 创建 API 密钥 · 查看所有 API

下载 API 索引

首次调用前

在控制台选择组织、准备资源，并创建具有所需产品权限范围的组织 API Key。每次调用都会检查当前权限、资源访问权限、预算和可用资金。

在控制台选择 Agents 实例和 Agent，将 instanceId 替换为实际实例 ID，并按接口要求发送 OpenAI-Beta: agents=v1。接口目录涵盖可复用 Agent、会话、输入事件、持久化消息与轮次、模型发现、用量和运行时能力。保留原生 JSON 与实时 SSE 响应；断线重连不会重放事件，请先查询已保存的会话状态再提交任务。

密钥需要 agentRun 及所选实例的访问权限。托管会话还需要 sandboxRun 及当前工作区权限。关联 Box 时，也必须通过 Box 的资源和项目权限检查。

组织密钥鉴权与基础 URL

产品 API 的生产源地址是 https://sinecloud.dev，不是文档站点。路径前缀为 /api/agents/v1/{instanceId}。请使用接口注明的完整路径，并将资源 ID、模型与端点版本替换为实际值。

Authorization: Bearer $SINECLOUD_API_KEY

将 SINECLOUD_API_KEY 设置为你自己的环境变量值，切勿使用平台服务凭据。各接口的 x-sinecloud-scopes 会注明所需的权限范围。

此文档为只读参考，请在控制台或自己的客户端中发起请求。浏览文档不会创建密钥、启动执行或产生执行费用。请保留请求 ID 和执行回执；连接中断不会取消任务，再次提交前请按接口说明恢复并确认状态。