Realtime
  1. Server events
Realtime
  • Realtime Websocket
    • Client events
      • session.update
      • input_audio_buffer.append
      • input_audio_buffer.commit
      • input_audio_buffer.clear
      • conversation.item.create
      • conversation.item.truncate
      • conversation.item.delete
      • response.create
      • response.cancel
    • Server events
      • error
      • conversation.item.input_audio_transcription.completed
      • conversation.item.input_audio_transcription.failed
      • conversation.item.truncated
      • conversation.item.deleted
      • input_audio_buffer.committed
      • input_audio_buffer.cleared
      • input_audio_buffer.speech_started
      • input_audio_buffer.speech_stopped
      • response.created
      • response.done
      • response.output_item.added
      • response.output_item.done
      • response.content_part.added
      • response.content_part.done
      • response.text.delta
      • response.text.done
      • response.audio_transcript.delta
      • response.audio_transcript.done
      • response.audio.delta
      • response.audio.done
      • response.function_call_arguments.delta
      • response.function_call_arguments.done
      • rate_limits.updated
      • conversation.created
      • conversation.item.created
      • session.created
      • session.updated
  1. Server events

error

开发中
wss://api.openai.com/v1/realtime
Returned when an error occurs.

请求参数

Query 参数
event_id
array[string]
可选
The unique ID of the server event.
示例值:
["event_890"]
type
string 
可选
The event type, must be "error".
示例值:
error
error
string 
可选
object,以下参数皆为object下参数，Details of the error.
type1
string 
可选
type1为type，The type of error (e.g., "invalid_request_error", "server_error").
示例值:
invalid_request_error
code
string 
可选
Error code, if any.
示例值:
invalid_event
message
string 
可选
A human-readable error message.
示例值:
The 'type' field is missing.
param
string 
可选
Parameter related to the error, if any.
示例值:
null
event_id1
string 
可选
event_id1为event_id
示例值:
event_567
Header 参数
Authorization
string 
可选
示例值:
Bearer YOUR_API_KEY
OpenAI-Beta
string 
可选
示例值:
realtime=v1
上一页
response.cancel
下一页
conversation.item.input_audio_transcription.completed
Built with