AsyncAPI channel · Inworld AI
· Inworld AI Runtime WebSocket APIs
/api/v1/realtime/session
Bidirectional WebSocket endpoint for Inworld Realtime sessions. The
protocol is intentionally compatible with the OpenAI Realtime API event
protocol; existing OpenAI Realtime clients can connect by changing the
base URL and authentication header. Inworld extends the session object
with a `providerData` field for STT, TTS, memory, backchannel, and
responsiveness extensions (see https://docs.inworld
Provider:Inworld AIAsyncAPI: v2.6.0Spec: Inworld AI Runtime WebSocket APIsOperations: 2Messages: 14
Channel address
/api/v1/realtime/session
Parameters
key — Client-supplied session key (the JS quickstart uses `voice-${Date.now()}`).
protocol — Protocol identifier; documented value is `realtime`.
Operations
publish
realtimeClientEvent
Events sent from client to the Realtime session.
subscribe
realtimeServerEvent
Events streamed from the Realtime session back to the client.
Messages
session.update
session.update (client)
Content-Type:
conversation.item.create
conversation.item.create (client)
Content-Type:
conversation.item.truncate
conversation.item.truncate (client)
Content-Type:
conversation.item.delete
conversation.item.delete (client)
Content-Type:
conversation.item.retrieve
conversation.item.retrieve (client)
Content-Type:
response.create
response.create (client)
Content-Type:
response.cancel
response.cancel (client)
Content-Type:
input_audio_buffer.append
input_audio_buffer.append (client)
Content-Type:
input_audio_buffer.commit
input_audio_buffer.commit (client)
Content-Type:
input_audio_buffer.clear
input_audio_buffer.clear (client)
Content-Type:
output_audio_buffer.clear
output_audio_buffer.clear (client)
Content-Type:
session.created
session.created (server)
Content-Type:
session.updated
session.updated (server)
Content-Type:
realtime.server_event
Inworld documents additional server events that follow the OpenAI
Realtime API protocol — including (non-exhaustive) `response.start`,
`response.content_part.added`, `response.content_part.delta`,
`re
Content-Type:
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.