Skip to main content
POST
web.map

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
url
string
required

Public http or https URL of the website to map.

query
string

Optional search term to rank the discovered URLs by relevance.

limit
number

How many URLs to return, 1 to 50. Default 10.

Required range: x >= 1

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.