Get a doc topic

GET/docs/{topic}

Returns one page of the scripting reference as markdown. It is how a coding agent reads the scripting rules before it writes or fixes a script.

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

Guidance

Take topic from List doc topics. A topic with a slash, such as a page inside a group, goes in the path as it is.
The answer is markdown, not JSON: read the body as text.
The body starts with the page title as a # heading. A page with tabs has each tab added under a ## heading named after it.
When the page has a next page, the last line is Next: followed by that page's topic. Follow it to read the reference in order.
A 503 busy means the docs could not be loaded. Retry after a few seconds.

Path parameters

Name	Type	Description
`topic`	string	A `topic` from List doc topics

Response

200 with Content-Type: text/markdown; charset=utf-8 and the page as the body.

Status codes

Status	Code	Meaning
`200`	-	The page as markdown
`404`	`not_found`	No topic by that name
`503`	`busy`	The docs could not be loaded. Retry shortly

Example request

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

Example response

200 OK

# Bars and clocks

Every script runs against a clock made of bars. This page sets out what a bar is, when your code runs, ...

Next: warmup-and-memory

404 Not Found

{
  "error": {
    "code": "not_found",
    "message": "No docs topic bar-clocks. List topics with GET /docs."
  }
}

From the CLI

chartnaut docs bars-and-clocks

The CLI prints the markdown as it comes; --json wraps it as {topic, markdown}. Command reference