List doc topics

GET/docs

Returns every page of the scripting reference, in sidebar order, so a coding agent can find the page it needs without a browser.

Scope	Heavy call	Long poll	CLI
`scripts:read`	No	No	`chartnaut docs`

Guidance

A topic is a scripting page's path without /scripting/: the page at /scripting/bars-and-clocks is the topic bars-and-clocks. Pass it to Get a doc topic.
depth gives the outline: 0 is the top level and a page inside a sidebar group is 1. Sidebar groups that are labels, not pages, are left out.
The list is not paginated and changes only when the docs are published. Fetch it once per session.
A 503 busy means the docs could not be loaded. Retry after a few seconds.

Response

200 with data, an array of:

Field	Type	Description
`topic`	string	Pass it to Get a doc topic
`title`	string	The page title
`depth`	integer	How deep the page sits in the sidebar. `0` is the top level; a page inside a group is `1`

Status codes

Status	Code	Meaning
`200`	-	Every topic, in sidebar order
`503`	`busy`	The docs could not be loaded. Retry shortly

Example request

curl https://api.chartnaut.com/v1/docs \
  -H "Authorization: Bearer cn_live_XXXX"

Example response

200 OK

{
  "data": [
    { "topic": "overview", "title": "Overview", "depth": 0 },
    { "topic": "what-chartnaut-guarantees", "title": "What Chartnaut guarantees", "depth": 1 },
    { "topic": "bars-and-clocks", "title": "Bars and clocks", "depth": 1 }
  ]
}

503 Service Unavailable

{
  "error": {
    "code": "busy",
    "message": "Docs are unavailable right now. Retry shortly."
  }
}

From the CLI

chartnaut docs

The CLI prints one row per topic with its depth and title. Command reference