REST: conversation.item.done

HTTP request

POST https://ai.api.cloud.yandex.net/v1/realtime/server-events/conversation.item.done
        

Body parameters

Request schema: application/json

{
          "type": "string",
          "event_id": "string",
          "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"
          },
          "previous_item_id": "string"
        }
        

Returned when a conversation item is finalized. Includes full item content except raw audio data, which can be retrieved with conversation.item.retrieve if needed.

Field

Description

type

enum

Required field. The event type, must be conversation.item.done.

  • conversation.item.done

event_id

string

Required field. The unique ID of the server event.

item

RealtimeConversationItem

Required field. A single item within a Realtime conversation.

previous_item_id

string

The ID of the preceding item (if applicable).

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