Lumen Crawler
Guides

For the complete Lumen Crawler documentation index, see llms.txt. A markdown version of any docs page is available by appending .md to its URL. Docs MCP: /docs/mcp.

Cleanup JSON

Per-page and site-level typed JSON after the crawl. Default on. Second wait after status.

Cleanup runs after fetches when cleanup is true (the default). It classifies main content versus chrome and builds a site rollup (areas, headings).

Crawl status can be completed while cleanup.status is still pending or running.

Per-page cleaned

curl "https://crawler.lumen-labs.ai/v1/crawls/$ID/pages?include=cleaned" \
  -H "Authorization: Bearer $LUMEN_CRAWLER_KEY"

Combine with markdown: include=markdown,cleaned.

Site rollup

curl https://crawler.lumen-labs.ai/v1/crawls/$ID/cleaned \
  -H "Authorization: Bearer $LUMEN_CRAWLER_KEY"
HTTPtypeMeaning
200—Rollup ready
409cleanup_not_readyCleanup still queued or running
404cleanup_unavailableCleanup skipped, failed, or missing

cleanup on the crawl object has status (skipped, pending, running, completed, failed), model, pages_cleaned, and error.

Set "cleanup": false on create to skip. Then /cleaned is 404.

For agents

After crawl status is terminal, keep polling GET /cleaned until 200 or 404. Treat 409 as wait, not failure.

Edit on GitHub

Last updated on

On this page