---
title: "Agents API 参考文档"
description: "鉴权、权限范围、原生操作与结构，以及只读 OpenAPI 参考。"
image: "https://docs.sinecloud.dev/opengraph.png"
---

> 完整文档索引： https://docs.sinecloud.dev/zh-CN/llms.txt

# Agents API 参考文档

<p className="api-reference-endpoint"><span>基础 URL</span><code>{"https://sinecloud.dev/api/agents/v1/{instanceId}"}</code></p>

<div className="api-reference-actions">

[打开控制台](https://sinecloud.dev/zh-CN/dashboard?tab=agents) · [创建 API 密钥](/zh-CN/api-keys/) · [查看所有 API](/zh-CN/api-reference/)

<a href="/api/openapi/index.json" download="sinecloud-api-index.json">下载 API 索引</a>

</div>

## 首次调用前

在控制台选择组织、准备资源，并创建具有所需产品权限范围的组织 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、模型与端点版本替换为实际值。

```http
Authorization: Bearer $SINECLOUD_API_KEY
```

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


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

来源: https://docs.sinecloud.dev/zh-CN/api-reference/agents/index.mdx