API Reference

A reference layout that keeps endpoints, examples, and implementation notes aligned.

GET /v1/documents/{slug}

Documents

Fetch a fully rendered document with navigation context, table of contents, and edit metadata.

  • ETag support
  • locale-aware slug resolution
  • draft gating

POST /v1/search

Search

Search the knowledge base with weighted title, heading, and excerpt ranking optimized for doc retrieval.

  • prefix matching
  • section boosting
  • keyboard-first UI

GET /v1/releases

Changelog

Return release notes grouped by stream with upgrade notes and related document pointers.

  • semver filters
  • date windows
  • linked migration guides

Document Endpoint

Use this pattern when you need full document rendering plus navigation metadata in one request.

curl -X GET https://api.example.com/v1/documents/authoring-docs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer $TOKEN'

Search Endpoint

Search uses weighted ranking so titles and headings win over body matches, which keeps results closer to user intent.

{
  "query": "sidebar keyboard shortcuts",
  "limit": 5,
  "sectionBoost": ["Guides", "Patterns"]
}