Endpoint Playground

Try the Submit a bounded web crawl API

Accepts an owner-scoped durable crawl job. `max_credits` is required; the accepted request and active reader/source revisions are frozen for idempotent replay. A repeated matching idempotency key returns the original job without preparing another reservation.

Request: POST /web/crawl
Cost: 0 credits/request
Auth: apiKey

Submit a bounded web crawl API documentation Pricing

Prefilled cURL

curl 'https://api.crawlora.net/api/v1/web/crawl' \
  -H "x-api-key: $CRAWLORA_API_KEY" \
  -X POST \
  --data '{}'

Request parameters

Parameter	Type	Required	Prefilled value	Description
request (body)	object	Yes		Bounded crawl request

Example JSON response

{
  "code": 202,
  "msg": "Accepted",
  "data": {
    "job_id": "opaque-job-id",
    "state": "queued",
    "replayed": false,
    "status_url": "https://api.crawlora.net/api/v1/web/crawl/opaque-job-id",
    "results_url": "https://api.crawlora.net/api/v1/web/crawl/opaque-job-id/results",
    "deadline_at": "2026-10-09T04:35:00Z"
  }
}

More Retrieval endpoints

Search indexed developer documentation Discover indexed developer sources Get web retrieval capabilities and limits Read crawl job status and cumulative accounting 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

POSTapiKey0 credits/requestRetrieval

POST /web/crawl

Submit a bounded resumable web crawl

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

Loading body editor…

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 responsePOST

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

{
  "code": 202,
  "msg": "Accepted",
  "data": {
    "job_id": "opaque-job-id",
    "state": "queued",
    "replayed": false,
    "status_url": "https://api.crawlora.net/api/v1/web/crawl/opaque-job-id",
    "results_url": "https://api.crawlora.net/api/v1/web/crawl/opaque-job-id/results",
    "deadline_at": "2026-10-09T04:35:00Z"
  }
}

Endpoint Playground

Try the Submit a bounded web crawl API

Request: POST /web/crawl
Cost: 0 credits/request
Auth: apiKey

Submit a bounded web crawl API documentation Pricing

Prefilled cURL

curl 'https://api.crawlora.net/api/v1/web/crawl' \
  -H "x-api-key: $CRAWLORA_API_KEY" \
  -X POST \
  --data '{}'

Request parameters

Parameter	Type	Required	Prefilled value	Description
request (body)	object	Yes		Bounded crawl request

Example JSON response

{
  "code": 202,
  "msg": "Accepted",
  "data": {
    "job_id": "opaque-job-id",
    "state": "queued",
    "replayed": false,
    "status_url": "https://api.crawlora.net/api/v1/web/crawl/opaque-job-id",
    "results_url": "https://api.crawlora.net/api/v1/web/crawl/opaque-job-id/results",
    "deadline_at": "2026-10-09T04:35:00Z"
  }
}

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

POSTapiKey0 credits/requestRetrieval

POST /web/crawl

Submit a bounded resumable web crawl

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

Loading body editor…

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 responsePOST

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

{
  "code": 202,
  "msg": "Accepted",
  "data": {
    "job_id": "opaque-job-id",
    "state": "queued",
    "replayed": false,
    "status_url": "https://api.crawlora.net/api/v1/web/crawl/opaque-job-id",
    "results_url": "https://api.crawlora.net/api/v1/web/crawl/opaque-job-id/results",
    "deadline_at": "2026-10-09T04:35:00Z"
  }
}