Read the Docs SDK
Integrate documentation workflows into your tools with powerful SDKs for Python, Node.js, and more.
What is the Read the Docs SDK?
Our SDKs provide programmatic access to documentation management, versioning, and project automation using your preferred language.
Python
Native SDK for Python developers with async support and type hints
Node.js
JavaScript SDK with Promise-based API for front-end and backend integration
Installation
Node.js
npm install @readthedocs/sdk
Create a client instance with your API token:
const { RTDClient } = require('@readthedocs/sdk');
const client = new RTDClient({
token: 'YOUR_API_TOKEN'
});
Usage Examples
Create a Project
from rtd_sdk import Client
client = Client(token='YOUR_API_TOKEN')
project = client.create_project(
name='My SDK Project',
repo_url='https://github.com/myorg/myproject',
version='1.0.0'
)
print(project.url)
Response
{
"name": "My SDK Project",
"slug": "my-sdk-project",
"build_url": "https://readthedocs.org/projects/my-sdk-project/en/1.0.0/"
}
List Project Versions
const project = await client.getVersions('my-sdk-project');
console.log(project.versions);
Version Response
{
"1.0.0": {
"status": "published",
"last_build": "2025-09-20T14:22:11Z"
},
"dev": {
"status": "building",
"last_build": "2025-09-20T13:30:02Z"
}
}