SDK Reference

Auto-generated Python SDK reference for SynthClient and SynthClient().research.

This reference is auto-generated from Python docstrings in synth-ai.

Regenerate after SDK docstring changes:

python scripts/run_generators.py /path/to/synth-ai

For narrative quickstarts, see Managed Research SDK.

Client entrypoint

Surface	Description	Reference
SynthClient	Front-door client (infra + research)	SynthClient

Infrastructure

Surface	Description	Reference
Containers	Build and run environment containers	ContainersClient
Tunnels	Expose local containers to Synth	TunnelsClient
Pools	Container pools and rollouts	ContainerPoolsClient

Guides: Tunnels, Pools.

Managed Research (SynthClient().research)

Entrypoint: client.research

Core

Namespace	Description	Reference
research	Root research client	ResearchClient
research.factories	Factory Tag sessions	Factories
research.limits	Org limits	Limits
research.secrets	Project secrets	Secrets

Projects

Namespace	Description	Reference
research.projects	Project CRUD	Projects
research.projects.*	Setup, workspace, git, objectives	Project namespaces

Runs

Namespace	Description	Reference
research.runs	Launch, wait, lifecycle	Runs
research.hosted_artifacts	Open Research hosted artifact CRUD (alpha)	Hosted artifacts
handle.*	Usage, progress, queue, artifacts	Run readouts

Types

Page	Reference
Models	Models
Enums	Enums
Errors	Errors