Skip to main content
POST
web.map-options

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 starting URL.

instructions
string

Optional natural-language traversal instructions.

maxDepth
integer
default:1

Link depth, 1 to 5. Default 1.

Required range: 1 <= x <= 5
maxBreadth
integer
default:20

Most links followed per page, 1 to 500. Default 20.

Required range: 1 <= x <= 500
limit
integer
default:50

Most pages to return, 1 to 500. Default 50.

Required range: 1 <= x <= 500
includePaths
string[]

Included path patterns, at most 50 bounded regular expressions.

Maximum array length: 50
Required string length: 1 - 512
excludePaths
string[]

Excluded path patterns, at most 50 bounded regular expressions.

Maximum array length: 50
Required string length: 1 - 512
includeDomains
string[]

Included domain patterns, at most 50 bounded regular expressions.

Maximum array length: 50
Required string length: 1 - 512
excludeDomains
string[]

Excluded domain patterns, at most 50 bounded regular expressions.

Maximum array length: 50
Required string length: 1 - 512
allowExternal
boolean
default:false

Allow external links. Default false.

timeoutSeconds
number
default:20

Source wait, 10 to 150 seconds. Some sources currently decline above 24.

Required range: 10 <= x <= 150
session
string

Your opaque session token; isolated to your account.

Required string length: 1 - 128
userTag
string

Your opaque end-user token; isolated to your account.

Required string length: 1 - 128

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.