Skip to main content
POST
Search Deal Context — NL answer over deal memory

Authorizations

Authorization
string
header
required

API key passed as Bearer token (e.g. "Bearer your-api-key")

Body

application/json
question
string
required

The natural-language question to answer.

Example:

"What did the buyer say about pricing?"

deal_ids
string[]

Optional opportunity ids to scope the answer to. Omit to search all visible organization deals.

Maximum array length: 2500
Example:
deal_id
string
deprecated

Deprecated v1 alias for a single deal. Prefer deal_ids.

Example:

"00000000-0000-0000-0000-000000000000"

budget_mode
enum<string>
default:medium

Search depth preset for public direct calls. instant is only valid with exactly one deal_ids entry.

Available options:
instant,
medium,
high

Response

A synthesized, citation-backed answer for the resolved deal scope.

answer
string
required

The synthesized natural-language answer, grounded in the citations.

missing_context
string | null
required

Non-null when the answer names concrete source gaps or caveats.

citations
object[]
required

Evidence the answer is grounded in, in support order.

source_artifacts
object[]
required

Deduped manifest of artifacts referenced by artifact citations.

deal_id
string | null
required

Single resolved deal id when the request resolved to one deal; null for multi-deal or all-visible searches.

stop_reason
enum<string>
required

How the bounded search loop ended.

Available options:
final_answer,
fallback_final,
timeout
elapsed_ms
number
required

Server-side wall-clock for the run, in milliseconds.