DocsICP FilingConsole
Documentation
Home Page Alibaba Cloud Model Studio API Reference (Models) Real-time Multimodal Server events

Server events

Updated at:
Copy as MD
Product
My Favorites

Server events for the Qwen-Omni-Realtime API, including tool calling (function calling) events.

See Qwen-Omni-Realtime.

error

Server error.

event_id string

A unique identifier for this event.

 
{
  "event_id": "event_RoUu4T8yExPMI37GKwaOC",
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_value",
    "message": "Invalid modalities: ['audio']. Supported combinations are: ['text'] and ['audio', 'text'].",
    "param": "session.modalities"
  }
}

type string

The event type. This value is always error.

error object

Error details.

Properties

type string

The error type.

code string

The error code.

message string

The error message.

param string

The parameter associated with the error, such as session.modalities.

session.created

Returned when a client connects. Contains the default session configuration.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_RdvlSpbBb2ssyBjYrDHjt",
    "type": "session.created",
    "session": {
        "object": "realtime.session",
        "model": "qwen3-omni-flash-realtime",
        "modalities": [
            "text",
            "audio"
        ],
        "voice": "Cherry",
        "input_audio_format": "pcm",
        "output_audio_format": "pcm",
        "input_audio_transcription": {
            "model": "qwen3-asr-flash-realtime"
        },
        "turn_detection": {
            // The value can be server_vad or semantic_vad (only supported by qwen3.5-omni-realtime series model).
            "type": "server_vad",
            "threshold": 0.5,
            "prefix_padding_ms": 300,
            "silence_duration_ms": 800,
            "create_response": true,
            "interrupt_response": true
        },
        "enable_search": false,
        "search_options": {},
        "tools": [],
        "temperature": 0.8,
        "id": "sess_Ov7GOXoNXhNjlxXtOGKQS"
    }
}

type string

The event type. This value is always session.created.

session object

The session configuration.

Properties

object string

This value is always realtime.session.

model string

The model used.

modalities array

The output modalities for the model.

voice string

The voice for model-generated audio.

input_audio_format string

Input audio format. Only pcm is supported (16 kHz sample rate).

output_audio_format string

Output audio format. Only pcm is supported (24 kHz sample rate).

input_audio_transcription object

The transcription configuration.

Properties

model string

Transcription model. Always qwen3-asr-flash-realtime. Not configurable.

turn_detection object

The voice activity detection (VAD) configuration.

Properties

type string

The VAD type. Valid values are server_vad (default) or semantic_vad. See Client events.

threshold float

The VAD detection threshold.

silence_duration_ms integer

Silence duration (ms) that triggers end-of-speech detection.

idle_timeout_ms integer

The idle timeout in milliseconds. Returned only in server_vad mode with qwen3.5-omni-plus-realtime or qwen3.5-omni-flash-realtime models.

enable_search boolean

Whether to enable web search. Supported only by Qwen3.5-Omni-Realtime series model.

search_options object

The options for the web search.

temperature float

The temperature parameter for the model.

session.updated

Returned after a successful session.update request. On failure, an error event is returned instead.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_X1HsXS4b4uptp6yo1LgKd",
    "type": "session.updated",
    "session": {
        "id": "sess_Aih6vAcY5Ddt6jwFx1tCa",
        "object": "realtime.session",
        "model": "qwen3-omni-flash-realtime",
        "modalities": [
            "text",
            "audio"
        ],
        "instructions": "You are Xiao Yun, a personal assistant. Answer user questions accurately and in a friendly manner. Always respond with a helpful attitude.",
        "voice": "Cherry",
        "input_audio_format": "pcm",
        "output_audio_format": "pcm",
        "input_audio_transcription": {
            "model": "qwen3-asr-flash-realtime"
        },
        "turn_detection": {
            // The value can be server_vad or semantic_vad (only supported by qwen3.5-omni-realtime series model).
            "type": "server_vad",
            "threshold": 0.1,
            "prefix_padding_ms": 500,
            "silence_duration_ms": 900,
            "create_response": true,
            "interrupt_response": true
        },
        "enable_search": true,
        "search_options": {
            "enable_source": true
        },
        "tools": [
            {
                "type": "function",
                "function": {
                    "name": "get_current_weather",
                    "description": "Useful for querying the weather in a specific city.",
                    "parameters": {
                        "type": "object",
                        "properties": {
                            "location": {"type": "string", "description": "The city name"}
                        },
                        "required": ["location"]
                    }
                }
            }
        ],
        "temperature": 0.8,
        "max_response_output_token": "inf",
        "max_tokens": 16384,
        "repetition_penalty": 1.05,
        "presence_penalty": 0.0,
        "top_k": 50,
        "top_p": 1.0,
        "seed":-1
    }
}

