# Read the Docs · 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.

- Provider: Alexandria
- Category: Developer
- Runs: In the background
- Returns: json
- Tool id: `alexandria` / `readthedocs-io/developer-documentation/list_pages`
- Page: https://spiral.ai/tools/alexandria/readthedocs-io/developer-documentation/list_pages

## Pricing

$0.00873 per call.

## Limits

- 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 | Allowed | Default | Description |
| --- | --- | --- | --- | --- |
| `q` | text |  | — | Case-insensitive substring filter on page title or path. |
| `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]?://. |
| `limit` | number | 1 to 1000 | — | Pages to return (default 200). |
| `offset` | number | 0 to 100000 | — | Pages to skip; pass next_offset 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](?:[a-z0-9-]{0,61}[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}$. |
| `path_prefix` | text |  | — | 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/). |

## Example

```bash
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>"
    }
  }'
```

Try it in the Playground: https://spiral.ai/start?provider=alexandria&model=readthedocs-io%2Fdeveloper-documentation%2Flist_pages

## Common questions

### Read the Docs · List pages

**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.

