# Crawl

> Model-friendly API documentation for the Crawl web scraping platform.

## Base URL

https://api-crawl.top1.ai

## Authentication

All paid endpoints require one of the following headers:

- `X-API-Key: sk_live_<YOUR_KEY>`
- `Authorization: Bearer sk_live_<YOUR_KEY>`

Get a key at https://crawl.top1.ai/dashboard/keys

## Endpoints

- POST /v1/scrape: Scrape a single page and convert it to Markdown. (1 credit (3 with extract_schema))
- POST /v1/extract: Scrape a page, then extract structured fields with an LLM. (3 credits)
- POST /v1/crawl: Deep-crawl a single domain; billed per page actually fetched. (1 credit / page)
- POST /v1/search: Search the web and scrape the result pages as Markdown. (2 credits)
- GET /v1/usage: Check remaining credits and usage. (0 credits)

## Credits

- Scrape: 1 credit per page
- Extract: 3 credits per page
- Crawl: 1 credit per page actually fetched
- Search: 2 credits per query
- Usage: free

## Links

- OpenAPI / Swagger UI: https://api-crawl.top1.ai/docs
- Interactive docs: https://crawl.top1.ai/docs
- Full LLM docs: https://crawl.top1.ai/llms-full.txt
- Markdown export: https://crawl.top1.ai/docs.md