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

# Install the SDK

> Add the Glasswarp Python SDK to your project.

The Glasswarp SDK is Python 3.9+. Any language can call the REST API directly —
see the [API reference](/api-reference/overview) — but the SDK handles auth, retries, and
the vision/input helpers for you.

## Install

<CodeGroup>
  ```bash pip theme={null}
  python -m pip install glasswarp
  ```

  ```bash uv theme={null}
  uv add glasswarp
  ```

  ```bash poetry theme={null}
  poetry add glasswarp
  ```

  ```bash pipenv theme={null}
  pipenv install glasswarp
  ```
</CodeGroup>

The only core runtime dependency is `httpx`.

Source: [github.com/glasswarp/python-sdk](https://github.com/glasswarp/python-sdk)
(Apache-2.0). The Windows host agent and platform remain proprietary.

## Grounding extra

For Set-of-Mark annotation and ROI image helpers (which use Pillow):

<CodeGroup>
  ```bash pip theme={null}
  python -m pip install "glasswarp[grounding]"
  ```

  ```bash uv theme={null}
  uv add "glasswarp[grounding]"
  ```

  ```bash poetry theme={null}
  poetry add "glasswarp[grounding]"
  ```
</CodeGroup>

<Tip>
  Skip the grounding extra for the basic session and input loop. Add it only
  when you call `som_annotate` or crop screenshots client-side.
</Tip>

## From the monorepo

Developing the SDK inside this repo:

```bash theme={null}
python -m pip install -e sdk/python
```

Public installs use PyPI: [pypi.org/project/glasswarp](https://pypi.org/project/glasswarp/).

## Configure the client

The client reads `GLASSWARP_API_KEY` from the environment:

```python theme={null}
import os
from glasswarp import GlasswarpClient

gw = GlasswarpClient(api_key=os.environ["GLASSWARP_API_KEY"])
```

| Parameter | Env var | Default |
| - | - | - |
| `api_key` | `GLASSWARP_API_KEY` | required |
| `base_url` | `GLASSWARP_BASE_URL` | `https://signal.glasswarp.com` |

Next: [install the host agent](/get-started/install-host) on your Windows
machine.


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