Docs

Programmatic access to the documentation site itself. Agents read the docs without scraping HTML.

get/api/v1/docs

List every published docs page

Flat list of every page under content/docs/. Agents use this to enumerate the surface; pair with `GET /api/v1/docs/page/{slug}` to fetch the markdown body of a specific page.

Auth: none required (public)

Responses

200OK

{
  "type": "object",
  "properties": {
    "pages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DocsPageSummary"
      }
    }
  }
}

get/api/v1/docs/page/{slug}

Fetch a single docs page's content

Returns JSON `{ slug, title, description, body_md }` by default. Pass `?format=raw` to get the markdown body directly with `Content-Type: text/markdown` — useful when piping into another tool.

Auth: none required (public)

Parameters

Name	In	Type	Required	Description
`slug`	`path`	`string`	yes	Slash-joined slug. Example: 'concepts/wallet'.
`format`	`query`	`string`	no	`raw` returns text/markdown. Default is JSON.

Responses

200OK

{
  "type": "object",
  "required": [
    "slug",
    "title",
    "body_md"
  ],
  "properties": {
    "slug": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "body_md": {
      "type": "string",
      "description": "MDX source with frontmatter stripped."
    },
    "file_path": {
      "type": "string",
      "description": "Path to the source file in the GitHub repo (under content/docs/)."
    }
  }
}

404No docs page at that slug

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "message",
        "code"
      ],
      "properties": {
        "message": {
          "type": "string"
        },
        "code": {
          "type": "string"
        },
        "details": {}
      }
    }
  }
}

get/api/v1/docs/search

Substring search across docs pages

Per-page scoring: title hits 5x, description 4x, headings 3x, body 1x (capped at 5). Returns up to `limit` matches sorted by score with a snippet around the highest-scoring body hit.

Auth: none required (public)

Parameters

Name	In	Type	Required	Description
`q`	`query`	`string`	yes
`limit`	`query`	`integer`	no

Responses

200OK

{
  "type": "object",
  "properties": {
    "q": {
      "type": "string"
    },
    "hits": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DocsSearchHit"
      }
    }
  }
}