Skip to main content
POST
Best to see what a crawl would do before starting it.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

A value you choose for one call. Send the same key with the same method, path and body within 24 hours and the first answer comes back with idempotent-replayed: true, with the same cost headers and no second charge. A call that sends zeroDataRetention and answers with page data is not kept, so a retry runs again. Needs an API key.

Query Parameters

maxTextLength
integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1

Body

application/json
url
string
required

The site to crawl, such as https://bun.com.

prompt
string
required

What you want from the crawl, such as only the blog posts.

Required string length: 1 - 1000

Response

The data, and what this call cost in dollars.

success
any
required
data
object
required
creditsUsed
integer
required
costUsd
number
required

What this call cost, in dollars.

requestId
string
required