# Reference

Look up CLI commands and the Sandbox customer API.

## Customer API

Base URL: `https://api.runzivo.dev`. The reference covers the nine published Agent Sandbox operations. CLI commands for runners, sandboxes and workspaces are documented separately.

Send a customer access token or workspace API key in `Authorization: Bearer <token>`. Sandbox key permissions are `sandboxes:read` and `sandboxes:write`, not legacy scopes. Keys remain limited by their creator's current workspace permissions.

Set TENANT_ID to your workspace ID. Supply RUNZIVO_TOKEN securely in your own client environment: a customer access token or workspace API key. Examples contain placeholders, not credentials or live account data. Run requests in your own client; this website does not execute them.

cURL · illustrative authenticated request

```
curl "https://api.runzivo.dev/v1/customer/tenants/${TENANT_ID}/sandboxes" \
  --header "Authorization: Bearer ${RUNZIVO_TOKEN}"
```

## Agent Sandboxes

[Sandbox API reference Create, list, read, start, stop and delete sandboxes through the customer API.](https://runzivo.dev/docs/sandboxes-api/) [Exec and terminal API reference Run a command with streamed output, or open the sandbox terminal as a WebSocket. Both need a running sandbox and a token that can change sandboxes.](https://runzivo.dev/docs/sandboxes-api-exec/) [GET List sandboxes List your workspace's sandboxes, newest first, with offered sizes and the running limit.](https://runzivo.dev/docs/reference/sandboxes/list/) [POST Create a sandbox Create a sandbox and request its first start.](https://runzivo.dev/docs/reference/sandboxes/create/) [GET Get a sandbox Read a sandbox's current status, lifetime and compute usage.](https://runzivo.dev/docs/reference/sandboxes/get/) [DELETE Delete a sandbox Stop the VM and permanently remove its workspace disk and files.](https://runzivo.dev/docs/reference/sandboxes/delete/) [POST Start a sandbox Start a stopped or failed sandbox without resetting its original expiry.](https://runzivo.dev/docs/reference/sandboxes/start/) [POST Stop a sandbox Stop a running sandbox while keeping its files.](https://runzivo.dev/docs/reference/sandboxes/stop/) [POST Run a command Run bash -lc in a running sandbox and stream stdout, stderr and the exit result.](https://runzivo.dev/docs/reference/sandboxes/exec/) [POST Create a terminal ticket Issue a single-use ticket so a browser can open the terminal without an Authorization header.](https://runzivo.dev/docs/reference/sandboxes/terminal-ticket/) [GET Open a terminal Upgrade to a WebSocket for a running sandbox's interactive terminal.](https://runzivo.dev/docs/reference/sandboxes/terminal/)

## Workspace & CLI

[rzv command reference The commands in rzv 0.21.0, grouped by what they act on. Every command accepts --help, and every command except rzv sandboxes ssh accepts --json.](https://runzivo.dev/docs/cli-commands/)

Page tools

[View as Markdown](https://runzivo.dev/docs/reference.md)

Ask AI about this page

[Open in ChatGPT](https://chatgpt.com/?q=Read%20this%20Runzivo%20documentation%20page%2C%20then%20help%20me%20with%20it%3A%0A%0Ahttps%3A%2F%2Frunzivo.dev%2Fdocs%2Freference.md) [Open in Claude](https://claude.ai/new?q=Read%20this%20Runzivo%20documentation%20page%2C%20then%20help%20me%20with%20it%3A%0A%0Ahttps%3A%2F%2Frunzivo.dev%2Fdocs%2Freference.md) [Open in Cursor](https://cursor.com/link/prompt?text=Read%20this%20Runzivo%20documentation%20page%2C%20then%20help%20me%20with%20it%3A%0A%0Ahttps%3A%2F%2Frunzivo.dev%2Fdocs%2Freference.md)

Claude shows a caution banner on any prefilled prompt. That is expected: review the prompt, then send it.