Skip to main content
POST
web.extract

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 address of the one page to extract from.

schema
object

JSON Schema object describing the fields to extract. At most 8000 characters as JSON. Send this, a prompt, or both.

prompt
string

What to extract, in plain words, up to 2000 characters. Used alone or to steer the schema.

Required string length: 1 - 2000

Response

The result

data
required

The extracted data, in the shape of the schema when one was given.

truncated
boolean
required

True when the data was cut to fit the size caps.

url
string

Final address of the page, when known.

title
string

Page title, when known.