Skip to main content
POST
Scrape a URL (asynchronous)

Authorizations

Authorization
string
header
required

Your API key as a Bearer token: Authorization: Bearer <api-key>.

Body

application/json
url
string<uri>
required

The URL to scrape.

callbackUrl
string<uri>
required

URL the worker POSTs the result to when done.

forceFresh
boolean

Bypass the cache and fetch a fresh copy.

timeoutMs
integer

Per-request timeout in milliseconds.

Required range: 1000 <= x <= 120000
waitForSelector
string

Wait for this CSS selector before extracting dynamic content.

extraWaitMs
integer

Additional settle time for dynamic content, in milliseconds.

Required range: 0 <= x <= 10000
callbackToken
string

Opaque token echoed back as the x-callback-token header.

Maximum string length: 256

Response

Job accepted.

jobId
string
required
status
enum<string>
required
Available options:
queued