section

API Design

Recall API

recall.load(ai_id, scope, task_context=None)

Main entry point. Returns unified context package.

Scopes: - full - Ops/Main Claude: Global protocols + Session context + Active projects + Compacted history - task - Agents: Relevant files + Code patterns + Task-specific context only - minimal - Quick recovery: Just protocols + current session ID + immediate context

Examples:

# Ops recovery
recall.load(ai_id='claude', scope='full')

# Agent task context
recall.load(ai_id='agent-t2', scope='task', task_context='Update voice server')

# Quick session restore
recall.load(ai_id='claude', scope='minimal')

recall.compact(ai_id=None, force=False)

On-demand compaction. Summarizes old content via Haiku API.

  • If ai_id provided, compact that AI's history
  • If force=True, compact even recent content
  • Returns summary of what was compacted

recall.status(ai_id=None)

Check recall system status, last compaction, memory usage.

ID: 117da597
Path: Nexus Recall System > API Design
Updated: 2026-01-05T10:39:28