type string

The event type. This value is always session.updated.

session object

The session configuration.

Properties

temperature float

The temperature parameter for the model.

modalities array

The output modalities for the model.

voice string

The voice for model-generated audio.

instructions string

The model's goal and role.

input_audio_format string

Input audio format. Only pcm is supported (16 kHz sample rate).

output_audio_format string

Output audio format. Only pcm is supported (24 kHz sample rate).

input_audio_transcription object

The transcription configuration.

Properties

model string

Transcription model. Always qwen3-asr-flash-realtime. Not configurable.

turn_detection object

The voice activity detection (VAD) configuration.

Properties

type string

The VAD type. Valid values are server_vad (default) or semantic_vad. See Client events.

threshold float

The VAD detection threshold.

silence_duration_ms integer

Silence duration (ms) that triggers end-of-speech detection.

idle_timeout_ms integer

The idle timeout in milliseconds. Returned only in server_vad mode with qwen3.5-omni-plus-realtime or qwen3.5-omni-flash-realtime models.

enable_search boolean (optional)

Whether to enable web search. Supported only by Qwen3.5-Omni-Realtime series model.

search_options object (optional)

The web search options.

tools array (optional)

Tool definitions. When configured, the model can decide whether to call a tool based on user input.

Properties

type string (required)

This value is always function.

function.name string (required)

The function name, such as get_current_weather or get_current_time.

function.description string (optional)

Description of the function's purpose. The model uses this to decide whether to call the function.

function.parameters object (optional)

Input parameter schema. The model uses this to extract parameters. Omit if the function takes no parameters.

Properties

type string (required)

This value is always object.

properties object (optional)

Each key is a parameter name mapped to an object with type and description.

required array (optional)

Specifies which input parameters are required.

top_p float

The probability threshold for nucleus sampling.

top_k integer

Candidate set size for sampling during generation.

max_tokens integer

Maximum tokens the model can return for this request.

repetition_penalty float

Controls repetition in consecutive sequences during generation.

presence_penalty float

Controls repetition in generated content.

seed integer

The degree of consistency in the model's output per request.

input_audio_buffer.speech_started

In VAD mode, returned when the server detects speech onset in the audio buffer.

May be triggered each time audio is added to the buffer before speech is detected.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_Pvp8nEhsQuGCQbFJ9x58n",
    "type": "input_audio_buffer.speech_started",
    "audio_start_ms": 3647,
    "item_id": "item_YbAiGvK2H7YaS34o4R6Ba"
}

type string

The event type. This value is always input_audio_buffer.speech_started.

audio_start_ms integer

Time (ms) from when audio buffer writing starts until speech is first detected.

item_id string

ID of the user message item created when end-of-speech is detected.

User message items append user input to the conversation history for model inference.

input_audio_buffer.speech_stopped

In VAD mode, returned when the server detects end-of-speech in the audio buffer.

Also returns a conversation.item.created event with the corresponding user message item.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_UhQiqNVRsgUiq4KUS5Xb5",
    "type": "input_audio_buffer.speech_stopped",
    "audio_end_ms": 4453,
    "item_id": "item_YbAiGvK2H7YaS34o4R6Ba"
}

type string

The event type. This value is always input_audio_buffer.speech_stopped.

audio_end_ms integer

Time (ms) from session start until end-of-speech is detected.

item_id string

The ID of the user message item that will be created.

input_audio_buffer.committed

Returned when the input audio buffer is committed.

  • In VAD mode, the server automatically commits the buffer when it detects end-of-speech.

  • In Manual mode, returned after the client sends an input_audio_buffer.commit event.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_Iy6sUzL1nmdFgshFYxJEz",
    "type": "input_audio_buffer.committed",
    "item_id": "item_YbAiGvK2H7YaS34o4R6Ba"
}

type string

