---
title: "API 参考文档"
description: "查阅 Agents、Box、Powers 和 Gateway 的公开 API、权限、数据结构与 OpenAPI 规范。"
image: "https://docs.sinecloud.dev/opengraph.png"
---

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

# API 参考文档

四个产品共有 84 个公开操作，保留各产品的原生协议和请求、响应结构。选择产品以搜索操作、查看数据结构并复制请求示例。

| 产品 | 路径前缀 | 规范 |
| --- | --- | --- |
| [Agents](/zh-CN/api-reference/agents/) | `/api/agents/v1/{instanceId}` | [OpenAPI JSON](/api/openapi/agents.json) |
| [Box](/zh-CN/api-reference/box/) | `/api/box/v1/{boxId}` | [OpenAPI JSON](/api/openapi/box.json) |
| [Powers](/zh-CN/api-reference/powers/) | `/api/powers/v1` | [OpenAPI JSON](/api/openapi/powers.json) |
| [Gateway](/zh-CN/api-reference/gateway/) | `/api/gateway/v1` | [OpenAPI JSON](/api/openapi/gateway.json) |

## 首次调用前

在[控制台](https://sinecloud.dev/zh-CN/dashboard)选择组织、准备资源，并创建具有所需产品权限的[组织 API Key](/zh-CN/api-keys/)。请使用生产 API 源地址 **https://sinecloud.dev** 加上文档中的完整路径；文档站点不处理产品 API 请求。

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

各接口在 `x-sinecloud-scopes` 中列出所需权限。每次请求还会检查当前成员权限、项目限制、资源访问、预算和可用资金。不要使用平台服务凭据。

## 只读浏览与下载

参考页支持搜索、结构浏览和可分享的操作链接，不会执行请求或保存鉴权凭据。请在控制台或自己的客户端运行请求；断线后请保留请求标识并按接口说明恢复任务。

[下载 API 索引](/api/openapi/index.json)，或通过上表下载独立规范。即使交互式参考加载失败，指南与下载链接也始终可用。

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