API reference

Everything the package exposes, grouped by what you are trying to do. Each page documents the signature, the meaning of every field, and the behavior you can rely on. Source links are included when you want to see the implementation.

If you are new here, start with Get started or Examples; come back when you need an exact name or default.

• Client
• Agent runtime
• Messages
• Events
• Models
• Providers
• Tools
• JIT harness
• Sandbox
• Storage
• Extensions
• Constants
• Writing API docs

Common entry points

Create a client

create_agent() builds an AgentClient over the runtime.

create_agent

Run or stream

AgentClient for applications, Agent for the loop itself.

AgentClient

Write an extension

AgentExtension and AgentRunContext.

AgentExtension

Implement a model

AgentModel is the protocol every adapter follows.

AgentModel

Note

Packages re-export nothing. Import each name from the module that defines it:

from zett_agent.client import create_agent
from zett_agent.tools.base import tool
from zett_agent.providers.openai import OpenAIProvider
from zett_agent.extensions.coding import CodingExtension

The reference documents every public object the runtime defines, plus the protected subclass helpers extension authors need. It intentionally omits unrelated inherited methods from Python enums and third-party validation frameworks.