The XCrawl scrape endpoint supports sync and async modes.

Scrape

• mode=sync (default):

  • completes within the request
  • returns the full result

• mode=async:

  • returns scrape_id immediately
  • supports webhook callbacks

Scrape status enum

• pending: queued
• crawling: in progress
• completed: done
• failed: failed

Crawl

POST /v1/crawl returns a crawl_id. Use GET /v1/crawl/{crawl_id} to check status.

Crawl status enum

• pending: queued
• crawling: in progress
• completed: done
• failed: failed

Webhook callbacks

See Webhook callbacks

Previous pageAuthentication

Next pageOutput Formats