Skip to main content
POST
Best to see what a crawl would do before starting it. Send the site’s address and what you want, such as only the blog posts from this year. The answer holds the options to pass to crawl. A call that finds nothing to set is free.

Price

$3 per 1,000 calls. See Pricing.

Authorizations

Authorization
string
header
required

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

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