Agent Framework AG-UI Integration

AG-UI protocol integration for Agent Framework, enabling seamless integration with AG-UI's web interface and streaming protocol.

Installation

pip install agent-framework-ag-ui

Quick Start

Server (Host an AI Agent)

from fastapi import FastAPI
from agent_framework import ChatAgent
from agent_framework.azure import AzureOpenAIChatClient
from agent_framework.ag_ui import add_agent_framework_fastapi_endpoint

# Create your agent
agent = ChatAgent(
    name="my_agent",
    instructions="You are a helpful assistant.",
    chat_client=AzureOpenAIChatClient(
        endpoint="https://your-resource.openai.azure.com/",
        deployment_name="gpt-4o-mini",
        api_key="your-api-key",
    ),
)

# Create FastAPI app and add AG-UI endpoint
app = FastAPI()
add_agent_framework_fastapi_endpoint(app, agent, "/")

# Run with: uvicorn main:app --reload

Client (Connect to an AG-UI Server)

import asyncio
from agent_framework import TextContent
from agent_framework.ag_ui import AGUIChatClient

async def main():
    async with AGUIChatClient(endpoint="http://localhost:8000/") as client:
        # Stream responses
        async for update in client.get_streaming_response("Hello!"):
            for content in update.contents:
                if isinstance(content, TextContent):
                    print(content.text, end="", flush=True)
        print()

asyncio.run(main())

The AGUIChatClient supports:

Streaming and non-streaming responses
Hybrid tool execution (client-side + server-side tools)
Automatic thread management for conversation continuity
Integration with ChatAgent for client-side history management

Documentation

Getting Started Tutorial - Step-by-step guide to building AG-UI servers and clients
- Server setup with FastAPI
- Client examples using AGUIChatClient
- Hybrid tool execution (client-side + server-side)
- Thread management and conversation continuity
Examples - Complete examples for AG-UI features

Features

This integration supports all 7 AG-UI features:

Agentic Chat: Basic streaming chat with tool calling support
Backend Tool Rendering: Tools executed on backend with results streamed to client
Human in the Loop: Function approval requests for user confirmation before tool execution
Agentic Generative UI: Async tools for long-running operations with progress updates
Tool-based Generative UI: Custom UI components rendered on frontend based on tool calls
Shared State: Bidirectional state sync between client and server
Predictive State Updates: Stream tool arguments as optimistic state updates during execution

Architecture

The package uses a clean, orchestrator-based architecture:

AgentFrameworkAgent: Lightweight wrapper that delegates to orchestrators
Orchestrators: Handle different execution flows (default, human-in-the-loop, etc.)
Confirmation Strategies: Domain-specific confirmation messages (extensible)
AgentFrameworkEventBridge: Converts Agent Framework events to AG-UI events
Message Adapters: Bidirectional conversion between AG-UI and Agent Framework message formats
FastAPI Endpoint: Streaming HTTP endpoint with Server-Sent Events (SSE)

Next Steps

New to AG-UI? Start with the Getting Started Tutorial
Want to see examples? Check out the Examples for AG-UI features

License

MIT

Metadata

Release files for agent-framework-ag-ui 1.0.0b251120

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for agent-framework-ag-ui 1.0.0b251120
File	Size	Uploaded
agent_framework_ag_ui-1.0.0b251120.tar.gz	83.8 kB	Nov 21, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for agent-framework-ag-ui 1.0.0b251120
File	Interpreter	ABI	Platform	Reset
agent_framework_ag_ui-1.0.0b251120-py3-none-any.whl 63.1 kB Nov 21, 2025	Python 3	none	any	Details

Total release size: 146.8 kB

Release files / agent_framework_ag_ui-1.0.0b251120.tar.gz

Download URL	agent_framework_ag_ui-1.0.0b251120.tar.gz
Size	83.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`de9fb4ba01598a35057f33cd60e4f4c924b9f30c56bfab7303cea81722b3ba16`
BLAKE2b-256 checksum How to use checksums	`d1f3a9b6b5093f7a0e75061cf50ed0bf7bd362ec125ee1ce74c79880166a576c`
Upload date	Nov 21, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.9.10 {"installer":{"name":"uv","version":"0.9.10"},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}`

Release files / agent_framework_ag_ui-1.0.0b251120-py3-none-any.whl

Download URL	agent_framework_ag_ui-1.0.0b251120-py3-none-any.whl
Size	63.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`ea4ec52ba0aa352ebac2a7b43ce3bd402188ccc749f6c83bb7e3276b8bd6e434`
BLAKE2b-256 checksum How to use checksums	`a149f88a17877dcde8db1e9f6cd0eb7e9ba023cfacabf872c98a036979eae846`
Upload date	Nov 21, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.9.10 {"installer":{"name":"uv","version":"0.9.10"},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}`