Skip to main content

Scribe

Route/authoring/scribe PreviewScribe previewscribe

Scribe writes a version's reference content — path summaries, operation descriptions, schema and property descriptions, examples — and measures how much of it is written. The suite dropdown calls it "AI-assisted content and guide workspace"; the launcher card, "Author cited reference content and guides with grounded AI proposals." It is in preview.

Its product sidebar:

GroupPages
Coverage OverviewDashboard, Project Overview
AI AuthoringContent Workspace
Content GenerationREADME Generator, Style Guide
Quality & ConfigStale Alerts, Settings

Two stores​

Scribe reads and writes two places, and it helps to know which:

  • The Designer catalog — the summaries and descriptions on the version's paths and classes, read and written through the Apiome REST API. The content workspace, the dashboard's coverage figures and the project overview use this store. What you write here is what the Designer and every export see.
  • Spire — the Suite's authoring service, which holds the documentation content that bulk generation and stale-alert updates write, plus the style guide, coverage snapshots and the LLM gateway's providers, settings, budget and audit log.

What generates today​

Generation through the Suite's LLM gateway runs as a bulk job — Auto-fill missing path summaries, Document undocumented schemas and Auto-fill all gaps on the dashboard and project overview — once an API key is saved in Settings. The per-field Generate buttons, the workspace's Generate all sheet, Regenerate All on the README generator and Request review are present but disabled in this preview, each with a note saying what they wait on. Example payloads come from Generate from schema, which is deterministic.

The preview and the set of enabled controls will change; each page names what is wired.