docs/concepts/data-flow.md
How messages flow from agents to UI.
Agent (LLM) → A2UI Generator → Transport (SSE/WS/A2A)
↓
Client (Stream Reader) → Message Parser → Renderer → Native UI
A2UI defines a sequence of JSON messages that describe the UI. When streamed, these messages are often formatted as JSON Lines (JSONL), where each line is a complete JSON object.
=== "v0.8"
```jsonl
{
"surfaceUpdate": {
"surfaceId": "main",
"components": [...]
}
}
{
"dataModelUpdate": {
"surfaceId": "main",
"contents": [
{
"key": "user",
"valueMap": [
{ "key": "name", "valueString": "Alice" }
]
}
]
}
}
{
"beginRendering": {
"surfaceId": "main",
"root": "root-component"
}
}
```
=== "v0.9"
```jsonl
{
"version": "v0.9",
"createSurface": {
"surfaceId": "main",
"catalogId": "https://a2ui.org/specification/v0_9/basic_catalog.json"
}
}
{
"version": "v0.9",
"updateComponents": {
"surfaceId": "main",
"components": [...]
}
}
{
"version": "v0.9",
"updateDataModel": {
"surfaceId": "main",
"path": "/user",
"value": { "name": "Alice" }
}
}
```
Why this format?
A sequence of self-contained JSON objects is streaming-friendly, easy for LLMs to generate incrementally, and resilient to errors.
User: "Book a table for 2 tomorrow at 7pm"
=== "v0.8"
**1. Agent defines UI structure:**
```json
{
"surfaceUpdate": {
"surfaceId": "booking",
"components": [
{
"id": "root",
"component": {
"Column": {
"children": {
"explicitList": ["header", "guests-field", "submit-btn"]
}
}
}
},
{
"id": "header",
"component": {
"Text": {
"text": { "literalString": "Confirm Reservation" },
"usageHint": "h1"
}
}
},
{
"id": "guests-field",
"component": {
"TextField": {
"label": { "literalString": "Guests" },
"text": { "path": "/reservation/guests" }
}
}
},
{
"id": "submit-btn",
"component": {
"Button": {
"child": "submit-text",
"action": {
"name": "confirm",
"context": [
{ "key": "details", "value": { "path": "/reservation" } }
]
}
}
}
}
]
}
}
```
**2. Agent populates data:**
```json
{
"dataModelUpdate": {
"surfaceId": "booking",
"path": "/reservation",
"contents": [
{ "key": "datetime", "valueString": "2025-12-16T19:00:00Z" },
{ "key": "guests", "valueString": "2" }
]
}
}
```
**3. Agent signals render:**
```json
{
"beginRendering": {
"surfaceId": "booking",
"root": "root"
}
}
```
**4. User edits guests to "3"** → Client updates `/reservation/guests` automatically
**5. User clicks "Confirm"** → Client sends action:
```json
{
"userAction": {
"name": "confirm",
"surfaceId": "booking",
"context": {
"details": {
"datetime": "2025-12-16T19:00:00Z",
"guests": "3"
}
}
}
}
```
**6. Agent responds** → Updates UI or sends:
```json
{ "deleteSurface": { "surfaceId": "booking" } }
```
=== "v0.9"
**1. Agent creates surface:**
```json
{
"version": "v0.9",
"createSurface": {
"surfaceId": "booking",
"catalogId": "https://a2ui.org/specification/v0_9/basic_catalog.json"
}
}
```
**2. Agent defines UI structure:**
```json
{
"version": "v0.9",
"updateComponents": {
"surfaceId": "booking",
"components": [
{
"id": "root",
"component": "Column",
"children": ["header", "guests-field", "submit-btn"]
},
{
"id": "header",
"component": "Text",
"text": "Confirm Reservation",
"variant": "h1"
},
{
"id": "guests-field",
"component": "TextField",
"label": "Guests",
"value": { "path": "/reservation/guests" }
},
{
"id": "submit-btn",
"component": "Button",
"child": "submit-text",
"variant": "primary",
"action": {
"event": {
"name": "confirm",
"context": {
"details": { "path": "/reservation" }
}
}
}
}
]
}
}
```
**3. Agent populates data:**
```json
{
"version": "v0.9",
"updateDataModel": {
"surfaceId": "booking",
"path": "/reservation",
"value": {
"datetime": "2025-12-16T19:00:00Z",
"guests": "2"
}
}
}
```
**4. User edits guests to "3"** → Client updates `/reservation/guests` automatically
**5. User clicks "Confirm"** → Client sends action:
```json
{
"version": "v0.9",
"action": {
"name": "confirm",
"surfaceId": "booking",
"context": {
"details": {
"datetime": "2025-12-16T19:00:00Z",
"guests": "3"
}
}
}
}
```
**6. Agent responds** → Updates UI or sends:
```json
{
"version": "v0.9",
"deleteSurface": { "surfaceId": "booking" }
}
```
A2UI is transport-agnostic — any mechanism that can deliver JSON messages works:
See transports for implementation details.
Instead of waiting for the entire response to be generated before showing anything to the user, chunks of the response can be streamed to the client as they are generated and progressively rendered.
Users see UI building in real-time instead of staring at a spinner.
/user/name not entire / model