Skip to main content
POST
memory.search

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
namespace
string
required

Which set of documents to work on: an id you choose per user, project or tenant (letters, digits, "_", ":", "-", at most 83 characters). Use the same value across the memory capabilities.

Required string length: 1 - 83
Pattern: ^[a-zA-Z0-9_:-]+$
query
string
required

What to look up, in plain words.

limit
number

How many to return, 1 to 50. Default 10.

Required range: x >= 1
mode
enum<string>
default:hybrid

"hybrid" (default) mixes learned memories with passages from the source documents; "memories" returns only learned context; "chunks" only source passages.

Available options:
hybrid,
memories,
chunks
threshold
number

Minimum relevance from 0 to 1. Raise for fewer, tighter matches; lower for broader recall. Default 0.3.

Required range: 0 <= x <= 1
rerank
enum<string>
default:none

"order" re-sorts the results for relevance; "aggregate" also merges overlapping context into cleaner passages. Slower than "none".

Available options:
none,
order,
aggregate
filter
object

Only return items whose metadata matches this condition.

Response

The result

results
object[]
required

The matching items, best first.