Schema

Schema name: RealtimeServerEventOutputAudioBufferCleared

{
  "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 33": {
    "kind": "HttpDeclTypeAlias",
    "oasRef": "#/components/schemas/RealtimeServerEvent/anyOf/33",
    "docstring": "**WebRTC/SIP Only:** Emitted when the output audio buffer is cleared. This happens either in VAD\nmode when the user has interrupted (`input_audio_buffer.speech_started`),\nor when the client has emitted the `output_audio_buffer.clear` event to manually\ncut off the current audio response.\n[Learn more](/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n",
    "ident": "OutputAudioBufferCleared",
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "event_id"
        },
        {
          "ident": "response_id"
        },
        {
          "ident": "type"
        }
      ]
    },
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 33 > (property) event_id",
      "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 33 > (property) response_id",
      "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 33 > (property) type"
    ]
  },
  "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 33 > (property) event_id": {
    "kind": "HttpDeclProperty",
    "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferCleared/properties/event_id",
    "deprecated": false,
    "key": "event_id",
    "docstring": "The unique ID of the server event.",
    "type": {
      "kind": "HttpTypeString"
    },
    "optional": false,
    "nullable": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 33 > (property) response_id": {
    "kind": "HttpDeclProperty",
    "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferCleared/properties/response_id",
    "deprecated": false,
    "key": "response_id",
    "docstring": "The unique ID of the response that produced the audio.",
    "type": {
      "kind": "HttpTypeString"
    },
    "optional": false,
    "nullable": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 33 > (property) type": {
    "kind": "HttpDeclProperty",
    "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferCleared/properties/type",
    "deprecated": false,
    "key": "type",
    "docstring": "The event type, must be `output_audio_buffer.cleared`.",
    "type": {
      "kind": "HttpTypeUnion",
      "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferCleared/properties/type",
      "types": [
        {
          "kind": "HttpTypeLiteral",
          "literal": "output_audio_buffer.cleared"
        }
      ]
    },
    "optional": false,
    "nullable": false,
    "schemaType": "enum",
    "childrenParentSchema": "enum",
    "children": [
      "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 33 > (property) type > (member) 0"
    ]
  },
  "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 33 > (property) type > (member) 0": {
    "kind": "HttpDeclReference",
    "type": {
      "kind": "HttpTypeLiteral",
      "literal": "output_audio_buffer.cleared"
    }
  }
}