REST: response.done
HTTP request
POST https://ai.api.cloud.yandex.net/v1/realtime/server-events/response.done
Body parameters
Request schema: application/json
{
"type": "string",
"event_id": "string",
"response": {
"object": "string",
"id": "string",
"status": "string",
"status_details": "object | null",
"output": [
{
"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"
}
],
"conversation_id": "string | null",
"output_modalities": "array | null",
"max_output_tokens": "integer | string | null",
"audio": "object | null",
"usage": "object | null",
"metadata": "object | null"
}
}
Returned when a response is done streaming (always emitted). The included response contains all output items but may omit raw audio data.
|
Field |
Description |
|
type |
enum Required field. The event type, must be
|
|
event_id |
string Required field. The unique ID of the server event. |
|
response |
Required field. The response resource for Realtime. |
RealtimeResponse
The response resource for Realtime.
|
Field |
Description |
|
object |
string Required field. Object type identifier (e.g., realtime.response). |
|
id |
string Required field. Response ID. |
|
status |
enum Required field. Response status.
|
|
status_details |
object | null Additional status details. |
|
output[] |
Required field. A single item within a Realtime conversation. |
|
conversation_id |
string | null Conversation ID, if attached to a conversation. |
|
output_modalities |
array | null Modalities produced by this response. |
|
max_output_tokens |
integer | string | null Max output tokens (or 'inf'). |
|
audio |
object | null Audio output configuration. |
|
usage |
object | null Usage, if available. |
|
metadata |
object | null Developer-defined metadata. |
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