Skip to content

API Reference

This section contains auto-generated documentation from the Zap source code.

Main Exports

The following are available from zap_ai:

from zap_ai import (
    # Main classes
    Zap,
    ZapAgent,
    Task,
    TaskStatus,

    # Conversation types
    ToolCallInfo,
    ConversationTurn,

    # Multimodal message types
    TextContent,
    ImageContent,
    ContentPart,
    MessageContent,

    # Streaming events
    ThinkingEvent,
    ToolCallEvent,
    ToolResultEvent,
    TokenEvent,
    CompletedEvent,
    ErrorEvent,

    # Approval workflows
    ApprovalRules,
    ApprovalRequest,

    # Type helpers
    TContext,
    DefaultContext,
    DynamicPrompt,

    # Exceptions
    ZapConfigurationError,
    ZapNotStartedError,
    AgentNotFoundError,
    TaskNotFoundError,
)

Modules

Module Description
Core Main classes: Zap, ZapAgent, Task, TaskStatus
Conversation History parsing: ConversationTurn, ToolCallInfo
Message Types Multimodal content: TextContent, ImageContent, etc.
Streaming Event types: ThinkingEvent, ToolCallEvent, etc.
Tracing Observability: tracing providers and protocols
Worker Temporal worker utilities
Exceptions Error types