Establish a WebSocket connection for real-time PII/PHI redaction. The service
transcribes audio in real-time, detects PII/PHI in the text, redacts the
transcript, and returns redacted audio clips as binary MP3 frames.
## Connection Flow
1. Connect with `api_key` and optional query parameters
2. Connection will be accepted if authentication succeeds and limits are not exceeded
3. Stream audio data
Receive redacted transcription results and audio clips from the server
Messages
audioChunk
Audio data chunk for real-time redaction
Content-Type: application/octet-stream
endOfStream
Empty text frame signaling end of audio stream
Content-Type: text/plain
utteranceResult
A completed utterance with redacted text. When `redacted_audio` is not null,
the next frame from the server is a binary MP3 frame containing the redacted
audio clip. When `redacted_audio` is null (out
Content-Type: application/json
redactedAudioClip
Binary MP3 data for the redacted audio window. Sent immediately after an
utterance JSON frame that has a non-null `redacted_audio` field.
Content-Type: audio/mpeg
errorResult
An error occurred during redaction. No binary frame follows.
Content-Type: application/json
doneResult
Redaction completed successfully. When `trailing_redacted_audio` is not null,
the next frame is a binary MP3 frame containing the remaining audio after the
last utterance. When null, no binary frame f
Content-Type: application/json
trailingAudioClip
Binary MP3 data for the trailing audio after the last utterance. Sent
immediately after a `done` JSON frame that has a non-null
`trailing_redacted_audio` field.
Content-Type: audio/mpeg
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.