REST: response.output_item.added
HTTP request
POST https://ai.api.cloud.yandex.net/v1/realtime/server-events/response.output_item.added
Body parameters
Request schema: application/json
{
"type": "string",
"event_id": "string",
"response_id": "string",
"output_index": "integer",
"item": {
"id": "string",
"object": "string",
"type": "string",
"role": "string | null",
"status": "string | null",
"content": "array | null",
"call_id": "string | null",
"name": "string | null",
"arguments": "string | null",
"output": "string | null",
"metadata": "object | null"
}
}
Returned when a new output item is created during response generation.
|
Field |
Description |
|
type |
enum Required field. The event type, must be
|
|
event_id |
string Required field. The unique ID of the server event. |
|
response_id |
string Required field. The ID of the response to which the item belongs. |
|
output_index |
integer Required field. The index of the output item in the response. |
|
item |
Required field. A single item within a Realtime conversation. |
RealtimeConversationItem
A single item within a Realtime conversation.
|
Field |
Description |
|
id |
string Item ID. |
|
object |
string Object type identifier (e.g., realtime.item). |
|
type |
string Required field. Item type (message, function_call, function_call_output, mcp_call, etc.). |
|
role |
string | null Role for message items (user, assistant, system). |
|
status |
string | null Item status, if applicable. |
|
content |
array | null Item content parts. |
|
call_id |
string | null Call ID for tool/function call items. |
|
name |
string | null Tool/function name for call items. |
|
arguments |
string | null Tool/function call arguments as JSON string. |
|
output |
string | null Tool/function output as string or JSON-encoded string. |
|
metadata |
object | null Developer-defined metadata. |
Response
HTTP Code: 200
OK