Skip to main content
SynthClient is the front-door client for the public synth-ai infrastructure surface. 
from synth_ai import SynthClient

client = SynthClient()

​
Namespaces

NamespacePurpose
client.containersHosted container records and lifecycle.
client.tunnelsTunnel records, leases, heartbeats, refresh, and release.
client.poolsPools, 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.