The event type. This value is always input_audio_buffer.committed.

item_id string

The ID of the user message item that will be created.

input_audio_buffer.cleared

Returned after the client sends an input_audio_buffer.clear event.

event_id string

A unique identifier for this event.

 
{
  "event_id": "event_RoUu4T8yExPMI37GKwaOC",
  "type": "input_audio_buffer.cleared"
}

type string

The event type. This value is always input_audio_buffer.cleared.

conversation.item.created

Returned when a conversation item is created.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_JEfkrr9gO3Ny7Xcv9bGVd",
    "type": "conversation.item.created",
    "item": {
        "id": "item_YbAiGvK2H7YaS34o4R6Ba",
        "object": "realtime.item",
        "type": "message",
        "status": "in_progress",
        "role": "assistant",
        "content": [
            {
                "type": "input_audio"
            }
        ]
    }
}
// Tool calling scenario
{
    "event_id": "event_S1hkaIQgcuQD8OEdOpGHQ",
    "type": "conversation.item.created",
    "item": {
        "id": "item_FEG9qJGNkPcdf4et3p7BV",
        "object": "realtime.item",
        "type": "function_call",
        "status": "in_progress",
        "call_id": "call_bc0a7fb7235840f69ecfe4",
        "name": "get_current_weather",
        "arguments": ""
    }
}

type string

The event type. This value is always conversation.item.created.

item object

The conversation item to add.

Properties

id string

The unique ID of the conversation item.

object string

This value is always realtime.item.

status string

The status of the conversation item.

role string

The role of the message.

content array

The content of the message. This parameter is returned when the type is message.

type string

The type of the conversation item. Valid values are message or function_call.

name string

The name of the function that is called when the type is function_call.

call_id string

When the type is function_call, this is the unique ID of the function invocation.

arguments string

When the type is function_call, this parameter contains the arguments for the function invocation as a JSON string.

conversation.item.input_audio_transcription.delta

Sent frequently while the user is speaking when input audio transcription is enabled. Provides real-time intermediate transcription results. Concatenate text + stash for the most complete sentence preview at any point.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_C7jzoeSFuiwOZS6tR14yx",
    "type": "conversation.item.input_audio_transcription.delta",
    "item_id": "item_ThVYhLHOdeXb4bBSvzSFF",
    "content_index": 0,
    "text": "",
    "stash": "How is the weather today?",
    "language": "en",
    "emotion": "neutral",
    "obfuscation": "ABEXGYmxdmc97u"
}

To get the most complete sentence preview at any moment, concatenate these two fields: real-time preview = text + stash.

Click to view example

Suppose the user is saying: "The weather is nice today, sunny and warm."

The following shows the event stream you might receive and how to interpret them:

Time

User speech progress

API response (text and stash)

Client UI display (text + stash)

T1

"The weather..."

text: ""

stash: "The weather"

The weather

T2

"...is nice..."

text: ""

stash: "The weather is nice"

The weather is nice

T3

"...today,"

text: "The weather"

stash: " is nice today,"

The weather is nice today,

("The weather" has been confirmed and moved to text)

T4

(brief pause)

text: "The weather is nice today, "

stash: ""

The weather is nice today,

(first clause fully confirmed)

T5

"sunny..."

text: "The weather is nice today, "

stash: "sunny"

The weather is nice today, sunny

T6

"...and warm."

text: "The weather is nice today, "

stash: "sunny and warm."

The weather is nice today, sunny and warm.

T7

(stops speaking)

-

Use the transcript from conversation.item.input_audio_transcription.completed as the final result.

type string

The event type. This value is always conversation.item.input_audio_transcription.delta.

item_id string

The ID of the associated conversation item.

content_index integer

The index of the content part that contains the audio.

text string

Confirmed text prefix — the portion the model has finalized and will not change.

stash string

Preliminary text suffix — a temporary draft following the confirmed portion, subject to revision.

language string

The detected language of the recognized audio.

emotion string

The detected emotion of the recognized audio. Valid values: neutral, happy, sad, angry, surprised, disgusted, fearful.

conversation.item.input_audio_transcription.completed

Indicates that the user's audio has been transcribed by the built-in speech recognition model (qwen3-asr-flash-realtime). Not configurable.

