# API reference (https://crawler-docs.lumen-labs.ai/docs/v2/reference)

> For the complete Lumen Crawler documentation index, see [llms.txt](https://crawler-docs.lumen-labs.ai/docs/llms.txt). A markdown version of any docs page is available by appending `.md` to its URL (e.g. https://crawler-docs.lumen-labs.ai/docs/v2/reference.md).

Generated operation pages from the checked-in OpenAPI 3.1 snapshot.

The crawl API is served at `https://crawler.lumen-labs.ai`. Paths below are relative to `/v1`.

- Machine contract: [/docs/openapi.json](/openapi.json)
- [Crawls](https://crawler-docs.lumen-labs.ai/docs/v2/reference/api/crawls) — create, poll, pages, map, doors, cleaned, cancel
- [Account](https://crawler-docs.lumen-labs.ai/docs/v2/reference/api/account) — profile, usage, API keys (console JWT)
- [Billing](https://crawler-docs.lumen-labs.ai/docs/v2/reference/api/billing) — Checkout and Customer Portal (console JWT)
- [Errors](https://crawler-docs.lumen-labs.ai/docs/v2/errors)

Regenerate from the sibling `lumen-crawler2` contract with `npm run api:sync && npm run api:generate`.
