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 map from

Minimum array length: 1
max_urls
integer

Cap on total URLs returned

Required range: x <= 100
max_depth
integer

Max link depth from seeds

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

Restrict mapping to seed domains

include_metadata
boolean

Include page metadata in results

timeout_ms
integer

Max mapping duration, in ms

Required range: x <= 300000
use_proxy
boolean

Skip the cheap direct/stealth tiers and go straight to the strongest (proxy) access tier for every URL mapped. Requires a paid plan.

Response

Map 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