readthedocs-api
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
More from readthedocs/skills
readthedocs-search-api
Query the Read the Docs Search API to find documentation across projects and repositories. Use when searching documentation, finding related docs, finding API documentation, or gathering information about projects on Read the Docs.
18readthedocs-write-config
Create or update Read the Docs `.readthedocs.yaml` v2 configuration files for Sphinx or MkDocs builds, including build images/tools, dependency installs, formats, custom build jobs/commands, conda environments, submodules, and search settings. Use when a user asks for a Read the Docs config file, YAML changes, or build behavior updates.
15readthedocs-redirects-manager
Manage Read the Docs redirects via the RTD API. Use when listing, creating, updating, or deleting custom redirects for a project.
13readthedocs-build-failure-triage
Triage Read the Docs build failures using build logs and config context. Use when a build fails, logs need analysis, or you need fix recommendations.
13readthedocs-project-manager
Manage Read the Docs projects via the RTD API. Use when creating projects, listing repos, triggering builds, syncing versions, or checking build status on Read the Docs.
12readthedocs-build-optimization
Optimize Read the Docs build performance and resource usage. Use when Read the Docs builds are slow, timing out, or hitting memory limits, or when users want to speed up builds by adjusting formats, dependencies, conda/mamba usage, or Python API documentation strategy.
8