Auth RequiredExplorer+
client.docs.listGuides()
Every guide the documentation renders, with the headings each is divided into: what is documented, and the ids and anchors to read it by.
listGuides(): Promise<APIResponse<DocsGuides>>- stringheaderrequired
Your API key.
Authorization: Bearer <key>is accepted in its place.
- object
The response payload.
- integer
How many guides there are.
- object[]
Every guide, in the order the documentation lists them.
- string
The guide's id, passed to the read endpoint.
- string
The page's title.
- string
The page a reader would open.
- string
The opening prose: what the page is about.
- integer
The whole page in Markdown, so a caller can tell what reading it costs.
- object[]
Every heading on the page, in order.
- 400
VALIDATION_ERRORValidation error - 401
UNAUTHORIZEDAPI key required - 403
FORBIDDENValid key, not permitted - 429
RATE_LIMITEDRate limit exceeded - 500
INTERNAL_ERRORUnexpected server error
Not yet in the Python SDK.
- 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.