Documentation

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 referenceCreate, list, read, start, stop and delete sandboxes through the customer API.Exec and terminal API referenceRun 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.GETList sandboxesList your workspace's sandboxes, newest first, with offered sizes and the running limit.POSTCreate a sandboxCreate a sandbox and request its first start.GETGet a sandboxRead a sandbox's current status, lifetime and compute usage.DELETEDelete a sandboxStop the VM and permanently remove its workspace disk and files.POSTStart a sandboxStart a stopped or failed sandbox without resetting its original expiry.POSTStop a sandboxStop a running sandbox while keeping its files.POSTRun a commandRun bash -lc in a running sandbox and stream stdout, stderr and the exit result.POSTCreate a terminal ticketIssue a single-use ticket so a browser can open the terminal without an Authorization header.GETOpen a terminalUpgrade to a WebSocket for a running sandbox's interactive terminal.

Workspace & CLI

rzv command referenceThe 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.

Page tools

View as Markdown

Ask AI about this page

Open in ChatGPT Open in Claude Open in Cursor

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