Skip to main content
POST
Search

Authorizations

Authorization
string
header
required

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

Body

application/json
q
string
required
Required string length: 1 - 1000
Example:

"pricing discussions with enterprise customers"

limit
integer
default:10
Required range: 1 <= x <= 20
mode
enum<string>
default:hybrid

Search algorithm.

Available options:
semantic,
keyword,
hybrid
sources
string[] | null

Filter by source types (e.g. ["email", "calendar_event"]). Max 20 items.

Maximum array length: 20
metadata
Metadata · object | null

Restrict results to evidence whose metadata contains ALL the given key/value pairs (AND-of-exact-match). Set via the custom-connector ingest metadata field. Max 20 keys; string values only.

Example:
date_from
string | null

Inclusive lower bound on evidence timestamp. Accepts RFC 3339 datetime (2026-01-15T00:00:00Z) or YYYY-MM-DD (treated as start-of-day UTC).

Example:

"2026-01-15"

date_to
string | null

Inclusive upper bound on evidence timestamp. YYYY-MM-DD treated as end-of-day UTC.

Example:

"2026-01-31"

group_by
enum<string>
default:document

Group results by document (deduplicates chunks) or chunk (raw chunk-level results).

Available options:
document,
chunk
include_evidence
boolean
default:false

Include the full typed evidence object for each result. Requires a database round-trip.

Response

Successful Response

count
integer
required

Number of results returned in this response.

Required range: x >= 0
results
SearchResultItem · object[]
required