Deployments.ai Docs
Command reference

deployments memory

Memory import, export, review, and retrieval

CommandSummary
deployments memory importImport governed memory
deployments memory exportExport governed memory
deployments memory listList governed memory
deployments memory searchSearch approved memory
deployments memory active-recallRecall memory for an active run
deployments memory strategy-searchSearch memory with an evidence retrieval strategy
deployments memory namespace-readinessInspect memory search namespace readiness
deployments memory namespace-preparePrepare the memory search full-text index
deployments memory qualityInspect memory retrieval quality
deployments memory archiveArchive memory
deployments memory restoreRestore memory
deployments memory deleteDelete memory
deployments memory flushQueue post-run memory extraction
deployments memory flush-statusShow post-run memory extraction status

deployments memory import

Import governed memory.

deployments memory import --space <space>
  • Calls POST /v1/memory/imports (SDK importMemories).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
  • Output contains secrets. They are redacted unless you pass --reveal.
FlagTypeRequiredDefaultDescription
--spacestringyesMemory space ID
--filestringLocal JSON or NDJSON import file
--datastring (json)Inline memory records

Also accepts the global flags.

deployments memory export

Export governed memory.

deployments memory export --space <space>
  • Calls POST /v1/memory/exports (SDK exportMemories).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
  • Output contains secrets. They are redacted unless you pass --reveal.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
--spacestringyesMemory space ID
--formatstringExport format (json)

Also accepts the global flags.

deployments memory list

List governed memory.

deployments memory list
  • Calls GET /v1/memory (SDK listMemories).
  • Needs an environment: --env or the saved context.
  • Output contains secrets. They are redacted unless you pass --reveal.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
--spacestringMemory space ID
--statusstringactive, archived, or deleted

Also accepts the global flags.

Search approved memory.

deployments memory search --query <query> --space <space>
  • Calls POST /v1/memory/search (SDK searchMemories).
  • Needs an environment: --env or the saved context.
  • Output contains secrets. They are redacted unless you pass --reveal.
FlagTypeRequiredDefaultDescription
--querystringyesSearch query
--spacestringyesMemory space ID
--search-keysstring (a,b,c)Search keys
--top-kstring (number)Maximum results

Also accepts the global flags.

deployments memory active-recall

Recall memory for an active run.

deployments memory active-recall --query <query> --run-id <run-id>
  • Calls POST /v1/memory/active-recall (SDK activeMemoryRecall).
  • Needs an environment: --env or the saved context.
  • Output contains secrets. They are redacted unless you pass --reveal.
FlagTypeRequiredDefaultDescription
--querystringyesRecall query
--run-idstringyesActive run ID
--top-kstring (number)Maximum results

Also accepts the global flags.

Search memory with an evidence retrieval strategy.

deployments memory strategy-search --query <query> --space <space> --strategy <strategy>
FlagTypeRequiredDefaultDescription
--querystringyesSearch query
--spacestringyesMemory space ID
--strategystringyesdense-open-search-ann-control-v1, dense-exact-control-v1, hybrid-rerank-v1, or hybrid-rrf-v1
--search-keysstring (a,b,c)Search keys
--top-kstring (number)Maximum results

Also accepts the global flags.

deployments memory namespace-readiness

Inspect memory search namespace readiness.

deployments memory namespace-readiness

Also accepts the global flags.

deployments memory namespace-prepare

Prepare the memory search full-text index.

deployments memory namespace-prepare
  • Calls POST /v1/memory/namespaces/prepare-full-text (SDK prepareMemoryNamespaceFullText).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.

Also accepts the global flags.

deployments memory quality

Inspect memory retrieval quality.

deployments memory quality
FlagTypeRequiredDefaultDescription
--limitstring (number)Maximum telemetry samples
--sincestringStart timestamp

Also accepts the global flags.

deployments memory archive

Archive memory.

deployments memory archive <id>
  • Calls POST /v1/memory/{memoryId}/archive (SDK archiveMemory).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
  • Output contains secrets. They are redacted unless you pass --reveal.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments memory restore

Restore memory.

deployments memory restore <id>
  • Calls POST /v1/memory/{memoryId}/restore (SDK restoreMemory).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
  • Output contains secrets. They are redacted unless you pass --reveal.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments memory delete

Delete memory.

deployments memory delete <id>
  • Calls POST /v1/memory/{memoryId}/delete (SDK deleteMemory).
  • Needs an environment: --env or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
  • Output contains secrets. They are redacted unless you pass --reveal.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--reasonstringReason for this operation

Also accepts the global flags.

deployments memory flush

Queue post-run memory extraction.

deployments memory flush --run-id <run-id>
  • Calls POST /v1/memory/flushes (SDK enqueueMemoryFlush).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--run-idstringyesCompleted run ID
--memory-space-idstringMemory space ID
--memory-modestringMaximum memory scope

Also accepts the global flags.

deployments memory flush-status

Show post-run memory extraction status.

deployments memory flush-status --run-id <run-id>
FlagTypeRequiredDefaultDescription
--run-idstringyesCompleted run ID

Also accepts the global flags.

On this page