How do I install the Readthedocs API skill?

Run npx skillmds@latest add tomevault-io/readthedocs-api in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Readthedocs API safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Readthedocs API?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Readthedocs API free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Readthedocs API?

tomevault-io (@tomevault-io) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Readthedocs API by tomevault-io — Agent Skill

Name: Readthedocs API
Author: tomevault-io

Readthedocs 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). Use when this capability is needed.

tomevault-io 2d04c96 2 files · 2.8 KB Updated Sep 17, 2026

File contents

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
Authenticate when needed.
- Use Authorization: Token <token> for user-scoped data and write operations.
- Session authentication is allowed for dashboard/internal uses.
Pick the endpoint from the short reference.
- Use references/api-v3-short.md to select the method, path, and high-level parameters.
Fill in details from the full reference.
- Use references/api-v3-full.md for request bodies, query parameters, response fields, status codes, and notes.
Handle shared API behavior.
- Pagination: list endpoints return count, next, previous, and results; use limit and offset.
- Field selection: ?fields=, ?omit=, and ?expand= are supported on resources that allow expansion.
- Rate limits: unauthenticated requests are more limited than authenticated requests; retry on 429.

Notes and constraints

Use the marketing names: "Read the Docs Community" and "Read the Docs Business".
Organization endpoints and privacy-level fields are only available on Read the Docs Business.
expand values are endpoint-specific; rely on the full reference for allowed values.

Resources

Short endpoint reference: references/api-v3-short.md
Full endpoint reference: references/api-v3-full.md
Additional full reference: https://docs.readthedocs.com/platform/stable/api/v3.html

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

---name: readthedocs-apidescription: 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). Use when this capability is needed.---# Read the Docs API v3 clientBuild or update API v3 requests against Read the Docs, and use the bundled references for endpoint-specific details.## Workflow1. Choose the correct host. - Community: `https://app.readthedocs.org` - Read the Docs for Business: `https://app.readthedocs.com`2. Authenticate when needed. - Use `Authorization: Token <token>` for user-scoped data and write operations. - Session authentication is allowed for dashboard/internal uses.3. Pick the endpoint from the short reference. - Use `references/api-v3-short.md` to select the method, path, and high-level parameters.4. Fill in details from the full reference. - Use `references/api-v3-full.md` for request bodies, query parameters, response fields, status codes, and notes.5. Handle shared API behavior. - Pagination: list endpoints return `count`, `next`, `previous`, and `results`; use `limit` and `offset`. - Field selection: `?fields=`, `?omit=`, and `?expand=` are supported on resources that allow expansion. - Rate limits: unauthenticated requests are more limited than authenticated requests; retry on `429`.## Notes and constraints- Use the marketing names: "Read the Docs Community" and "Read the Docs Business".- Organization endpoints and privacy-level fields are only available on Read the Docs Business.- `expand` values are endpoint-specific; rely on the full reference for allowed values.## Resources- Short endpoint reference: `references/api-v3-short.md`- Full endpoint reference: `references/api-v3-full.md`- Additional full reference: `https://docs.readthedocs.com/platform/stable/api/v3.html`---> Converted and distributed by [TomeVault](https://tomevault.io/claim/readthedocs) — claim your Tome and manage your conversions.

Frequently asked questions