Spiral gives your agent every tool with one account. Browse the tools →

AlexandriaDeveloperAvailable now

Read the Docs · List pages

readthedocs-io/developer-documentation/list_pages

Get developer and code data with Read the Docs · List pages from Alexandria through one Spiral API key. To see what a project's docs contain, browse a version's table of pages, or find pages by title before reading them 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

FieldKindDefaultDescription
qtext—

Case-insensitive substring filter on page title or path.

urltext—

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]?://.

limitnumber
1 to 1000
—

Pages to return (default 200).

offsetnumber
0 to 100000
—

Pages to skip; pass next_offset to continue.

projecttext—

Read the Docs project slug, the <project> in https://<project>.readthedocs.io (e.g. pillow, argo-cd, pypdf, pymupdf). Pattern: ^a-z0-9?$.

versiontext—

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}$.

path_prefixtext—

Only pages whose path starts with this, relative to the version root (user-guide/, operator-manual/) or from the site root (/en/stable/user-guide/).

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/list_pages",
    "input": {
      "project": "<project>"
    }
  }'

Frequently asked questions

How much does Read the Docs · List pages 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 · List pages through an API?

Send `POST /v1/runs` with `"provider": "alexandria"`, `"model": "readthedocs-io/developer-documentation/list_pages"` 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 · List pages?

No. Spiral runs it on its own Alexandria account and charges your Spiral balance.

Can my AI agent use Read the Docs · List pages?

Yes. Agents find and run it through Spiral's MCP server, CLI or agent skill, with the same API key.