AsyncAPI channel · Suki AI
· Suki Speech Service Streaming API
/api/v1/ambient/sessions/{sessionId}/audio
Ambient session audio channel. Streams microphone audio from the provider-patient encounter into Suki for ambient clinical note generation. Returned by `POST /ambient/sessions` as `audioWebsocketUrl`. Clients first publish a START_TIME control frame, then publish AUDIO frames with Base64-encoded PCM in the `data` field, and finally publish an AUDIO frame whose `data` is `"RU9G"` (Base64 "EOF") to
Provider:Suki AIAsyncAPI: v2.6.0Spec: Suki Speech Service Streaming APIOperations: 2Messages: 3
Channel address
/api/v1/ambient/sessions/{sessionId}/audio
Parameters
sessionId — Ambient session UUID returned by the REST create call.
Operations
publish
publishAmbientAudio
Stream encounter audio and control frames to Suki.
subscribe
receiveAmbientStatus
Receive server-side acknowledgements and stream status events.
Messages
AmbientStartTime
First frame sent on an ambient or form-filling session.
Content-Type: application/json
AmbientAudioFrame
Base64-encoded PCM audio chunk. To terminate the stream, send a frame whose `data` is `RU9G` (Base64 for the ASCII bytes "EOF").
Content-Type: application/json
StreamStatusEvent
Server-emitted status updates (e.g. acknowledgements, errors, stream lifecycle). Final clinical content for ambient and form-filling sessions is fetched via REST or delivered via partner-hosted webhoo
Content-Type: application/json
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.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.