> ## 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.

# SDK Reference

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

This reference is **auto-generated from Python docstrings** in
[`synth-ai`](https://github.com/synth-laboratories/synth-ai).

Regenerate after SDK docstring changes:

```bash theme={null}
python scripts/run_generators.py /path/to/synth-ai
```

For narrative quickstarts, see [Managed Research SDK](/managed-research/sdk).

## Client entrypoint

| Surface       | Description                          | Reference                                  |
| ------------- | ------------------------------------ | ------------------------------------------ |
| `SynthClient` | Front-door client (infra + research) | [SynthClient](/reference/sdk/synth-client) |

## Infrastructure

| Surface    | Description                          | Reference                                            |
| ---------- | ------------------------------------ | ---------------------------------------------------- |
| Containers | Build and run environment containers | [ContainersClient](/reference/sdk/containers-client) |
| Tunnels    | Expose local containers to Synth     | [TunnelsClient](/reference/sdk/tunnels-client)       |
| Pools      | Container pools and rollouts         | [ContainerPoolsClient](/reference/sdk/pools-client)  |

Guides: [Tunnels](/sdk/tunnels), [Pools](/sdk/pools).

## Managed Research (`SynthClient().research`)

Entrypoint: **`client.research`**

### Core

| Namespace            | Description          | Reference                                                          |
| -------------------- | -------------------- | ------------------------------------------------------------------ |
| `research`           | Root research client | [ResearchClient](/reference/sdk/research/synth_ai-research-client) |
| `research.factories` | Factory Tag sessions | [Factories](/reference/sdk/research/synth_ai-research-factories)   |
| `research.limits`    | Org limits           | [Limits](/reference/sdk/research/synth_ai-research-limits)         |
| `research.secrets`   | Project secrets      | [Secrets](/reference/sdk/research/synth_ai-research-secrets)       |

### Projects

| Namespace             | Description                       | Reference                                                                          |
| --------------------- | --------------------------------- | ---------------------------------------------------------------------------------- |
| `research.projects`   | Project CRUD                      | [Projects](/reference/sdk/research/synth_ai-research-projects)                     |
| `research.projects.*` | Setup, workspace, git, objectives | [Project namespaces](/reference/sdk/research/synth_ai-research-project_namespaces) |

### Runs

| Namespace                   | Description                                | Reference                                                                      |
| --------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------ |
| `research.runs`             | Launch, wait, lifecycle                    | [Runs](/reference/sdk/research/synth_ai-research-runs)                         |
| `research.hosted_artifacts` | Open Research hosted artifact CRUD (alpha) | [Hosted artifacts](/reference/sdk/research/synth_ai-research-hosted-artifacts) |
| `handle.*`                  | Usage, progress, queue, artifacts          | [Run readouts](/reference/sdk/research/synth_ai-research-run_readouts)         |

### Types

| Page   | Reference                                                  |
| ------ | ---------------------------------------------------------- |
| Models | [Models](/reference/sdk/research/synth_ai-research-models) |
| Enums  | [Enums](/reference/sdk/research/synth_ai-research-enums)   |
| Errors | [Errors](/reference/sdk/research/synth_ai-research-errors) |