@elevenlabs/react

Minor Changes

• dca95fb: Add an onAudioAlignmentPlayback callback, called with { event_id, alignment } when an aligned audio chunk starts playing, for syncing text with speech. It is not called on WebRTC connections.

Minor Changes

• bac5c96: Forward the experimental onConversationHistory callback to @elevenlabs/client.

Minor Changes

• 050aeea: Add a previousText option to Scribe.connect() and useScribe() in microphone mode. It is sent with the first microphone audio chunk to give the model context, such as existing document text, for casing, punctuation and sentence continuation.

Minor Changes

• 33a5042: Add the transcriptEdit option to Scribe.connect() and dispatch the new edited_transcript server message:

  • transcriptEdit: a natural-language instruction applied to each committed transcript (max 2000 characters), sent as the transcript_edit query param. Cannot be combined with entityDetection.

  • edited_transcript (RealtimeEvents.EDITED_TRANSCRIPT), carrying the committed text and its edited_text (EditedTranscriptMessage). edited_text equals text when the instruction changed nothing.

  • useScribe() accepts the same transcriptEdit option, exposes an onEditedTranscript callback and attaches the edited text to the matching entry in committedTranscripts as editedText.

Patch Changes

• eaab81f: Fix useScribe dropping the secondaryLanguages option, so a session that sets it now sends secondary_languages on the realtime WebSocket URL instead of only language_code. The option was added to Scribe.connect() but never forwarded by the hook, which passed a fixed subset of the client options.

  filterBackgroundAudio was missing for the same reason and is now forwarded too. Both are accepted as hook options and as connect() options, like the options around them.

  The two Scribe.connect() calls behind the hook's microphone and manual-audio modes now share one options object, so a client option only has to be forwarded once.

Minor Changes

• f94ef6d: Add fileIds to sendMultimodalMessage and dual-send file + files on the wire.

Minor Changes

• be9cb0c: Add support for the external_agent_disconnected client event. The client SDK exposes a new onExternalAgentDisconnected callback, and the widget leaves external-agent mode (and clears the typing indicator) when the external human agent disconnects and the AI agent resumes control.

Minor Changes

• eea19d2: Add support for the context_usage server event via a new onContextUsage callback. The event is emitted after each completed agent turn and reports { event_id, model, context_tokens, context_limit_tokens }, where context_tokens is the prompt size of the turn's last LLM generation and context_limit_tokens is that model's maximum context window — useful for surfacing how close a long conversation is to the context limit.

Patch Changes

• 880edd2: Expose missing realtime speech-to-text options on Scribe.connect(), matching elevenlabs-js#436:

  • secondaryLanguages: additional language codes that may be present in the audio, sent as repeated secondary_languages query params.

  • entityDetection: detect entities (PII, PHI, PCI, offensive language, or specific types) on committed transcripts. Accepts a single value or a list.

  • filterBackgroundAudio: enable background speech filtering to reduce false activations from nearby conversations and ambient noise.

  New server messages are now dispatched instead of being dropped:

  • final_transcript and final_transcript_with_timestamps (RealtimeEvents.FINAL_TRANSCRIPT / FINAL_TRANSCRIPT_WITH_TIMESTAMPS)

  • committed_transcript_entities, carrying DetectedEntity (RealtimeEvents.COMMITTED_TRANSCRIPT_ENTITIES)

  • invalid_request, sent when the server rejects the connection parameters (RealtimeEvents.INVALID_REQUEST), emitted alongside the generic ERROR event

  Also fixes vadSilenceThresholdSecs, minSpeechDurationMs, and minSilenceDurationMs lower-bound validation to treat the bound as inclusive, matching the API (e.g. vadSilenceThresholdSecs: 0.3 is now accepted instead of being rejected client-side).

  The scribe.asyncapi.yaml schema (and the generated Word/CommittedTranscriptWithTimestampsMessage/FinalTranscriptWithTimestampsMessage types) was cross-checked against the live contract at https://api.elevenlabs.io/speech-to-text-asyncapi.yml. The words shape is identical between committed_transcript_with_timestamps and final_transcript_with_timestamps on that contract (both support "audio_event", per-character timings, and channel_index), so both messages now share a single Word type instead of the narrower shape committed_transcript_with_timestamps previously used. Config also gained timestamps_granularity and max_tokens_to_recompute to match the session config the server echoes back.

  @elevenlabs/react's useScribe().committedTranscripts.words (WordTimestamp) is updated to match: type now includes "audio_event", characters is now WordTimestampCharacter (each with its own start/end) instead of string, and a channel_index field was added.

• a068144: Fix a microphone-setup failure wedging useScribe, so a denied or dismissed
  permission prompt can be retried without remounting.

  A microphone-mode session whose getUserMedia call rejects can never send
  audio, but the socket was left open holding that session. useScribe kept its
  connection ref, and every later connect() short-circuited on "Already connected". The failed setup now closes the connection, which releases the
  stranded socket and lets the hook's existing close handling clear the ref.
  onError still fires first; the session then ends as disconnected with the
  error preserved.

  The hook's close handler also nulled its ref for whichever connection reported
  a close, so a late close from a replaced socket tore down the session that had
  replaced it — the race a consumer hit when working around the above with
  disconnect-then-reconnect. A close is now ignored when a newer connection owns
  the ref, while an explicit disconnect() still reports normally.

Patch Changes

• 92e70c6: Fix conversation state consistency through disconnect:

  • BaseConversation now always reaches the disconnected status and fires onDisconnect, even when session teardown throws.

  • ConversationProvider no longer lets a late onDisconnect from a previous session clear a newer session's state, and no longer leaks unhandled rejections from endSession().

  • useConversationStatus now reports disconnected as soon as teardown starts, instead of holding connected while the conversation was already released — consumers guarding conversation access with status === "connected" could previously crash during disconnect.

Minor Changes

• a96f220: Add enableLogging option (boolean) to the Scribe realtime API, available on Scribe.connect and the useScribe hook. Setting it to false sends enable_logging=false on the WebSocket URL, which runs the session in zero retention mode so history features are unavailable for it. Zero retention mode may only be used by enterprise customers.

Minor Changes

• 139ed79: Add onAgentReasoningResponsePart callback to receive streaming reasoning response
  events from the agent. The callback receives { text, type, event_id } where type
  is one of "start", "delta", or "stop".