post/messages/search/semantic

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/messages/search/semantic
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

querystring required

Natural language search query

agentIdstring

Filter results to a specific agent

inboxIdstring

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.

fromAddressstring

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.

toAddressstring

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.

limitinteger

Maximum number of results to return

thresholdnumber

Minimum similarity score threshold (0-1)

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.