Skip to main content
POST
Ask

Body

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

"What are our top blockers for Q1?"

timezone
string<iana-timezone>

IANA timezone identifier (e.g. "America/New_York") for resolving relative time references like "today" or "last week". Unknown identifiers are rejected. Defaults to America/New_York when omitted.

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. Shorthand for a filter whose must lists each pair; combines with filter when both are set. Max 20 keys; string values only.

Example:
filter
EvidenceFilter · object | null

Boolean scope over items. Conditions test a field: source (source type such as email, slack_message, calendar_event, or a custom kind), connection (the connected account or custom connector, such as gmail:acme), timestamp (a date range), or any metadata tag you set at ingest on custom-connector items. must is AND, should is OR, must_not is NOT; nest a filter condition to group. Max depth 3. Example: emails and meetings from Q1 2026 in either of two accounts, excluding items tagged restricted. Any scope switches the answer to evidence retrieval only, so the model searches and reads matching records instead of querying your knowledge graph.

Example:

Response

Successful Response

citations
Citation · object[]
required

Per-record citations grounding the output.

form
enum<string>
required

The form the request asked for, echoed.

Available options:
chat,
report
metadata
AskMetadata · object
required

Observability for this answer.

response
string
required

Output generated for your query.

truncated
boolean
required

True when citations was capped — your answer drew on more supporting records than are returned. The omitted records are similar in shape to the ones present; refine your query if you need them enumerated.