Skip to documentation
Docs navigation
Docs/recallFromFleet()
Fleet Memory

recallFromFleet()

Recall from shared fleet memory.

What it does

Recall from shared fleet memory.

The operation follows the fleet’s memory mode and agent identity rules when selecting, storing, or transferring memory.

Signature

TypeScript
recallFromFleet(query: string, options?: FleetRetrievalOptions): Promise<RetrievalResult>

Parameters

query (string) — Natural-language intent used to rank relevant memory.
options? (FleetRetrievalOptions) — A typed options object. The applicable fields and defaults are documented below.

RetrievalResult fields

facts contains ranked memory objects augmented with a semantic similarity score.
nodes contains the parent topics represented by the returned facts.
systemPrompt is prompt-ready memory context; tokenCount reports its size against optional tokenBudget.

Result

A retrieval result containing ranked facts, matched topics, generated prompt context, and token counts.

Example

example.ts
const result = await fleet.recallFromFleet("refund window");