Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Body

application/json

Semantic search parameters

query
string
required

Natural language search query

Required string length: 1 - 1000
agentId
string

Filter results to a specific agent

Pattern: ^[cC][^\s-]{8,}$
inboxId
string

Filter to one inbox — messages delivered to it (inbound) or sent from it (outbound). The precise way to read a single mailbox when an agent owns several.

Pattern: ^[cC][^\s-]{8,}$
fromAddress
string

Filter by sender address, matched exactly (case-sensitive). On inbound mail this is the counterparty; on outbound it is the agent identity the mail was sent from.

toAddress
string

Filter by recipient address, matched exactly (case-sensitive). Note that outbound messages store every recipient in one comma-joined value, so an exact filter matches a multi-recipient send only when given that same joined string — prefer inboxId to scope outbound mail to a mailbox.

limit
integer
default:10

Maximum number of results to return

Required range: 1 <= x <= 50
threshold
number
default:0.7

Minimum similarity score threshold (0-1)

Required range: 0 <= x <= 1

Response

200 - application/json

OK

Semantic search results

results
object[]
required

List of messages ranked by semantic similarity