Skip to main content
POST
web.read-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 page URL to read.

query
string

Optional intent used to select relevant excerpts, rather than full page content.

chunksPerSource
integer

Most excerpts per page, 1 to 5; requires query.

Required range: 1 <= x <= 5
depth
enum<string>
default:basic

Extraction effort; advanced may cost more. Default basic.

Available options:
basic,
advanced
format
enum<string>
default:text

Content format. Default text.

Available options:
text,
markdown
includeImages
boolean

Request public source images.

includeIcon
boolean

Request a public source icon.

timeoutSeconds
number
default:10

Source wait in seconds, 1 to 60. Some sources currently decline above 24.

Required range: 1 <= x <= 60
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.