Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.usesynth.ai/llms.txt

Use this file to discover all available pages before exploring further.

Use SynthClient for synchronous Python integrations and AsyncSynthClient for async integrations.

​
Construction

from synth_ai import SynthClient

client = SynthClient(
    api_key="sk_...",
    base_url="https://api.usesynth.ai",
    timeout=30.0,
)
If api_key is omitted, the client reads SYNTH_API_KEY.

​
Namespaces

NamespaceTypePurpose
client.containersContainersClientHosted container records.
client.tunnelsTunnelsClientTunnel records and leases.
client.poolsContainerPoolsClientPools, tasks, rollouts, artifacts, usage, summaries, and events.

​
Async construction

from synth_ai import AsyncSynthClient

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