Skip to main content

No project description provided

Project description

ag-ui-protocol

Python SDK for the Agent-User Interaction (AG-UI) Protocol.

ag-ui-protocol provides Python developers with strongly-typed data structures and event encoding for building AG-UI compatible agent servers. Built on Pydantic for robust validation and automatic camelCase serialization for seamless frontend integration.

Installation

pip install ag-ui-protocol
poetry add ag-ui-protocol
pipenv install ag-ui-protocol

Features

  • 🐍 Python-native – Idiomatic Python APIs with full type hints and validation
  • 📋 Pydantic models – Runtime validation and automatic JSON serialization
  • 🔄 Streaming events – 16 core event types for real-time agent communication
  • High performance – Efficient event encoding for Server-Sent Events

Quick example

from ag_ui.core import TextMessageContentEvent, EventType
from ag_ui.encoder import EventEncoder

# Create a streaming text event
event = TextMessageContentEvent(
    type=EventType.TEXT_MESSAGE_CONTENT,
    message_id="msg_123",
    delta="Hello from Python!"
)

# Encode for HTTP streaming
encoder = EventEncoder()
sse_data = encoder.encode(event)
# Output: data: {"type":"TEXT_MESSAGE_CONTENT","messageId":"msg_123","delta":"Hello from Python!"}\n\n

Packages

  • ag_ui.core – Types, events, and data models for AG-UI protocol
  • ag_ui.encoder – Event encoding utilities for HTTP streaming

Documentation

Contributing

Bug reports and pull requests are welcome! Please read our contributing guide first.

License

MIT © 2025 AG-UI Protocol Contributors

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

ag_ui_protocol-0.1.8.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

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

ag_ui_protocol-0.1.8-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file ag_ui_protocol-0.1.8.tar.gz.

File metadata

  • Download URL: ag_ui_protocol-0.1.8.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.9 Darwin/24.1.0

File hashes

Hashes for ag_ui_protocol-0.1.8.tar.gz
Algorithm Hash digest
SHA256 eb745855e9fc30964c77e953890092f8bd7d4bbe6550d6413845428dd0faac0b
MD5 180654f0f08c31dc448d1680d7660290
BLAKE2b-256 27de0bddf7f26d5f38274c99401735c82ad59df9cead6de42f4bb2ad837286fe

See more details on using hashes here.

File details

Details for the file ag_ui_protocol-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: ag_ui_protocol-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.9 Darwin/24.1.0

File hashes

Hashes for ag_ui_protocol-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 1567ccb067b7b8158035b941a985e7bb185172d660d4542f3f9c6fff77b55c6e
MD5 1e92aab649ae9d54f0d8c84cf99b5b47
BLAKE2b-256 c40040c6b0313c25d1ab6fac2ecba1cd5b15b1cd3c3a71b3d267ad890e405889

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