Synth AI SDK Overview

Python SDK and CLI for Synth infrastructure surfaces: tunnels, pools, and containers.

The synth-ai package is the Python SDK and CLI for Synth infrastructure surfaces.

Use it when you need to integrate with:

• SynthClient
• tunnels
• pools and rollouts
• hosted containers
• the synth-ai CLI

Use Managed Research when you want hosted research workers, projects, runs, MCP, artifacts, and evidence.

First request

uv add synth-ai
export SYNTH_API_KEY="sk_..."

from synth_ai import SynthClient

client = SynthClient()

print(client.containers.list())
print(client.tunnels.list())
print(client.pools.list())

Public surface

Surface	Client namespace	Use it for
Containers	client.containers	Hosted container records and metadata.
Tunnels	client.tunnels	Managed tunnel records and tunnel leases.
Pools	client.pools	Container pools, tasks, rollouts, artifacts, usage, and events.
CLI	synth-ai	Terminal access to containers, tunnels, and pools.

Auth and base URL

By default, the SDK reads SYNTH_API_KEY and uses the production backend. Pass api_key and base_url when you need explicit control.

client = SynthClient(
    api_key="sk_...",
    base_url="https://api.usesynth.ai",
)

Next steps

Install and Authenticate

Install the package and configure API keys and backend URLs.

SynthClient

Use the front-door client for containers, tunnels, and pools.

Tunnels

Manage tunnel records and leases.

Pools

Launch rollouts and read artifacts, usage, summaries, and events.