SynthClient

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

SynthClient is the front-door client for the public synth-ai infrastructure surface.

from synth_ai import SynthClient

client = SynthClient()

Namespaces

Namespace	Purpose
client.containers	Hosted container records and lifecycle.
client.tunnels	Tunnel records, leases, heartbeats, refresh, and release.
client.pools	Pools, tasks, rollouts, artifacts, usage, summaries, and events.

Explicit configuration

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

Async client

from synth_ai import AsyncSynthClient

client = AsyncSynthClient()
containers = await client.containers.list()

Examples

for container in client.containers.list():
    print(container.id, container.name, container.status)

for tunnel in client.tunnels.list():
    print(tunnel)

pools = client.pools.list(limit=10)
print(pools)

For generated reference details, see SynthClient Reference.