Skip to main content
POST
/
web
/
crawl
cURL
curl -X POST https://api.crevio.co/v1/web/crawl \
  -H "Authorization: Bearer $CREVIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","max_pages":25}'
{
  "id": "<string>",
  "object": "<string>",
  "type": "<string>",
  "model": "<string>",
  "progress": 123,
  "input": {},
  "result": {},
  "error": "<string>",
  "error_code": "<string>",
  "credits_used": 123,
  "provider_request_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key in the format: Bearer {api_token}

Body

application/json
​
url
string
required

Starting URL.

​
max_pages
integer

Maximum pages to crawl (default 10, capped at 100).

​
max_depth
integer

Maximum link depth (default 2).

Response

Job queued

​
id
string
required
​
object
string
required
​
type
string
required
​
status
enum<string>
required
Available options:
queued,
processing,
completed,
failed,
cancelled
​
model
string
required
​
progress
integer
required
​
input
object
required
​
result
object
required
​
error
string | null
required
​
error_code
string | null
required
​
credits_used
integer | null
required
​
provider_request_id
string | null
required
​
created_at
string<date-time>
required
​
started_at
string<date-time> | null
required
​
completed_at
string<date-time> | null
required