Skip to main content
POST
Search
The simplest retrieval endpoint. Use it when you want raw hits and will craft your own prompt downstream. For grounded answers with citations + exclusions, use /v1/context or /v1/ask.

Required action

search — see Authentication → Actions.

Cost

Each successful call consumes 1 credit. On Builder tier this is hard-blocked at the monthly cap. On Studio/Scale tiers calls past the cap are billed at $0.015 per answer overage. See Billing.

Body

string
required
The user-facing question or search phrase. Sent as-is to the embedding model.
integer
default:"8"
Maximum number of hits to return. Min 1, max 25.

Response

string
Echo of the input query for convenience.
array
Ranked array of source items matching the query, ordered by score descending.

Example

Provider scoping

If the calling key has allowedProviders set, hits from excluded providers are filtered out server-side before the response is built. See Scopes for details. The exclusions array that explains why something was filtered is only returned by /v1/context — /v1/search is silent about scope filtering.