Endpoint Playground

Try the Read web crawl status API

Returns status for a crawl job owned by the authenticated principal. This control call does not reserve or settle credits.

Request: GET /web/crawl/{job_id}
Cost: 0 credits/request
Auth: apiKey

Read web crawl status API documentation Pricing

Prefilled cURL

curl 'https://api.crawlora.net/api/v1/web/crawl/job-123' \
  -H "x-api-key: $CRAWLORA_API_KEY"

Request parameters

Parameter	Type	Required	Prefilled value	Description
job_id (path)	string	Yes	job-123	Owned crawl job ID

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "job_id": "opaque-job-id",
    "kind": "crawl",
    "state": "running",
    "cancel_requested": false,
    "partial": false,
    "created_at": "2026-10-09T04:00:00Z",
    "updated_at": "2026-10-09T04:00:15Z",
    "deadline_at": "2026-10-09T04:05:00Z",
    "progress": {
      "discovered": 12,
      "discovery_excluded": 2,
      "admitted": 10,
      "queued": 4,
      "in_flight": 1,
      "succeeded": 5,
      "failed": 0,
      "skipped": 0
    },
    "usage": {
      "search_requests": 0,
      "fetch_attempts": 6,
      "fetched_urls": 5,
      "browser_renders": 0,
      "input_tokens": 0,
      "output_tokens": 0,
      "credits_reserved": 100,
      "credits_charged": 25,
      "credits_released": 0,
      "settlement_pending": true
    },
    "warnings": []
  }
}

More Retrieval endpoints

Search indexed developer documentation Discover indexed developer sources Get web retrieval capabilities and limits Submit a bounded resumable web crawl Request cooperative crawl cancellation Read committed crawl outcomes Map a public site Search the public web

The sample response, schema and code snippets below work without an account. Sending a live request needs an API key.

Set up API key Endpoint docs

Endpoint

Choose one catalog endpoint for this request.

1 shown

Group

Method

Auth

Endpoint

GETapiKey0 credits/requestcrawlretrieval.crawlStatusEnvelopeRetrieval

GET /web/crawl/{job_id}

Read crawl job status and cumulative accounting

Returns status for a crawl job owned by the authenticated principal. This control call does not reserve or settle credits.

API key required. Paste a full key or rotate one from the API Keys page.

Set up API key

View docs

API key

API key required for live requests. Your key is only used to send requests from this Playground.

not configured

Active Playground key: not configured

Manage API keys in Console

Path parameters

job_id

requiredstring

Owned crawl job ID

Add an API key to send a live request.

If an active API key is configured, Copy cURL includes it. Share links never include API keys.

View docs

Sample responseGET

Shown before your first request. Add an API key and send a request to see the live response, status, latency, and headers.

{
  "code": 200,
  "msg": "OK",
  "data": {
    "job_id": "opaque-job-id",
    "kind": "crawl",
    "state": "running",
    "cancel_requested": false,
    "partial": false,
    "created_at": "2026-10-09T04:00:00Z",
    "updated_at": "2026-10-09T04:00:15Z",
    "deadline_at": "2026-10-09T04:05:00Z",
    "progress": {
      "discovered": 12,
      "discovery_excluded": 2,
      "admitted": 10,
      "queued": 4,
      "in_flight": 1,
      "succeeded": 5,
      "failed": 0,
      "skipped": 0
    },
    "usage": {
      "search_requests": 0,
      "fetch_attempts": 6,
      "fetched_urls": 5,
      "browser_renders": 0,
      "input_tokens": 0,
      "output_tokens": 0,
      "credits_reserved": 100,
      "credits_charged": 25,
      "credits_released": 0,
      "settlement_pending": true
    },
    "warnings": []
  }
}

Endpoint Playground

Try the Read web crawl status API

Returns status for a crawl job owned by the authenticated principal. This control call does not reserve or settle credits.

Request: GET /web/crawl/{job_id}
Cost: 0 credits/request
Auth: apiKey

Read web crawl status API documentation Pricing

Prefilled cURL

curl 'https://api.crawlora.net/api/v1/web/crawl/job-123' \
  -H "x-api-key: $CRAWLORA_API_KEY"

Request parameters

Parameter	Type	Required	Prefilled value	Description
job_id (path)	string	Yes	job-123	Owned crawl job ID

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "job_id": "opaque-job-id",
    "kind": "crawl",
    "state": "running",
    "cancel_requested": false,
    "partial": false,
    "created_at": "2026-10-09T04:00:00Z",
    "updated_at": "2026-10-09T04:00:15Z",
    "deadline_at": "2026-10-09T04:05:00Z",
    "progress": {
      "discovered": 12,
      "discovery_excluded": 2,
      "admitted": 10,
      "queued": 4,
      "in_flight": 1,
      "succeeded": 5,
      "failed": 0,
      "skipped": 0
    },
    "usage": {
      "search_requests": 0,
      "fetch_attempts": 6,
      "fetched_urls": 5,
      "browser_renders": 0,
      "input_tokens": 0,
      "output_tokens": 0,
      "credits_reserved": 100,
      "credits_charged": 25,
      "credits_released": 0,
      "settlement_pending": true
    },
    "warnings": []
  }
}

More Retrieval endpoints

The sample response, schema and code snippets below work without an account. Sending a live request needs an API key.

Set up API key Endpoint docs

Endpoint

Choose one catalog endpoint for this request.

1 shown

Group

Method

Auth

Endpoint

GETapiKey0 credits/requestcrawlretrieval.crawlStatusEnvelopeRetrieval

GET /web/crawl/{job_id}

Read crawl job status and cumulative accounting

Returns status for a crawl job owned by the authenticated principal. This control call does not reserve or settle credits.

API key required. Paste a full key or rotate one from the API Keys page.

Set up API key

View docs

API key

API key required for live requests. Your key is only used to send requests from this Playground.

not configured

Active Playground key: not configured

Manage API keys in Console

Path parameters

job_id

requiredstring

Owned crawl job ID

Add an API key to send a live request.

If an active API key is configured, Copy cURL includes it. Share links never include API keys.

View docs

Sample responseGET

Shown before your first request. Add an API key and send a request to see the live response, status, latency, and headers.

{
  "code": 200,
  "msg": "OK",
  "data": {
    "job_id": "opaque-job-id",
    "kind": "crawl",
    "state": "running",
    "cancel_requested": false,
    "partial": false,
    "created_at": "2026-10-09T04:00:00Z",
    "updated_at": "2026-10-09T04:00:15Z",
    "deadline_at": "2026-10-09T04:05:00Z",
    "progress": {
      "discovered": 12,
      "discovery_excluded": 2,
      "admitted": 10,
      "queued": 4,
      "in_flight": 1,
      "succeeded": 5,
      "failed": 0,
      "skipped": 0
    },
    "usage": {
      "search_requests": 0,
      "fetch_attempts": 6,
      "fetched_urls": 5,
      "browser_renders": 0,
      "input_tokens": 0,
      "output_tokens": 0,
      "credits_reserved": 100,
      "credits_charged": 25,
      "credits_released": 0,
      "settlement_pending": true
    },
    "warnings": []
  }
}