For AI agents: a documentation index is available at /llms.txt
Skip to main content

/crawl

GET 

/crawl

List all crawl jobs owned by the authenticated account (or, for keys not yet mapped to an account, the token). Returns an array of crawl summaries with status, progress counters, and timestamps. Supports cursor-based pagination via the nextCursor field.

Request​

Query Parameters

    cursor string
    limit number
    status string
    token string

Responses​

Schema
    crawls object[]required
  • Array [
  • idstringrequired
    urlstringrequired
    statusCrawlStatusrequired

    Possible values: [cancelled, completed, failed, in-progress]

    totalnumberrequired
    completednumberrequired
    createdAtstringrequired
    completedAtstringrequired
  • ]
  • nextCursorstringrequired
Was this page helpful?