Skip to main content
Retrieve organizational context scoped to your application (client). Client-scoped memories are visible to all users across all customers. This is typically used for product knowledge, documentation, and announcements that were ingested via bootstrap ingestion.

Parameters

string
Optional conversation identifier. When provided, results are biased toward memories relevant to the active conversation. When supplied, it must be a valid UUID registered via record_message.
string | string[]
One or more search queries to find relevant organizational memories. If omitted, returns the most recent and highest-confidence client-scoped memories.
integer
Maximum number of memory items to return. Defaults to 10. Maximum 50.
string[]
Filter results to specific memory types. If omitted, all types are included.
string
Retrieval mode that controls the speed-quality tradeoff: the retrieval axis (fast vs accurate) of Retrieval Modes.For real per-mode latency on your instance, see Dashboard → Usage.
string
Controls how precisely results are filtered before they’re returned.Independent of mode; combine with either fast or accurate. For real latency on your instance, see Dashboard → Usage.

Returns

A ContextResponse with the following fields:
array
Array of fact memories relevant to the query. Each includes content, confidence, entities, source, and relevance_score.
array
Array of preference memories.
array
Array of episode memories.
object
Response metadata including total_results, query_time_ms, tokens_used, scope, and mode.

Example

Response
Client context is cached with a 30-minute TTL. Repeated queries within the TTL window are served from cache without re-querying the storage engines. New bootstrap ingestions automatically invalidate the cache.

Raises

  • InvalidInputError: when mode is not "fast" or "accurate".
  • InvalidInputError: when precision_level is not "high" or "medium".
  • SDKNotInitializedError: when called before await sdk.initialize().
  • AuthenticationError: when the API key is invalid or revoked.

See also