OpenAI API

RealtimeServerEventResponseDone

object

Returned when a Response is done streaming. Always emitted, no matter the
final state. The Response object included in the response.done event will
include all output Items in the Response but will omit the raw audio data.

event_idstringrequired

The unique ID of the server event.

typestringrequired

The event type, must be response.done.

Allowed values:response.done

responseobjectrequired

The response resource.

Show Child Parameters
Example

RealtimeServerEventResponseFunctionCallArgumentsDelta

object

Returned when the model-generated function call arguments are updated.

event_idstringrequired

The unique ID of the server event.

typestringrequired

The event type, must be response.function_call_arguments.delta.

Allowed values:response.function_call_arguments.delta

response_idstringrequired

The ID of the response.

item_idstringrequired

The ID of the function call item.

output_indexintegerrequired

The index of the output item in the response.

call_idstringrequired

The ID of the function call.

deltastringrequired

The arguments delta as a JSON string.

Example

RealtimeServerEventResponseFunctionCallArgumentsDone

object

Returned when the model-generated function call arguments are done streaming.
Also emitted when a Response is interrupted, incomplete, or cancelled.

event_idstringrequired

The unique ID of the server event.

typestringrequired

The event type, must be response.function_call_arguments.done.

Allowed values:response.function_call_arguments.done

response_idstringrequired

The ID of the response.

item_idstringrequired

The ID of the function call item.

output_indexintegerrequired

The index of the output item in the response.

call_idstringrequired

The ID of the function call.

argumentsstringrequired

The final arguments as a JSON string.

Example

RealtimeServerEventResponseOutputItemAdded

object

Returned when a new Item is created during Response generation.

event_idstringrequired

The unique ID of the server event.

typestringrequired

The event type, must be response.output_item.added.

Allowed values:response.output_item.added

response_idstringrequired

The ID of the Response to which the item belongs.

output_indexintegerrequired

The index of the output item in the Response.

itemobjectrequired

The item to add to the conversation.

Show Child Parameters
Example

RealtimeServerEventResponseOutputItemDone

object

Returned when an Item is done streaming. Also emitted when a Response is
interrupted, incomplete, or cancelled.

event_idstringrequired

The unique ID of the server event.

typestringrequired

The event type, must be response.output_item.done.

Allowed values:response.output_item.done

response_idstringrequired

The ID of the Response to which the item belongs.

output_indexintegerrequired

The index of the output item in the Response.

itemobjectrequired

The item to add to the conversation.

Show Child Parameters
Example