Response Format

SSE Event Format

Each SSE event follows the format below:

event: <event type>
data: <JSON data>

Common Event Data Structure

{
  "type": "event type",
  "sequence_number": 123,
  "output_index": 0,
  "item_id": "item_123",
  "item": {
    // specific event data
  }
}

Field Description

Field Name	Type	Description
type	string	Event type identifier
sequence_number	integer	Event sequence number, used for ordering
output_index	integer	Output index, identifies different output items
item_id	string	Item ID, used to identify specific event items
item	object	Specific event data content