Introduction
This tab demonstrates a separate top-level section with its own sidebar β clicking API Reference in the topbar swaps the entire left sidebar to a different page tree, distinct from the Guides tab.
This is a fixture page, not a real API. A full API reference generated from an OpenAPI spec (with a live βtry itβ playground) is planned separately β see WRITEDOCS_ARCHITECTURE.md, Phase 2.
Base URL
All requests are made against:
https://api.example.com/v1Response format
Every endpoint returns JSON with a consistent envelope:
| Field | Type | Description |
|---|---|---|
data | object | array | The requested resource(s) |
error | object | null | Present only when the request failed |
Next
See Authentication for how to authorize requests.