The transcribed text from the speech recognition model may differ from the interpretation generated by the Qwen-Omni-Realtime model. The transcription is for reference only.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_FrrZcxiDfTB9LD9p4pVng",
    "type": "conversation.item.input_audio_transcription.completed",
    "item_id": "item_YbAiGvK2H7YaS34o4R6Ba",
    "content_index": 0,
    "transcript": "Hello."
}

type string

The event type. This value is always conversation.item.input_audio_transcription.completed.

item_id string

The ID of the user message item.

content_index integer

This value is always 0.

transcript string

The transcribed text.

conversation.item.input_audio_transcription.failed

Returned when input audio transcription is enabled and the transcription fails. Independent of the error event; helps clients identify transcription failures specifically.

event_id string

A unique identifier for this event.

 
{
  "type": "conversation.item.input_audio_transcription.failed",
  "item_id": "<item_id>",
  "content_index": 0,
  "error": {
    "code": "<code>",
    "message": "<message>",
    "param": "<param>"
  }
}

type string

The event type. This value is always conversation.item.input_audio_transcription.failed.

item_id string

The ID of the user message item.

content_index integer

This value is always 0.

error object

The error information.

Properties

code string

The error code.

message string

The error message.

param string

The parameter related to the error.

response.created

Returned when the server starts generating a new response.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_XuDavMzQN3KKepqGu3KRh",
    "type": "response.created",
    "response": {
        "id": "resp_HaVOPdbmX6vifiV5pAfJY",
        "object": "realtime.response",
        "conversation_id": "conv_FjJaccpnvwHNo9cPVuzGc",
        "status": "in_progress",
        "modalities": [
            "text",
            "audio"
        ],
        "voice": "Cherry",
        "output_audio_format": "pcm",
        "output": []
    }
}

type string

The event type. This value is always response.created.

response object

The response object.

Properties

id string

The unique ID of the response.

conversation_id string

The unique ID of the current session.

object string

The object type. For this event, this value is always realtime.response.

status string

The response status. Valid values are completed, failed, in_progress, or incomplete.

modalities array

The response modalities.

voice string

The voice for model-generated audio.

output array

This field is empty for this event.

response.done

Returned after the response is fully generated. The response object includes all output items except raw audio data.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_CSaxRRYLvbrfexDXAEuDG",
    "type": "response.done",
    "response": {
        "id": "resp_HaVOPdbmX6vifiV5pAfJY",
        "object": "realtime.response",
        "conversation_id": "conv_FjJaccpnvwHNo9cPVuzGc",
        "status": "completed",
        "modalities": [
            "text",
            "audio"
        ],
        "voice": "Cherry",
        "output_audio_format": "pcm",
        "output": [
            {
                "id": "item_Ls6MtCUWO7LM4E59QziNv",
                "object": "realtime.item",
                "type": "message",
                "status": "completed",
                "role": "assistant",
                "content": [
                    {
                        "type": "audio",
                        "transcript": "Hello! How can I help you?"
                    }
                ]
            }
        ],
        "usage": {
            "total_tokens": 377,
            "input_tokens": 336,
            "output_tokens": 41,
            "input_tokens_details": {
                "text_tokens": 228,
                "audio_tokens": 108
            },
            "output_tokens_details": {
                "text_tokens": 9,
                "audio_tokens": 32
            },
            "plugins": {
                "search": {
                    "count": 1,
                    "strategy": "agent"
                }
            }
        }
    }
}
// Tool calling scenario
{
    "event_id": "event_T1EFAJp43X2DWtDRmxTtx",
    "type": "response.done",
    "response": {
        "id": "resp_TucN5QgymL5MA8vkJvFlS",
        "object": "realtime.response",
        "conversation_id": "conv_SEDZESRlefT8WvLSmEn6E",
        "status": "completed",
        "modalities": ["text", "audio"],
        "voice": "Ethan",
        "output_audio_format": "pcm",
        "output": [
            {
                "id": "item_FEG9qJGNkPcdf4et3p7BV",
                "object": "realtime.item",
                "type": "function_call",
                "status": "completed",
                "call_id": "call_bc0a7fb7235840f69ecfe4",
                "name": "get_current_weather",
                "arguments": " {\"location\": \"Hangzhou\"}"
            }
        ],
        "usage": {
            "total_tokens": 567,
            "input_tokens": 524,
            "output_tokens": 43,
            "input_tokens_details": {
                "text_tokens": 487,
                "audio_tokens": 37
            },
            "output_tokens_details": {
                "text_tokens": 43
            }
        }
    }
}

