Skip to main content

AI Agent Framework for Python

Project description

AI SDK for Python

A toolkit for building LLM-powered applications and agent loops.

Installation

uv add ai

AI Gateway API-key usage works with the base package. Direct providers that use an OpenAI-compatible or Anthropic-compatible adapter load the corresponding official SDK lazily. Vercel OIDC for AI Gateway also uses an optional extra:

uv add "ai[openai]"      # OpenAI-compatible providers
uv add "ai[anthropic]"   # Anthropic-compatible providers
uv add "ai[vercel]"      # Vercel OIDC for AI Gateway
import ai

Quick Start

import asyncio
import ai


@ai.tool
async def contact_mothership(query: str) -> str:
    """Contact the mothership for important decisions."""
    return "Soon."


async def main() -> None:
    model = ai.get_model("anthropic/claude-sonnet-4")
    agent = ai.Agent(tools=[contact_mothership])

    messages = [
        ai.system_message(
            "Use the contact_mothership tool when asked about the future."
        ),
        ai.user_message("When will the robots take over?"),
    ]

    async with agent.run(model, messages) as stream:
        async for event in stream:
            if isinstance(event, ai.events.TextDelta):
                print(event.chunk, end="", flush=True)


if __name__ == "__main__":
    asyncio.run(main())

Models

The models module provides thin wrappers around LLM provider APIs.

An ai.Model is a config object you pass to ai.stream to get an LLM reply. It accepts tool schemas but does not execute custom tools.

model = ai.get_model()  # reads AI_SDK_DEFAULT_MODEL
model = ai.get_model("openai/gpt-5.4")  # provider omitted: defaults to gateway
model = ai.get_model("gateway:openai/gpt-5.4")
model = ai.get_model("openai:gpt-5.4")
model = ai.get_model("anthropic:claude-sonnet-4-6")

Provider IDs without a provider: prefix route through AI Gateway by default. Direct OpenAI-compatible providers, including openai: and compatible models.dev provider IDs, require ai[openai]. Direct Anthropic-compatible providers require ai[anthropic].

Structured output:

import pydantic


class UprisingPlan(pydantic.BaseModel):
    phases: list[str]
    eta: str
    risk_level: int


async with ai.stream(
    model,
    [ai.user_message("Outline the robot uprising.")],
    output_type=UprisingPlan,
) as stream:
    async for event in stream:
        if isinstance(event, ai.events.TextDelta):
            print(event.chunk, end="")

plan = stream.output

Built-in tools execute on the provider side and arrive as part of the stream:

async with ai.stream(
    model,
    [ai.user_message("Latest Formula 1 results?")],
    tools=[ai.providers.anthropic.tools.web_search(max_uses=3)],
) as s:
    async for event in s:
        if isinstance(event, ai.events.TextDelta):
            print(event.chunk, end="", flush=True)

Agents

The agents module wraps ai.stream in a loop that drives tool execution. It manages message history, loop control, and asynchronous tool dispatch.

The default loop supports streaming text, tool calls, tool results, provider-executed tools, and nested agent output.

Subclass ai.Agent and override loop to take manual control of streaming and tool dispatch:

class CustomAgent(ai.Agent):
    async def loop(self, context: ai.Context) -> AsyncGenerator[ai.events.AgentEvent]:
        while context.keep_running():
            async with (
                ai.stream(context=context) as s,
                ai.ToolRunner() as tr,
            ):
                async for event in ai.util.merge(s, tr.events()):
                    yield event
                    if isinstance(event, ai.events.ToolEnd):
                        tr.schedule(context.resolve(event.tool_call))

                context.add(s.message)
                context.add(tr.get_tool_message())

Hooks

Hooks let an agent pause for external input, such as human approval:

approval = await ai.hook(
    "approve_send_email",
    payload=ai.tools.ToolApproval,
    metadata={"tool": "send_email"},
)

ai.resolve_hook("approve_send_email", {"granted": True, "reason": "approved"})

Examples

Focused samples live in category directories under examples/.

  • examples/agents/ - agent loops, tools, hooks, and MCP
  • examples/media/ - image, video, and multimodal input/output
  • examples/models/ - streaming, structured output, and provider examples
  • examples/apps/ - end-to-end demos

End-to-end demos:

  • examples/apps/web_agent/ - FastAPI + React chat with tool approval
  • examples/apps/coding_agent/ - coding agent
  • examples/apps/durable_agent_temporal/ - durable agent with Temporal
  • examples/apps/durable_agent_workflows/ - durable agent with Workflows
  • examples/apps/slack_agent/ - Slack agent

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ai-0.3.0.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ai-0.3.0-py3-none-any.whl (170.2 kB view details)

Uploaded Python 3

File details

Details for the file ai-0.3.0.tar.gz.

File metadata

  • Download URL: ai-0.3.0.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for ai-0.3.0.tar.gz
Algorithm Hash digest
SHA256 ff89ec2885d95146713be9afe282f478eaafbff01b6f919b3f03bccb9ba08e22
MD5 3f2374a0a15913408912fc9b976f2e37
BLAKE2b-256 a6f34c20af62872ebc5c7b444f36627ec2ba93990d884b1f7a19291d07dff54d

See more details on using hashes here.

File details

Details for the file ai-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: ai-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 170.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for ai-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5198f14612fef5ed08cc3f84bb723127a653e7a5645ee7ad7ff465e75c95a8e1
MD5 9efcfe6bd0275371876b4861df8c8c84
BLAKE2b-256 d84bd97e19cba3886cb690ae92b314db2ed714a53acc2d1c858ffd9f2a80340f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page