Skip to main content
Use a Boat SDK when you want typed calls for creating sandboxes, prompting them, reading events, listing API key metadata, managing secrets, and opening desktop or SSH access.

Python

Install boat-sdk from PyPI and use snake_case methods.

TypeScript / JavaScript

Install @boatdev/sdk from npm and use camelCase methods.

​
Install

​
Configure

Base URL:
Create a Boat API key with boat api-key create or in the dashboard, store it as BOAT_API_KEY, and pass it through the SDK Configuration object.
Treat Boat API keys, Boat secrets, SSH keys, and returned desktop/VNC URLs as secrets. Do not log or persist them unredacted.

​
Next steps

Python SDK guide

Configure the client, run the create/prompt example, and read the Python method and type reference.

TypeScript / JavaScript SDK guide

Configure the client, run the create/prompt example, and read the TypeScript method and type reference.