Skip to main content
POST
research.fields.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
schema
object
required

JSON Schema of the fields to research: an object of 1-8 named scalar, enum or short-array fields, at most 8000 characters as JSON. Each field comes back with its value, sources, confidence and reasoning, or as missing with a reason.

question
string

What to research, in plain words, up to 2000 characters. Send this or record.

Required string length: 1 - 2000
record
object

The subject as a flat JSON object of at most 16 scalar values, e.g. { "company": "Example Corp" }. Send this or question.

quality
enum<string>
default:fast

"fast" suits small schemas of a few fields; "standard" cross-references sources for up to ~10 fields; "deep" researches hard questions for a fixed $0.10 per run. Default "fast".

Available options:
fast,
standard,
deep

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.