readthedocs-search-api
Read the Docs Search API
Query the public Read the Docs Search API to find documentation across millions of pages. This API is available on both Community and Business sites; the base URL changes by host.
Step-by-step instructions
1. Make a search request
Set RTD_HOST for your site:
- Community:
https://app.readthedocs.org - Business:
https://app.readthedocs.com
Query the API using:
GET ${RTD_HOST}/api/v3/search/?q={query}&page={page}
More from readthedocs/skills
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).
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