DocumentOutline

GET /v1/documents/{id}/outline.

The headings of one document, for a picker offering jump targets. Answered from the derived read model rather than the document itself, because a picker must not pay a CRDT decode per keystroke.

Type object

Shape

Field	Type	Description
documentrequired	DocumentId	DocumentId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path.
headingsrequired	array of OutlineHeading	In reading order.
projectedrequired	boolean	Whether the read model has seen this document at all. An empty list means two different things and a caller must be able to tell them apart. The projector is debounced, so a heading typed a moment ago is not here yet; `projected: false` is "still indexing" and `projected: true` with no headings is "this document has none".

Example

{
  "document": "00000000-0000-4000-8000-000000000000",
  "headings": [
    {
      "node": "string",
      "level": 0,
      "text": "string"
    }
  ],
  "projected": false
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Used by

GET/v1/documents/{id}/outline
The document's headings, from the read model, without opening it

Generated from contract version 1. Last updated November 12, 2026.