Installation

Install

pip install hexel

Requires Python 3.10+. The SDK depends on httpx and websockets. Optional extras:

pip install "hexel[app]"    # agent runtime app (Starlette/Uvicorn)
pip install "hexel[otel]"   # OpenTelemetry instrumentation

Verify

from hexel import Hexel

client = Hexel(api_key="YOUR_API_KEY")
print(client.compute.sandbox.list())

Configuration

The Hexel client accepts these options:

string

API key. Or set HEXEL_API_KEY.

string

OAuth client ID (with client_secret). Or set HEXEL_CLIENT_ID.

string

OAuth client secret. Or set HEXEL_CLIENT_SECRET.

string

Default workspace for tool operations.

float

default:"30.0"

Per-request timeout in seconds.

string

default:"https://api.hexelstudio.com"

API gateway base URL (orchestration, tools, registry).

string

default:"https://api.hexelstudio.com"

Compute API base URL (sandboxes, instances, registry).

string

default:"https://sts.hexelstudio.com"

Token service URL.

from hexel import Hexel

client = Hexel(api_key="YOUR_API_KEY", timeout=60.0)

Authentication

Provide credentials directly or via environment variables:

# API key
client = Hexel(api_key="YOUR_API_KEY")

# OAuth client credentials
client = Hexel(client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET")

export HEXEL_API_KEY="YOUR_API_KEY"
# or
export HEXEL_CLIENT_ID="YOUR_CLIENT_ID"
export HEXEL_CLIENT_SECRET="YOUR_CLIENT_SECRET"

The SDK exchanges credentials with the STS for a short-lived token (15 min) and refreshes it automatically.

Next steps

Continue to the Quickstart.

Overview

Python SDK

CLI (hexel-tools)

Install

Verify

Configuration

Authentication

Next steps

​Install

​Verify

​Configuration

​Authentication

​Next steps

Install

Verify

Configuration

Authentication

Next steps