Skip to main content
POST
Ask

Authorizations

Authorization
string
header
required

Pass your pk_live_... API key as a Bearer token.

Body

application/json
query
string
required
Required string length: 1 - 2000
Example:

"What are our top blockers for Q1?"

timezone
string | null

IANA timezone identifier (e.g. "America/New_York") for resolving relative time references like "today" or "last week". Defaults to UTC.

Example:

"America/New_York"

metadata
Metadata · object | null

Restrict the evidence the model can ground its answer in to rows whose metadata contains ALL the given key/value pairs (AND-of-exact-match). Max 20 keys; string values only.

Example:

Response

Successful Response

response
string
required

The grounded answer to your question.

citations
Citation · object[]
required

Per-record citations grounding the answer.

truncated
boolean
required

True when citations were capped — more records were used than are returned.

metadata
PublicAskMetadata · object | null

Observability for this answer. May be absent.