type string

The event type. This value is always response.done.

response object

The response object.

Properties

id string

The unique ID of the response.

conversation_id string

The unique ID of the current session.

object string

The object type. For this event, this value is always realtime.response.

status string

The response status.

modalities array

The response modalities.

voice string

The voice for model-generated audio.

output object

The response output.

Properties

id string

The ID of the response output.

type string

The type of the output item. Valid values are message or function_call.

object string

The output item object type. This value is always realtime.item.

status string

The output item status.

role string

The output item role.

content array

The content of the output item. This field is returned only when the type is message.

Properties

type string

The content type. The value can be text for plain text output or audio for audio output.

text string

The text output.

transcript string

The text transcript of the audio.

name string

The name of the function that is invoked when the type is function_call.

call_id string

When the type is function_call, this is the unique ID of the function invocation.

arguments string

When the type is function_call, this field contains the full arguments for the function call as a JSON string.

usage object

Token usage details for this response.

Properties

total_tokens integer

Total tokens used in this response.

input_tokens integer

Number of input tokens.

output_tokens integer

Number of output tokens.

input_tokens_details object

Details about input token usage, including text_tokens and audio_tokens.

output_tokens_details object

Details about output token usage, including text_tokens and audio_tokens.

plugins object (optional)

Plugin usage metrics. Returned when web search (enable_search) is enabled.

Properties

search object

Search metering data.

Properties

count integer

The number of searches.

strategy string

The search strategy.

response.text.delta

Returned when the output modality is text-only and the model generates new text incrementally.

event_id string

A unique identifier for this event.

 
{
    "delta": "Hello",
    "event_id": "event_TH49MauuPmRo1RGaMSlP7",
    "type": "response.text.delta",
    "response_id": "resp_PrRSvPVpnCExdUOGHHLuP",
    "item_id": "item_L8IRm9kRXFpxoOjDqDC96",
    "output_index": 0,
    "content_index": 0
}

type string

The event type. This value is always response.text.delta.

delta string

Incremental text generated by the model.

response_id string

The response ID.

item_id string

The message item ID.

output_index integer

The index of the output item in the response. This value is always 0.

content_index integer

The index of the internal part within the output item. This value is always 0.

response.text.done

Returned when the output modality is text-only and the model finishes generating text.

Also returned if the response is interrupted, incomplete, or canceled.

event_id string

A unique identifier for this event.

 
{
  "event_id": "event_B1lIeE2Nac33zn5V7h2mm",
  "type": "response.text.done",
  "response_id": "resp_B1lIdtjF4Noqpn5NOjznj",
  "item_id": "item_B1lIdJsAJlJiFs8ztWpJt",
  "output_index": 0,
  "content_index": 0,
  "text": "How can I assist you today?"
}

type string

The event type. This value is always response.text.done.

response_id string

The response ID.

item_id string

The message item ID.

output_index integer

The index of the output item in the response.

content_index integer

The index of the output item in the response.

text string

The full text generated by the model.

response.audio.delta

Returned when the output modality includes audio and the model generates new audio data incrementally.

event_id string

A unique identifier for this event.

 
{
  "event_id": "event_B1osWMZBtrEQbiIwW0qHQ",
  "type": "response.audio.delta",
  "response_id": "resp_P79OOMs8LnrXVpiIHUCKR",
  "item_id": "item_OFaPGtzfWCPyGzxnuEX9i",
  "output_index": 0,
  "content_index": 0,
  "delta": "{base64 audio}"
}

type string

The event type. This value is always response.audio.delta.

response_id string

The response ID.

item_id string

The message item ID.

output_index integer

The index of the output item in the response.

content_index integer

The index of the output item in the response.

delta string

Incremental audio data, Base64-encoded.

response.audio.done

Returned when the output modality includes audio and the model finishes generating audio data.

Also returned if the response is interrupted, incomplete, or canceled.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_Le1TDl7VfyHQxl47DtGxI",
    "type": "response.audio.done",
    "response_id": "resp_HaVOPdbmX6vifiV5pAfJY",
    "item_id": "item_Ls6MtCUWO7LM4E59QziNv",
    "output_index": 0,
    "content_index": 0
}

