Skip to main content

Interface Parameters

Pass one of agent or team to the AGUI constructor.
Provide agent or team. The constructor raises ValueError if neither is set.

Endpoints

Available at the interface prefix (root by default, customizable with prefix).

POST {prefix}/agui

Accepts a RunAgentInput payload and returns a Server-Sent Events stream (text/event-stream) of AG-UI protocol events. The endpoint sets permissive CORS headers (Access-Control-Allow-Origin: *) for local frontend development.

GET {prefix}/status

Health check. Returns {"status": "available"}.

Event Mapping

The interface translates the Agno run stream into AG-UI protocol events.
Reasoning works with both native reasoning models and the ReasoningTools toolkit. Frontend tools (external_execution=True) stream as tool calls the client executes and returns on the next request.

Developer Resources

AG-UI Guide

Sessions, reasoning, structured output, and troubleshooting.

Setup Guide

Run the backend and connect a Dojo frontend.

Deploy Guide

Serve the protocol endpoint for frontend integration.

AG-UI Protocol

Official protocol specification and SDKs.