Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Body

application/json
seeds
string<uri>[]
required

Starting URLs to crawl from

Minimum array length: 1
max_pages
integer

Cap on total pages crawled

Required range: x <= 200
max_depth
integer

Max link depth from seeds

Required range: 0 <= x <= 5
same_domain_only
boolean

Restrict crawl to seed domains

output
enum<string>[]

Output formats per page (default ["markdown"])

Minimum array length: 1
Available options:
html,
markdown,
json
extract
object

Structured extraction config, requires json output

timeout_ms
integer

Max crawl duration, in ms

Required range: x <= 300000
proxy
enum<string>

Proxy and escalation mode. "basic": no proxy at all (cheapest; if the target blocks it the request fails and tells you to use "auto"). "stealth": go straight to the strongest tier, a hardened browser behind a residential proxy (paid plans). "auto": try cheap steps first and escalate to a residential proxy only when needed, billed by the step that served the request (paid plans, the default). The Free plan is always "basic".

Available options:
basic,
stealth,
auto
use_proxy
boolean

Deprecated: use proxy: "stealth". Go straight to the strongest access tier for every page crawled. Requires a paid plan.

Response

Crawl completed inline.

Common envelope every workflow endpoint (crawl, map, interact, search) returns: request/step metadata plus a kind-specific result.

id
string
required
request_id
string
required
kind
enum<string>
required
Available options:
crawl,
map,
interact,
search
mode
enum<string>
required
Available options:
inline
status
enum<string>
required
Available options:
completed,
partial,
failed
result
object
required

Kind-specific payload -- see the endpoint's example.

steps
object[]
diagnostics
object