---
title: "Box API Reference"
description: "Authentication, scopes, native operations and schemas, and a read-only OpenAPI reference."
image: "https://docs.sinecloud.dev/opengraph.png"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sinecloud.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Box API Reference

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

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

[Open Console](https://sinecloud.dev/en/dashboard?tab=box) · [Create an API key](/api-keys/) · [Browse all APIs](/api-reference/)

<a href="/api/openapi/index.json" download="sinecloud-api-index.json">Download API index</a>

</div>

## Before your first request

Select your organization, prepare resources in Console, and issue an organization API key with the required product scopes. Current permissions, resource access, budget and available funds are checked on every call.

Create and select a Box in Console. Replace `boxId` with the actual Box resource ID, never the parent activation ID. The catalog covers workspace files, directories, command execution, durable status, Sandbox runtime windows and retained backups. Lite commands need no VM start step. Sandbox commands require an explicitly confirmed and funded runtime window; idle allocated VM time is also billed. File access never starts a VM.

Grant the scopes documented on each operation, such as `boxRun`, `fileRead` or `fileWrite`. Creating a backup requires both `boxRun` and `fileRead`. Resource creation, restore initiation and backup deletion use Console sessions. Retain the original execution identity when recovering uncertain work.

## Organization key authentication and base URL

The production API origin is `https://sinecloud.dev`; the documentation origin does not serve product requests. The path prefix is `/api/box/v1/{boxId}`. Use the complete path documented for the operation, replacing resource IDs, models and endpoint revisions with your actual selections.

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

Set SINECLOUD_API_KEY to your own environment variable value; never use platform service credentials. Each operation lists required scopes in `x-sinecloud-scopes`.


This reference is read-only. Run requests in Console or your own client. Browsing documentation never creates a key, starts execution or incurs an execution charge. Keep request IDs and execution receipts; a lost connection does not cancel work. Follow the operation’s recovery instructions before submitting again.

Source: https://docs.sinecloud.dev/api-reference/box/index.mdx