Documentation API

Build, manage, and integrate documentation across your tools with our powerful, versioned API.

Endpoints

GET /api/projects/

List all documentation projects

curl -X GET "https://readthedocs.org/api/projects/" \
     -H "Authorization: Token {your_api_key}"

Response

{
  "count": 42,
  "next": null,
  "previous": null,
  "results": [
    {"name": "Project1", "slug": "project1"},
    {"name": "Project2", "slug": "project2"}
  ]
}

POST /api/projects/

Create a new documentation project

curl -X POST "https://readthedocs.org/api/projects/" \
     -H "Content-Type: application/json" \
     -H "Authorization: Token {your_api_key}" \
     -d '{
           "name": "NewProject",
           "privacy_level": "public"
         }'

Returns

{
  "id": 355,
  "name": "NewProject",
  "url": "https://readthedocs.org/projects/newproject/en/latest/"
}

GET /api/projects/{slug}/versions/

List documentation versions for a project

curl -X GET "https://readthedocs.org/api/projects/project1/versions/" \
     -H "Authorization: Token {your_api_key}"

Response

{
  "1.0": "latest",
  "2.0": "active"
}