Send this event to update the session’s default configuration. The client may send this event at any time to update any field, except for voice. However, note that once a session has been initialized with a particular model, it can’t be changed to another model using session.update.

When the server receives a session.update, it will respond with a session.updated event showing the full, effective configuration. Only the fields that are present are updated. To clear a field like instructions, pass an empty string.

interface SessionUpdateEvent {
    event_id?: string;
    session: OpenAIClient.Beta.Realtime.SessionUpdateEvent.Session;
    type: "session.update";
}

Properties

event_id?: string

Optional client-generated ID used to identify this event.

Realtime session object configuration.

type: "session.update"

The event type, must be session.update.