Skip to main content

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

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

from_wire

WikiEnvelope

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

from_wire

WikiPageList

Page listing envelope with typed page rows. Methods:

from_wire

ResearchWikiPagesAPI

List and read wiki pages. Methods:

list

List wiki pages. Backend route: GET /smr/projects/{project_id}/wiki/pages.

get

Read one page (with sections/detail merged into raw). Backend route: GET /smr/projects/{project_id}/wiki/pages/{page_id_or_slug}.

ResearchWikiContextPackAPI

Preview the retrieval context pack assembled from the wiki. Methods:

preview

Preview the context pack (limit 1-200). Backend route: GET /smr/projects/{project_id}/wiki/context-pack/preview.

ResearchWikiProposalsAPI

List and create wiki change proposals. Methods:

list

List proposals (optional state filter, limit 1-200). Backend route: GET /smr/projects/{project_id}/wiki/proposals.

create

Create a wiki proposal (SmrWikiProposalCreateRequest wire shape). Backend route: POST /smr/projects/{project_id}/wiki/proposals.

ResearchWikiAPI

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

List and read wiki pages.

context_pack

Preview the wiki-derived retrieval context pack.

proposals

List and create wiki change proposals.

overview

Read the wiki overview. Backend route: GET /smr/projects/{project_id}/wiki.
Search the wiki (q query text, limit 1-50). Backend route: GET /smr/projects/{project_id}/wiki/search.