readthedocs-api
Installation
SKILL.md
Read the Docs API v3 client
Build or update API v3 requests against Read the Docs, and use the bundled references for endpoint-specific details.
Workflow
-
Choose the correct host.
- Community:
https://app.readthedocs.org - Read the Docs for Business:
https://app.readthedocs.com
- Community:
-
Authenticate when needed.
- Use
Authorization: Token <token>for user-scoped data and write operations. - Session authentication is allowed for dashboard/internal uses.
- Use
-
Pick the endpoint from the short reference.
- Use
references/api-v3-short.mdto select the method, path, and high-level parameters.
- Use
-
Fill in details from the full reference.
- Use
references/api-v3-full.mdfor request bodies, query parameters, response fields, status codes, and notes.
- Use