Skip to main content
POST
web.read

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 page to read.

Response

The result

url
string
required

The page URL.

title
string
required

Page title.

text
string
required

Clean page text, without markup.

truncated
boolean
required

True when the text was cut to fit the size cap.