For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Connect
BlogHelp CenterAPI PricingSign up
OverviewElevenCreativeElevenAgentsElevenAPIReception AIAPI referenceChangelog
OverviewElevenCreativeElevenAgentsElevenAPIReception AIAPI referenceChangelog
  • Get started
    • Quickstart
    • Agents Quickstart
    • Choosing the right model
  • Tutorials
    • Text to Speech
    • Speech to Text
    • Speech Engine
    • Music
    • Text to Dialogue
    • Voice Changer
    • Voice Isolator
    • Dubbing
    • Sound effects
    • Forced Alignment
  • Concepts
    • Understanding audio streaming
    • Understanding latency
    • Voice cloning
  • How-to guides
        • Client-side streaming
        • Server-side streaming
        • Transcripts and commit strategies
        • Event reference
  • Reference
    • Libraries & SDKs
    • Errors
    • Agent tooling
    • Webhooks
    • Zero Retention Mode
    • Breaking changes policy
    • UI components
    • Example projects
    • Next.js template
    • Showcase
  • Private deployment
    • Overview
LogoLogo
Login
Login
Connect
BlogHelp CenterAPI PricingSign up
On this page
  • Sent events
  • Received events
  • Error handling
How-to guidesSpeech to TextRealtime

Realtime event reference

Reference of the events received from the Realtime Speech to Text API
Was this page helpful?
Previous

Music streaming

This guide shows you how to stream music with Eleven Music.
Next
Built with

Reference · Lists all events sent to and received from the Realtime Speech to Text WebSocket API.

Review the API reference for the Realtime Speech to Text API for more information on the API and its options.

Sent events

EventDescriptionWhen to use
input_audio_chunkSend audio data for transcriptionContinuously while streaming audio

Received events

EventDescriptionWhen received
session_startedConfirms connection and returns session configurationImmediately after WebSocket connection is established
partial_transcriptLive transcript updateDuring audio processing, before a commit is made
committed_transcriptTranscript of the audio segmentAfter a commit (either manual or VAD triggered)
committed_transcript_with_timestampsSent after the committed transcript of the audio segment. Contains word-level timestampsSent after the committed transcript of the audio segment. Only received when include_timestamps=true is included in the query parameters

Error handling

If an error occurs, an error message will be returned before the WebSocket connection is closed.

Error TypeDescription
auth_errorAn error occurred while authenticating the request. Double check your API key
quota_exceededYou have exceeded your usage quota
transcriber_errorAn error occurred while transcribing the audio.
input_errorAn error occurred while processing the audio chunk. Likely due to invalid input format or parameters
errorA generic server error
commit_throttledThe commit was throttled due to too many commit requests made in a short period of time
transcriber_errorAn error occurred while transcribing the audio.
unaccepted_termsYou haven’t accepted the terms of service to use Scribe. Please review and accept the terms & conditions in the ElevenLabs dashboard
rate_limitedYou are rate limited. Please reduce the amount of requests made in a short period of time
queue_overflowThe processing queue is full. Please send fewer requests made in a short period of time
resource_exhaustedServer resources are at capacity. Please try again later
session_time_limit_exceededMaximum session time has been reached. Please start a new session or upgrade your subscription
chunk_size_exceededThe audio chunk size is too large. Please reduce the chunk size
insufficient_audio_activityYou haven’t sent enough audio activity to maintain the connection