Skip to main content

Production-ready SDK for building AI agents with Pydantic AI

Project description

pai-agent-sdk

Release Build status codecov Commit activity License

Production-ready SDK for building AI agents with Pydantic AI.

Early Stage Warning: This project is in active development. APIs may change frequently between versions. We welcome feedback and contributions to help stabilize the SDK.

Key Features

  • Environment-based Architecture: Inject file operations, shell access, and resumable resources via Environment for clean separation of concerns(check agent-environment)
  • Resumable Sessions: Export and restore AgentContext state for multi-turn conversations across restarts
  • Hierarchical Agents: Delegate specialized tasks to subagents with automatic tool inheritance
  • Human-in-the-Loop: Built-in approval workflows for sensitive tool operations
  • Streaming Support: Real-time streaming of agent responses and tool executions

Installation

# Recommended: install with all optional dependencies
pip install pai-agent-sdk[all]
uv add pai-agent-sdk[all]

# Or install individual extras as needed
pip install pai-agent-sdk[docker]    # Docker sandbox support
pip install pai-agent-sdk[web]       # Web tools (tavily, firecrawl, markitdown)
pip install pai-agent-sdk[document]  # Document processing (pymupdf, markitdown)

Project Structure

This repository contains:

  • pai_agent_sdk/ - Core SDK for building AI agents with environment abstraction, toolsets, and session management
  • paintress_cli/ - Reference CLI implementation with TUI (Terminal User Interface) for interactive agent sessions
  • examples/ - Production-ready code examples demonstrating SDK features
  • docs/ - Comprehensive documentation for SDK architecture and APIs

Quick Start

Using the SDK

from pai_agent_sdk.agents import create_agent, stream_agent

# create_agent returns AgentRuntime (not a context manager)
runtime = create_agent("openai:gpt-4o")

# stream_agent manages runtime lifecycle automatically
async with stream_agent(runtime, "Hello") as streamer:
    async for event in streamer:
        print(event)

Using Paintress CLI

For a ready-to-use terminal interface, try paintress-cli - a TUI reference implementation built on top of pai-agent-sdk:

# Run directly with uvx (no installation needed)
uvx paintress-cli

# Or install globally
uv tool install paintress-cli
pip install paintress-cli

Features:

  • Rich terminal UI with syntax highlighting and streaming output
  • Built-in tool approval workflows (human-in-the-loop)
  • Session management with conversation history
  • Browser automation support via Docker sandbox
  • MCP (Model Context Protocol) server integration

Examples

Check out the examples/ directory for production-ready patterns:

Example Description
general.py Complete production pattern with streaming, HITL approval, and session persistence
deepresearch.py Autonomous research agent with web search and content extraction
browser_use.py Browser automation with Docker-based headless Chrome sandbox

For Agent Users

If you're using an AI agent (e.g., Claude, Cursor) that supports skills:

  • Clone this repo: The SKILL.md file in the repository root provides comprehensive guidance for agents
  • Download release package: Get the latest SKILL.zip from the Releases page (automatically built during each release)

Configuration

Copy examples/.env.example to examples/.env and configure your API keys.

Documentation

Development

See CONTRIBUTING.md for development setup and guidelines.

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

pai_agent_sdk-0.4.9.tar.gz (607.0 kB view details)

Uploaded Source

Built Distribution

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

pai_agent_sdk-0.4.9-py3-none-any.whl (191.8 kB view details)

Uploaded Python 3

File details

Details for the file pai_agent_sdk-0.4.9.tar.gz.

File metadata

  • Download URL: pai_agent_sdk-0.4.9.tar.gz
  • Upload date:
  • Size: 607.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.2

File hashes

Hashes for pai_agent_sdk-0.4.9.tar.gz
Algorithm Hash digest
SHA256 c75e87e6d018302d5338935bec84f9cfe05a1b35467bf05eca9d4172d469aba7
MD5 3033f7304b0198d0e875ae08de42b377
BLAKE2b-256 2d3558c49c252950f6a3f304baab01ba52d4487e15f1815eff0f4c795ed5fa66

See more details on using hashes here.

File details

Details for the file pai_agent_sdk-0.4.9-py3-none-any.whl.

File metadata

File hashes

Hashes for pai_agent_sdk-0.4.9-py3-none-any.whl
Algorithm Hash digest
SHA256 12d406f21213e520ef2d8626d99654b70688965b56fb76d99638f2e9d9bb05d8
MD5 358aafee10dec59fbe33061efa5c86eb
BLAKE2b-256 1833c3c140b8a5e33fc600805a312af934d63dbe221ab39f90845b701152ea0c

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