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

# wiki

# `synth_ai.research.wiki`

`client.research.wiki` — project wiki reads plus proposal intake.

The session client has no wiki bindings today, so these methods call the
backend directly through the SDK's internal `_request_json` layer (same
transport, auth, and error mapping as every other session call).

## Classes

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

One serialized wiki page row (unknown keys preserved in `raw`).

**Methods:**

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

```python theme={null}
from_wire(cls, payload: object) -> WikiPage
```

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

Common wiki response envelope: wiki state + wiki project + full payload.

**Methods:**

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

```python theme={null}
from_wire(cls, payload: object) -> WikiEnvelope
```

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

Page listing envelope with typed page rows.

**Methods:**

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

```python theme={null}
from_wire(cls, payload: object) -> WikiPageList
```

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

List and read wiki pages.

**Methods:**

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

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

List wiki pages. Backend route: `GET /smr/projects/&#123;project_id&#125;/wiki/pages`.

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

```python theme={null}
get(self, project_id: str, page_id_or_slug: str) -> WikiEnvelope
```

Read one page (with sections/detail merged into `raw`).

Backend route: `GET /smr/projects/&#123;project_id&#125;/wiki/pages/&#123;page_id_or_slug&#125;`.

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

Preview the retrieval context pack assembled from the wiki.

**Methods:**

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

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

Preview the context pack (`limit` 1-200).

Backend route: `GET /smr/projects/&#123;project_id&#125;/wiki/context-pack/preview`.

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

List and create wiki change proposals.

**Methods:**

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

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

List proposals (optional `state` filter, `limit` 1-200).

Backend route: `GET /smr/projects/&#123;project_id&#125;/wiki/proposals`.

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

```python theme={null}
create(self, project_id: str, request: Mapping[str, Any] | dict[str, Any]) -> WikiEnvelope
```

Create a wiki proposal (`SmrWikiProposalCreateRequest` wire shape).

Backend route: `POST /smr/projects/&#123;project_id&#125;/wiki/proposals`.

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

Project wiki namespace (read-first).

The backend exposes GET routes for overview, pages, search, context-pack
preview, and proposals; change-sets, evidence-links, and staleness-signals
are write-only (POST) today and are intentionally not bound here.

**Methods:**

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

```python theme={null}
pages(self) -> ResearchWikiPagesAPI
```

List and read wiki pages.

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

```python theme={null}
context_pack(self) -> ResearchWikiContextPackAPI
```

Preview the wiki-derived retrieval context pack.

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

```python theme={null}
proposals(self) -> ResearchWikiProposalsAPI
```

List and create wiki change proposals.

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

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

Read the wiki overview. Backend route: `GET /smr/projects/&#123;project_id&#125;/wiki`.

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

```python theme={null}
search(self, project_id: str, query: str) -> WikiEnvelope
```

Search the wiki (`q` query text, `limit` 1-50).

Backend route: `GET /smr/projects/&#123;project_id&#125;/wiki/search`.
