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

# experiments

# `synth_ai.research.experiments`

`client.research.experiments` — typed experiment observability projections.

## Classes

### `ResearchExperimentsAPI` <sup><a href="https://github.com/synth-laboratories/synth-ai/blob/main/synth_ai/research/experiments.py#L15" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

Owner-assembled experiment bundles, history, and comparisons.

All projections are backend-owned; this namespace decodes the wire payloads
into the frozen dataclasses in `synth_ai.managed_research.models.factories`
(each keeps the full payload in its `raw` field where applicable).

**Methods:**

#### `bundle` <sup><a href="https://github.com/synth-laboratories/synth-ai/blob/main/synth_ai/research/experiments.py#L26" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

```python theme={null}
bundle(self, project_id: str, experiment_id: str) -> ExperimentBundle
```

Read one experiment bundle.

Backend route: `GET /smr/projects/&#123;project_id&#125;/experiments/&#123;experiment_id&#125;/bundle`.

#### `history` <sup><a href="https://github.com/synth-laboratories/synth-ai/blob/main/synth_ai/research/experiments.py#L35" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

```python theme={null}
history(self, project_id: str) -> ExperimentHistory
```

Read experiment history with missing-evidence alerts.

Backend route: `GET /smr/projects/&#123;project_id&#125;/experiment-bundles`.

#### `compare` <sup><a href="https://github.com/synth-laboratories/synth-ai/blob/main/synth_ai/research/experiments.py#L44" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

```python theme={null}
compare(self, project_id: str, experiment_ids: Iterable[str]) -> ExperimentComparison
```

Compare accepted experiments across matching evidence dimensions.

Backend route: `GET /smr/projects/&#123;project_id&#125;/experiments/compare`
(query `experiment_ids`, 2-20 ids).