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

> ## Agent Instructions
> To set up offstage cloud from a coding agent, read https://api.offstage.cloud/SKILL.md and follow it. The whole API guide is one file at https://api.offstage.cloud/llms.txt.

# API overview

> The base URL, ids, times and money: what every call shares.

> Real Macs for AI agents and CI, over HTTP. A sandbox is one macOS user account on an Apple silicon machine, held for you and driven one call at a time: run a command, write a file, read one back, kill it. GUI sandboxes run computer-use agents on their own desktop: take screenshots and send clicks, keys and text from wherever your agent runs, hand Claude a goal to carry out on the screen, or run your own agent on the Mac. A task is fire-and-forget: clone a repo, run a command, collect artifacts. A GitHub Actions job with `runs-on: offstage-macos` runs on a fresh Mac too, once its organization is connected in the console. Every call is JSON under `https://api.offstage.cloud/v1`; one call creates a sandbox, which waits for an available Mac slot. An idle headless slot was measured at roughly 0.1 seconds to its first command; loaded or unavailable slots can take longer. Billing is per second: $0.0183 a minute ($1.10 an hour) for each sandbox or task, no minimum.

**Current public availability:** Headless and GUI sandboxes are available. Use `session: "headless"` for commands without windows, or `session: "gui"` for apps, screenshots and computer-use agents. GUI work needs a ready desktop slot; check `/v1/capacity`. Handing Claude a goal (`POST /v1/sandboxes/:id/agent`) requires your Anthropic API key.

**Credit and payments:** A new personal account gets \$5 of signup credit, once per person; organization teams get no additional signup credit. When credit runs out, an owner adds more by card in the console under Billing, or turns on auto-reload. Work is prepaid; saving a card does not extend credit.

The agent setup guide (key handoff, install, a verified first run, troubleshooting) is at `https://api.offstage.cloud/SKILL.md`. The JavaScript SDK installs with `npm install https://api.offstage.cloud/sdk/offstage-cloud-0.3.4.tgz`.

The OpenAPI 3.1 spec of every customer route, with request and response schemas and each route's error codes, is at `https://api.offstage.cloud/openapi.json`.

| | |
| - | - |
| Base URL | `https://api.offstage.cloud`. Every API route starts with `/v1` |
| Auth | `Authorization: Bearer sk_offstage_…` (a team API key) |
| Bodies | JSON with `content-type: application/json`. File writes send the raw bytes as the body. A field a task, sandbox, command or timeout body does not know is refused with 400 `unknown-field`, so a typo is never silently ignored |
| Times | Unix milliseconds (`createdAt`, `expiresAt`). Durations end in `Ms` |
| Money | US dollars as numbers (`costUsd`), exact to the micro-dollar |
| Ids | Prefixed and sortable by creation time: `sbx_…` sandbox, `cmd_…` command, `task_…` task, `key_…` API key, `req_…` request, `team_…`, `usr_…`, `box_…` (a fleet Mac), `inv_…` |
| Request id | Every response carries an `x-request-id` header, and every error body repeats it as `requestId`. Quote it when asking for help |
| Lists | Newest first, cursor-paginated. See [Pagination](https://offstage.cloud/docs/api/pagination.md) |
| Creates | `POST /v1/sandboxes` and `POST /v1/tasks` accept an `Idempotency-Key` header. See [Idempotency](https://offstage.cloud/docs/api/idempotency.md) |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.