Synchronize Shared State over AG-UI

shared_state.py

"""
Synchronize Shared State over AG-UI
===================================

Give an AG-UI agent a recipe-shaped session state and let its
update_session_state tool emit state snapshots and JSON Patch deltas.

Prerequisites: OPENAI_API_KEY
Run: .venvs/demo/bin/python cookbook/05_agent_os/16_agui/shared_state.py
Try: POST state and ask for a tomato soup at http://localhost:7777/shared-state/agui
"""

from agno.agent import Agent
from agno.db.sqlite import SqliteDb
from agno.models.openai import OpenAIResponses
from agno.os import AgentOS
from agno.os.interfaces.agui import AGUI

# ---------------------------------------------------------------------------
# Create Stateful Agent
# ---------------------------------------------------------------------------

db = SqliteDb(
    id="agui-shared-state-db",
    db_file="tmp/agui_shared_state.db",
)

INITIAL_RECIPE = {
    "recipe": {
        "title": "Untitled recipe",
        "skill_level": "Beginner",
        "cooking_time": "30 min",
        "special_preferences": [],
        "ingredients": [],
        "instructions": [],
    }
}

recipe_agent = Agent(
    id="agui-recipe-agent",
    name="AG-UI Recipe Agent",
    model=OpenAIResponses(id="gpt-5.5"),
    db=db,
    session_state=INITIAL_RECIPE,
    add_session_state_to_context=True,
    enable_agentic_state=True,
    instructions=[
        "Help the user build one recipe in the shared session state.",
        (
            "When the user requests a recipe change, call update_session_state "
            "with the complete updated recipe object under the recipe key."
        ),
        "Use plain ingredient names; do not use icons or emoji.",
        "After updating state, summarize the change in one sentence.",
    ],
)

agent_os = AgentOS(
    id="agui-shared-state-os",
    description="AgentOS emitting AG-UI state snapshots and deltas.",
    agents=[recipe_agent],
    interfaces=[AGUI(agent=recipe_agent, prefix="/shared-state")],
)
app = agent_os.get_app()

# ---------------------------------------------------------------------------
# Run Shared-State Server
# ---------------------------------------------------------------------------

if __name__ == "__main__":
    agent_os.serve(app=app)

Run the Example

Set up your virtual environment

uv venv --python 3.12
source .venv/bin/activate

Install dependencies

uv pip install -U "agno[agui,os]" openai

Export your OpenAI API key

export OPENAI_API_KEY="your_openai_api_key_here"

Run the example

Save the code above as shared_state.py, then run:

python shared_state.py

For the recipe demonstration, replace the request's state with the INITIAL_RECIPE object above and set the user message to "Make a tomato soup recipe". State updates arrive through STATE_SNAPSHOT and STATE_DELTA events when the model selects the state tool.

Send a request

With the server running in another terminal:

Save this complete AG-UI request as agui-input.json. Replace content with the prompt for this example. Use a fresh runId for each run; keep threadId only when continuing the same session.

agui-input.json

{
  "threadId": "example-thread-1",
  "runId": "example-run-1",
  "state": {},
  "messages": [
    {"id": "example-message-1", "role": "user", "content": "Hello"}
  ],
  "tools": [],
  "context": [],
  "forwardedProps": {}
}

The endpoint accepts this object, rather than a JSON string or the REST run endpoint's message form field. The response is an SSE stream whose data values are AG-UI event objects. Inspect RUN_ERROR and RUN_FINISHED events; an HTTP 200 only establishes that the stream opened.

curl --no-buffer -H "Content-Type: application/json" --data-binary @agui-input.json http://localhost:7777/shared-state/agui

Full source: cookbook/05_agent_os/16_agui/shared_state.py