Read the Docs · Search docs
readthedocs-io/developer-documentation/search_docsGet developer and code data with Read the Docs · Search docs from Alexandria through one Spiral API key. To find where a topic, API or setting is documented in a Read the Docs project (e.g. resize in pillow, sync waves in argo-cd), then read the hit with get_page. It runs in the background and returns structured JSON. Pay as you go, with no subscription.
Pricing
$0.00873 per call.
Limits
- Runs
- In the background
- Returns
- json
- Longest queue wait
- 1 hour
- Run deadline
- 5 minutes
- Longest run, end to end
- 225 minutes
- Largest inline input
- 1 MB
- Largest input file
- 2 GB
- Largest output
- 5 GB
Input
| Field | Kind | Default | Description |
|---|---|---|---|
query required | text | — | Search terms (the platform's full-text syntax). |
url | text | — | Alternatively any page URL on https://<project>.readthedocs.io/; the project (and, where the function uses it, the version) is read from it. Exactly one of project or url. Pattern: ^[Hh][Tt][Tt][Pp][Ss]?://. |
page | number 1 to 100 | — | Result page, 1-based; pass next_page to continue. |
project | text | — | Read the Docs project slug, the <project> in https://<project>.readthedocs.io (e.g. pillow, argo-cd, pypdf, pymupdf). Pattern: ^a-z0-9?$. |
version | text | — | Version slug as it appears in the docs URL (latest, stable, a branch or tag slug such as release-3.6 or 6.1.0). Defaults to the project's default version. Pattern: ^[A-Za-z0-9._-]{1,100}$. |
Same request in code
curl https://api.spiral.ai/v1/runs \
-H "Authorization: Bearer $SPIRAL_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"provider": "alexandria",
"model": "readthedocs-io/developer-documentation/search_docs",
"input": {
"query": "<query>",
"project": "<project>"
}
}'Frequently asked questions
How much does Read the Docs · Search docs cost?
$0.00873 per call. You pay as you go from one Spiral balance, with no subscription, and a failed run is not charged.
How do I use Read the Docs · Search docs through an API?
Send `POST /v1/runs` with `"provider": "alexandria"`, `"model": "readthedocs-io/developer-documentation/search_docs"` and the input fields on this page, using one Spiral API key. It runs in the background: poll the run, or name a webhook to be told when it finishes.
Do I need an account with Alexandria to use Read the Docs · Search docs?
No. Spiral runs it on its own Alexandria account and charges your Spiral balance.
Can my AI agent use Read the Docs · Search docs?
Yes. Agents find and run it through Spiral's MCP server, CLI or agent skill, with the same API key.