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

recall()

Recall with the worker memory mode.

What it does

Recall with the worker memory mode.

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

Signature

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

Parameters

query (string) — Natural-language intent used to rank relevant memory.
options? (FleetRetrievalOptions) — Optional limits, filters, tags, or operation-specific behavior.

Result

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

Example

example.ts
const result = await worker.recall("refund policy");