API reference

The API reference is auto-generated from TypeScript types + JSDoc by TypeDoc. The output lives in docs/api-reference/ — browse online via GitHub or run npm run docs:api to regenerate locally.

Where to find what

You want	Look at
Agent.create({...}) shape	import('agentfootprint').Agent — your IDE shows the builder methods
defineMemory({...}) options	src/memory/define.types.ts (curated public types)
defineSkill({...}) options	src/lib/injection-engine/factories/defineSkill.ts
LLMProvider interface	src/adapters/types.ts
MemoryStore interface	src/memory/store/types.ts
Event taxonomy (47 events × 13 domains)	src/events/registry.ts
Conventions (subflow ids, injection keys)	src/conventions.ts

Every type has a JSDoc with at least one example. The MemoryStore interface alone has 200+ lines of JSDoc covering each method’s contract.

Subpath imports

import { Agent, defineMemory, mock } from 'agentfootprint';                  // top-level
import { RedisStore } from 'agentfootprint/memory-redis';                    // Redis adapter
import { AgentCoreStore } from 'agentfootprint/memory-agentcore';            // AgentCore adapter
import { withRetry, withFallback } from 'agentfootprint/resilience';         // resilience decorators
import { toSSE } from 'agentfootprint/stream';                               // SSE bridge

How it’s generated

npm run docs:api    # runs `typedoc` per typedoc.json

TypeDoc reads src/index.ts, follows the public exports, emits markdown to docs/api-reference/. Configuration lives in typedoc.json at the repo root. The release script regenerates before each release; consumers can regenerate locally to browse offline.

Browsing the reference

The generated tree is organized by TypeScript declaration kind:

• docs/api-reference/classes/ — every exported class (Agent, LLMCall, MockProvider, etc.)
• docs/api-reference/functions/ — every exported function (defineMemory, defineRAG, mock, withRetry, etc.)
• docs/api-reference/interfaces/ — every exported interface (LLMProvider, MemoryStore, Tool, etc.)
• docs/api-reference/type-aliases/ — every exported type alias
• docs/api-reference/variables/ — exported constants (MEMORY_TYPES, etc.)

Next steps

• Manifesto — what the library is and isn’t
• Quick Start — first agent in 5 minutes
• Citations — the research foundation