type string

The event type. This value is always response.audio.done.

response_id string

The response ID.

item_id string

The message item ID.

output_index integer

The index of the output item in the response.

content_index integer

The index of the output item in the response.

response.audio_transcript.delta

Returned when the output modality includes audio and the model generates new response.audio_transcript.delta transcript text incrementally.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_BksW7fOwnyavZdDxIzZYM",
    "type": "response.audio_transcript.delta",
    "response_id": "resp_HaVOPdbmX6vifiV5pAfJY",
    "item_id": "item_Ls6MtCUWO7LM4E59QziNv",
    "output_index": 0,
    "content_index": 0,
    "delta": "What"
}

type string

The event type. This value is always response.audio_transcript.delta.

response_id string

The response ID.

item_id string

The message item ID.

output_index integer

The index of the output item in the response.

content_index integer

The index of the output item in the response.

delta string

The incremental text.

response.audio_transcript.done

Returned as a response.audio_transcript.done event when the output modality includes audio and the model completes the audio transcript.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_X49tL2WerT4WjxcmH16lS",
    "type": "response.audio_transcript.done",
    "response_id": "resp_HaVOPdbmX6vifiV5pAfJY",
    "item_id": "item_Ls6MtCUWO7LM4E59QziNv",
    "output_index": 0,
    "content_index": 0,
    "transcript": "Hello! How can I help you?"
}

type string

The event type. This value is always response.audio_transcript.done.

response_id string

The response ID.

item_id string

The message item ID.

output_index integer

The index of the output item in the response.

content_index integer

The index of the output item in the response.

transcript string

The full transcription text.

response.function_call_arguments.delta

Returned as the model streams function call arguments. Concatenate the delta fields in order to build the argument string. The complete content is provided in the subsequent response.function_call_arguments.done event.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_SlKoJyEbPEqLq14DSM1u5",
    "type": "response.function_call_arguments.delta",
    "response_id": "resp_JnTOsWXlFhKcFohZbtfz6",
    "item_id": "item_Rhcms7CauTNsQprV5S4Hr",
    "output_index": 0,
    "call_id": "call_2be200f4cafe419b9530dd",
    "delta": " {\"location\": \"Beijing\"}"
}

type string

The event type. This value is always response.function_call_arguments.delta.

response_id string

The response ID.

item_id string

The message item ID.

output_index integer

The index of the output item in the response.

call_id string

The unique ID for this function invocation. This is consistent with the done event in the same turn.

delta string

New segment of the argument string. Concatenate segments in order.

response.function_call_arguments.done

Indicates that function call arguments are fully generated. The arguments field contains the complete argument string. Use the arguments from this event — not the concatenated delta results — to parse and call the local function.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_X6suLyuL5agdH7r6koesM",
    "type": "response.function_call_arguments.done",
    "response_id": "resp_JnTOsWXlFhKcFohZbtfz6",
    "item_id": "item_Rhcms7CauTNsQprV5S4Hr",
    "output_index": 0,
    "name": "get_current_weather",
    "call_id": "call_2be200f4cafe419b9530dd",
    "arguments": " {\"location\": \"Beijing\"}"
}

type string

The event type. This value is always response.function_call_arguments.done.

response_id string

The response ID.

item_id string

The message item ID.

output_index integer

The index of the output item in the response.

call_id string

The unique ID for this function invocation.

name string

The name of the function that was called.

arguments string

Complete function call arguments as a JSON string.

response.output_item.added

Returned when a new item is created during response generation. The item type can be message or function_call.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_DsCO341DEVtiATtCB6BUY",
    "type": "response.output_item.added",
    "response_id": "resp_HaVOPdbmX6vifiV5pAfJY",
    "output_index": 0,
    "item": {
        "id": "item_Ls6MtCUWO7LM4E59QziNv",
        "object": "realtime.item",
        "type": "message",
        "status": "in_progress",
        "role": "assistant",
        "content": []
    }
}
// Tool calling scenario
{
    "event_id": "event_HXmKt5pGoiRtXx7Hq7zpN",
    "type": "response.output_item.added",
    "response_id": "resp_TucN5QgymL5MA8vkJvFlS",
    "output_index": 0,
    "item": {
        "id": "item_FEG9qJGNkPcdf4et3p7BV",
        "object": "realtime.item",
        "type": "function_call",
        "status": "in_progress",
        "call_id": "call_bc0a7fb7235840f69ecfe4",
        "name": "get_current_weather",
        "arguments": ""
    }
}

