site-crawl

Start Crawl

Create a queued crawl_jobs row. Execution is triggered separately via Trigger.dev calling POST /site-crawl/{job_id}/_run, OR inline via BackgroundTasks when ?immediate=1 is set.

post/site-crawl

Request

  • Base URL: https://api.xeorank.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.xeorank.com/site-crawl
  • Auth: API key in header X-Agent-Key

Query parameters

immediateboolean

If true, schedule a FastAPI BackgroundTask to run the crawl in-process. Used by the CLI (long-lived polling keeps the instance warm). The web UI leaves this false and triggers a Trigger.dev task instead.

emailstring nullable

Headers

X-Org-Idstring nullable
x-xyle-sourcestring nullable

Request body

seed_urlstring required
site_idstring uuid nullable

Response

Successful Response

job_idstring required
seed_urlstring required
status'queued' | 'running' | 'completed' | 'partial' | 'failed' | 'cancelled' required
stagestring
status_detailstring nullable
pages_crawledinteger
pages_discoveredinteger
errors_countinteger
health_scorenumber nullable
health_breakdownobject nullable
coverageobject nullable
error_messagestring nullable
retry_countinteger
last_heartbeat_atstring date-time nullable
dispatch_requiredboolean
started_atstring date-time nullable
finished_atstring date-time nullable
created_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.