Skip to main content
POST
Typescript (SDK)

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 | null
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