type string

The event type. This value is always response.output_item.added.

response_id string

The response ID.

output_index integer

The index of the output item in the response.

item object

Information about the output item.

Properties

id string

The unique ID of the output item.

object string

This value is always realtime.item.

status string

The status of the output item.

role string

The role of the sender.

content array

The content of the message. This field is returned when the type is message.

type string

The type of the output item. Valid values are message or function_call.

name string

The name of the function to call when the type is function_call.

call_id string

The unique ID of the current function invocation when the type is function_call.

arguments string

Function call arguments as a JSON string when the type is function_call. Initially an empty string in added events.

response.output_item.done

Returned when an output item is fully generated.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_MEu5nlLw1LsOguHiehIP8",
    "type": "response.output_item.done",
    "response_id": "resp_HaVOPdbmX6vifiV5pAfJY",
    "output_index": 0,
    "item": {
        "id": "item_Ls6MtCUWO7LM4E59QziNv",
        "object": "realtime.item",
        "type": "message",
        "status": "completed",
        "role": "assistant",
        "content": [
            {
                "type": "audio",
                "text": "Hello! How can I help you?"
            }
        ]
    }
}
// Tool calling scenario
{
    "event_id": "event_FHspdfAnCyjuME3mmAwSY",
    "type": "response.output_item.done",
    "response_id": "resp_TucN5QgymL5MA8vkJvFlS",
    "output_index": 0,
    "item": {
        "id": "item_FEG9qJGNkPcdf4et3p7BV",
        "object": "realtime.item",
        "type": "function_call",
        "status": "completed",
        "call_id": "call_bc0a7fb7235840f69ecfe4",
        "name": "get_current_weather",
        "arguments": " {\"location\": \"Hangzhou\"}"
    }
}

type string

The event type. This value is always response.output_item.done.

response_id string

The response ID.

output_index integer

The index of the output item in the response.

item object

The output item information.

Properties

id string

The unique ID of the output item.

object string

This value is always realtime.item.

status string

The status of the output item.

role string

The role of the sender.

content array

The content of the message. This field is returned when the type is message.

type string

The type of the output item. Valid values are message or function_call.

name string

The name of the function that is called when the type is function_call.

call_id string

When the type is function_call, this is the unique ID for the function invocation.

arguments string

When the type is function_call, contains the full function call arguments as a JSON string.

response.content_part.added

Returned when a new content part is added to an assistant message item during response generation.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_AVBOmrgY3C8bjlRajfSUT",
    "type": "response.content_part.added",
    "response_id": "resp_HaVOPdbmX6vifiV5pAfJY",
    "item_id": "item_Ls6MtCUWO7LM4E59QziNv",
    "output_index": 0,
    "content_index": 0,
    "part": {
        "type": "audio",
        "text": ""
    }
}

type string

The event type. This value is always response.content_part.added.

response_id string

The response ID.

item_id string

The message item ID.

output_index integer

The index of the output item in the response. This value is always 0.

content_index integer

The index of the internal part within the output item. This value is always 0.

part object

The output item information.

Properties

type string

The type of the content part.

text string

The text of the content part.

response.content_part.done

Returned when streaming of a content part within an assistant message item finishes.

event_id string

A unique identifier for this event.

 
{
    "event_id": "event_Il8HD19v58Qr5IBkw7LtN",
    "type": "response.content_part.done",
    "response_id": "resp_HaVOPdbmX6vifiV5pAfJY",
    "item_id": "item_Ls6MtCUWO7LM4E59QziNv",
    "output_index": 0,
    "content_index": 0,
    "part": {
        "type": "audio",
        "text": "Hello! How can I help you?"
    }
}

type string

The event type. This value is always response.content_part.done.

response_id string

The response ID.

item_id string

The message item ID.

output_index integer

The index of the output item in the response. This value is always 0.

content_index integer

The index of the content part in the content array. This value is always 0.

part object

The output item information.

Properties

type string

The type of the content part.

text string

The text of the content part.
Previous：Client eventsNext：Python SDK