readthedocs-project-manager
Read the Docs Project Manager
Use the Read the Docs API to create and manage projects. This skill covers the core project lifecycle tasks that are commonly needed for setup and verification.
Required inputs
- RTD host in
RTD_HOST- Community:
https://app.readthedocs.org - Business:
https://app.readthedocs.com
- Community:
- API token available in
RTD_TOKEN(preferred) or provided by the user
Quick workflow
- Confirm host and token source.
- Collect project inputs (name, slug, repo URL, repo type).
- Create the project via API.
- Trigger a build or sync versions if needed.
- Poll the latest build status.
API basics
Base URL:
${RTD_HOST}/api/v3/
All authenticated requests:
-H "Authorization: Token $RTD_TOKEN"
Common tasks
1) List remote repositories (optional)
Use this when you need to verify repo access or pick a repo from integrations.
GET /api/v3/remote/repositories/
Example:
curl -s -H "Authorization: Token $RTD_TOKEN" \
"${RTD_HOST}/api/v3/remote/repositories/"
2) Create a project
POST /api/v3/projects/
Minimal body:
{
"name": "Project Name",
"slug": "project-slug",
"repository": {
"url": "https://github.com/org/repo",
"type": "git"
}
}
Example:
curl -s -X POST "${RTD_HOST}/api/v3/projects/" \
-H "Authorization: Token $RTD_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Project Name","slug":"project-slug","repository":{"url":"https://github.com/org/repo","type":"git"}}'
3) Sync versions
POST /api/v3/projects/{slug}/sync-versions/
curl -s -X POST \
-H "Authorization: Token $RTD_TOKEN" \
"${RTD_HOST}/api/v3/projects/project-slug/sync-versions/"
4) Trigger a build
POST /api/v3/projects/{slug}/versions/{version}/builds/
curl -s -X POST \
-H "Authorization: Token $RTD_TOKEN" \
"${RTD_HOST}/api/v3/projects/project-slug/versions/latest/builds/"
5) Check latest build status
GET /api/v3/projects/{slug}/builds/?limit=1
curl -s -H "Authorization: Token $RTD_TOKEN" \
"${RTD_HOST}/api/v3/projects/project-slug/builds/?limit=1"
Notes
- Use the community host for public RTD, and your Business host for private instances.
- Do not print or log token values in responses.
- If project creation fails, confirm the slug is available and the repo URL is reachable.
Docs
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.
16readthedocs-api
Full Read the Docs API v3 client guidance. Use when building or updating an API client, generating requests, or answering questions about Read the Docs API v3 endpoints (projects, versions, builds, subprojects, translations, redirects, environment variables, organizations, remote VCS resources, or embed content).
15readthedocs-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.
13readthedocs-redirects-manager
Manage Read the Docs redirects via the RTD API. Use when listing, creating, updating, or deleting custom redirects for a project.
12readthedocs-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.
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.
7