Read a documentation guide
Returns one guide as Markdown. With anchor, only that heading, which is what an answer usually needs; without it, the whole page, which can run to tens of kilobytes. Find an id and its anchors with the list or search endpoint.
- stringheaderrequired
Your API key.
Authorization: Bearer <key>is accepted in its place.
- stringrequired
The guide's id, as the list endpoint gives it.
- Accepts
- a lowercase slug: letters, digits and hyphens
- Example
- string
Return only the section this heading anchor names. Omitted, the whole page comes back.
- Max length
- 120
- Example
- object
The response payload.
- string
The guide's id.
- string
The page's title.
- string
The page, opened at the section when one was named.
- string
The opening prose. Sent with a whole page only.
- string
The whole page as Markdown. Sent when no anchor was given.
- object[]
The page's headings, or the named section - one anchor can hold several headings where a page deep-links only the outer one.
- string
The heading's anchor.
- string
The heading.
- string
The heading with the ones above it.
- string
The section's prose. Sent when an anchor was given.
- 400
VALIDATION_ERRORValidation error - 401
UNAUTHORIZEDAPI key required - 403
FORBIDDENValid key, not permitted - 404
NOT_FOUNDResource not found - 429
RATE_LIMITEDRate limit exceeded - 500
INTERNAL_ERRORUnexpected server error
- Minimum tier
- Explorer+
- Monthly quota
- 200/mo
- Rate limit
- 10/min
- Daily cap
- 50
Figures shown are for this endpoint's minimum tier. Higher tiers raise every limit.