OpenAI API

RealtimeServerEventResponseContentPartAdded

object

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

event_idstringrequired

The unique ID of the server event.

typestringrequired

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

Allowed values:response.content_part.added

response_idstringrequired

The ID of the response.

item_idstringrequired

The ID of the item to which the content part was added.

output_indexintegerrequired

The index of the output item in the response.

content_indexintegerrequired

The index of the content part in the item’s content array.

partobjectrequired

The content part that was added.

Show Child Parameters
Example

RealtimeServerEventResponseContentPartDone

object

Returned when a content part is done streaming in an assistant message item.
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.content_part.done.

Allowed values:response.content_part.done

response_idstringrequired

The ID of the response.

item_idstringrequired

The ID of the item.

output_indexintegerrequired

The index of the output item in the response.

content_indexintegerrequired

The index of the content part in the item’s content array.

partobjectrequired

The content part that is done.

Show Child Parameters
Example

RealtimeServerEventResponseCreated

object

Returned when a new Response is created. The first event of response creation,
where the response is in an initial state of in_progress.

event_idstringrequired

The unique ID of the server event.

typestringrequired

The event type, must be response.created.

Allowed values:response.created

responseobjectrequired

The response resource.

Show Child Parameters
Example

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