Skip to main content
POST
web.answers-thread

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

What to answer now, in plain words, in the context of the conversation so far.

Required string length: 1 - 20000
ref
string

The previous turn's ref, to continue that conversation.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
effort
enum<string>
default:medium

How much live research the answer does: low $0.01 (about 5-10s), medium $0.05 (about 15-20s), high $0.25 (about 30-60s, and can miss a short time budget). Default "medium".

Available options:
low,
medium,
high
jsonFormat
object

Optional shape of the answer, as an example object ({"price": "number"}) or a JSON Schema object; the answer then comes back as JSON.

domains
object

Limit the domains the answer may draw on. Set one side, not both.

Response

The result

answer
required

The answer, in the shape of jsonFormat when one was given.

sources
object[]
required

The pages the answer drew on.

ref
string

Reference to what this call created. Pass it as ref to web.answers-thread.