v1

latestOpenAPI 3.0.12026-07-2649123153.6 KB

/ws

Stream ambient audio

Opens a WebSocket to stream audio for ambient or form-filling sessions. Create the session and seed context before connecting. Browser clients authenticate with Sec-WebSocket-Protocol; non-browser clients send sdp_suki_token, optional sdp_provider_id, and ambient_session_id as headers.

get/ws/stream

Headers

Sec-WebSocket-Protocolstring

Required FOR BROWSER CLIENTS ONLY. Sent during WebSocket handshake. Browsers must use the same subprotocol the grpc-wsproxy maps to Authorization: 'SukiAmbientAuth,<sdp_suki_token>,<ambient_session_id>' (comma-separated; token second, ambient session id third). Other subprotocol names are not mapped and typically yield 401.

ambient_session_idstring required

Required for non-browser clients only. Session UUID from Create Ambient Session or Create Form filling Session.

sdp_provider_idstring

Example:provider-123

Optional for standard partners.

Required for:

Bearer authentication. Use the same provider_id returned by the Login or Register API.
Single Auth Token authentication. Include the same provider_id on every request as sdp_provider_id.

Response

OK - May indicate successful stream processing or completion (e.g., sending 'EOF' message). Specific meaning depends on implementation after handshake.

string required