Install the SDK

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

Install

python -m pip install glasswarp

uv add glasswarp

poetry add glasswarp

pipenv install glasswarp

The only core runtime dependency is httpx. Source: 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):

python -m pip install "glasswarp[grounding]"

uv add "glasswarp[grounding]"

poetry add "glasswarp[grounding]"

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

From the monorepo

Developing the SDK inside this repo:

python -m pip install -e sdk/python

Public installs use PyPI: pypi.org/project/glasswarp.

Configure the client

The client reads GLASSWARP_API_KEY from the environment:

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 on your Windows machine.

Get started

Setup

Concepts

Guides

Examples

Help

Install

Grounding extra

From the monorepo

Configure the client

​Install

​Grounding extra

​From the monorepo

​Configure the client

Install

Grounding extra

From the monorepo

Configure the client