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

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

# Box API 参考文档

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

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

[打开控制台](https://sinecloud.dev/zh-CN/dashboard?tab=box) · [创建 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。每次调用都会检查当前权限、资源访问权限、预算和可用资金。

在控制台创建并选择 Box，将 `boxId` 替换为实际 Box 资源 ID，不能使用父级激活记录 ID。接口目录涵盖工作区文件、目录、命令执行、持久化状态、Sandbox 运行窗口和保留备份。Lite 命令无需启动虚拟机；Sandbox 命令需要已明确确认并预留资金的运行窗口，虚拟机空闲分配时间也会计费。文件访问不会启动虚拟机。

按各接口要求授予 `boxRun`、`fileRead` 或 `fileWrite` 等权限。创建备份同时需要 `boxRun` 与 `fileRead`。资源创建、发起恢复和删除备份使用控制台会话。恢复结果不明确的任务时，请保留原始执行标识。

## 组织密钥鉴权与基础 URL

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

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

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


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

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