Skip to content

API Reference

Auto-generated API documentation from source code docstrings.

Core API

The amplifier-core package provides the kernel APIs:

  • Session - Main entry point for creating AI sessions
  • Coordinator - Infrastructure context for modules
  • Hooks - Event system and hook registry
  • Models - Data models (HookResult, ToolResult, etc.)
  • Events - Canonical event constants

CLI API

The amplifier-app-cli package provides CLI components:

  • Commands - CLI command implementations

Usage

Creating a Session

from amplifier_core import AmplifierSession

mount_plan = {
    "session": {
        "orchestrator": "loop-basic",
        "context": "context-simple"
    },
    "providers": [
        {"module": "provider-anthropic"}
    ]
}

async with AmplifierSession(mount_plan) as session:
    await session.initialize()
    response = await session.execute("Hello!")

Using the Coordinator

# In a module's mount function
async def mount(coordinator, config=None):
    # Access infrastructure
    session_id = coordinator.session_id

    # Mount modules
    await coordinator.mount("tools", my_tool, name="my-tool")

    # Emit events
    await coordinator.hooks.emit("my-module:ready", {})

    # Register capabilities
    coordinator.register_capability("my-capability", implementation)

Note on Auto-Generation

These API docs are generated from Python docstrings using mkdocstrings.

For the most accurate and up-to-date information, refer to the source code: