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

# Boat SDKs

> Use Boat from Python and TypeScript/JavaScript services.

<video controls playsInline preload="metadata" poster="/videos/sdks-overview.jpg" src="https://mintcdn.com/ariana-1e97e6c3/KkeC9MhSefNUGJb6/videos/sdks-overview.mp4?fit=max&auto=format&n=KkeC9MhSefNUGJb6&q=85&s=41e03de769e6e86033b0d3d7d8812799" className="w-full aspect-video rounded-xl" data-path="videos/sdks-overview.mp4" />

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.

<CardGroup cols={2}>
  <Card title="Python" href="/sdks/python">
    Install `boat-sdk` from PyPI and use snake\_case methods.
  </Card>

  <Card title="TypeScript / JavaScript" href="/sdks/typescript">
    Install `@boatdev/sdk` from npm and use camelCase methods.
  </Card>
</CardGroup>

## Install

<CodeGroup>
  ```bash Python theme={null}
  python -m pip install boat-sdk
  ```

  ```bash TypeScript / JavaScript theme={null}
  npm install @boatdev/sdk
  ```
</CodeGroup>

## Configure

Base URL:

```text theme={null}
https://boat.dev/api/v1
```

Create a Boat API key with `boat api-key create` or in the [dashboard](https://boat.dev/dashboard?tab=api-keys), store it as `BOAT_API_KEY`, and pass it through the SDK `Configuration` object.

<Warning>
  Treat Boat API keys, Boat secrets, SSH keys, and returned desktop/VNC URLs as secrets. Do not log or persist them unredacted.
</Warning>

## Next steps

<CardGroup cols={2}>
  <Card title="Python SDK guide" href="/sdks/python">
    Configure the client, run the create/prompt example, and read the Python method and type reference.
  </Card>

  <Card title="TypeScript / JavaScript SDK guide" href="/sdks/typescript">
    Configure the client, run the create/prompt example, and read the TypeScript method and type reference.
  </Card>
</CardGroup>


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