Skip to main content
Each SDK covers the full HTTP API: sandboxes, commands, files, public URLs, snapshots, named snapshots, environments, integrated agents, webhooks and API keys.
Used the box SDKs before? Read Migrating from Box.

Install

Configure

  1. Create an API key: boat api-key create my-app --preset ci, or use the dashboard. The key starts with boat_.
  2. Store it as BOAT_API_KEY.
  3. Give it to the Configuration object. The base URL is https://boat.dev/api/v1.

Create, run a command, stop

Next: stream output, commands with no time limit, one job with its cost, folder copies, files, public URLs, forks and prompts are on the Python and TypeScript pages.

Other languages

boat publishes SDKs for Python and TypeScript only. For another language, generate a client from the OpenAPI file with OpenAPI Generator:
Keep these values secret: API keys, environment secrets, SSH keys, and the desktop, VNC and signed file URLs that boat returns. Do not log them without redaction.