跳转到正文
AgentsOpenAPI

List reusable agents

GET/api/agents/v1/{instanceId}

List reusable agents

组织 API Key 鉴权

Authorization: Bearer $SINECLOUD_API_KEY

所需权限: agentRun

参数

instanceId · path · 必填
An accessible Agents instance from the Console.
after · query · 可选
limit · query · 可选
order · query · 可选
OpenAI-Beta · header · 必填

响应

200
Success
400
Invalid or unsupported request
401
Missing, invalid or revoked organization API key.
402
Insufficient funds or execution budget.
403
Product scope, instance, project, workspace or current entitlement denied.
404
Resource not found in this scope
409
State or idempotency conflict
413
Request body exceeds the route limit.
429
Rate or quota limit reached. Respect Retry-After when supplied.
501
Capability not implemented
502
Runtime response unavailable; read durable session state before attempting more execution.
503
Runtime, deployment, model or billing admission unavailable.
504
Gateway deadline exceeded; execution may have started. Inspect durable state before another submission.

正在加载 API 参考文档…

Agents · 接入与鉴权

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

首次调用前

在控制台选择组织、准备资源,并创建具有所需产品权限范围的组织 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 和执行回执;连接中断不会取消任务,再次提交前请按接口说明恢复并确认状态。

控制台

输入关键词开始搜索…

↑↓ 移动↵ 选择Esc 关闭