Skip to main content
POST
research.run.get

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
ref
string
required

The ref returned by web.research-report or a row of research.run.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

status
enum<string>
required

Whether the run is waiting, running, completed, failed or cancelled.

Available options:
queued,
running,
completed,
failed,
cancelled
grounding
object[]
required

Evidence for the requested output, at most 100 fields.

truncated
boolean
required

True when retained output was cut to the size limits.

text
string

Retained research text, when available.

data

Requested structured fields, when available.

stopReason
enum<string>

Why the run ended, when known.

Available options:
schema_satisfied,
budget_reached,
time_limit_reached,
stopped,
error,
cancelled
createdAt
string

Creation time in ISO 8601.

completedAt
string

Completion time in ISO 8601.