API Reference

Every Expand API endpoint, with its request, response, and errors.

This reference lists every endpoint, request field, response field, and error. How to use them is in the docs.

Base URL

https://api.expand.ai

Authentication

Send your API key in the x-expand-api-key header. The SDKs read it from the EXPAND_API_KEY environment variable.

curl https://api.expand.ai/v1/fetch \
  -H "x-expand-api-key: $EXPAND_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com"}'

Endpoints

Fetch: a URL as Markdown text.
Fetch JSON Mode: a URL as a JSON object.
Snapshot Highlights: the passages of a page that match a query.
Start Batched Fetch, Get Batched Status, and Cancel Batched Fetch: many URLs in one run.

Errors

Every error and its payload is on Errors. Which to retry, and what you are charged for, is in the Errors & retries guide. Rate and concurrency limits are on Limits.