Skip to content

elevenlabs: deprecate STT modelId in favor of model#2018

Merged
u9g merged 1 commit into
mainfrom
jl/elevenlabs-stt-model-param
Jul 10, 2026
Merged

elevenlabs: deprecate STT modelId in favor of model#2018
u9g merged 1 commit into
mainfrom
jl/elevenlabs-stt-model-param

Conversation

@u9g

@u9g u9g commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Description

The ElevenLabs STT plugin takes modelId while the ElevenLabs TTS plugin takes model, which makes it easy to pass the wrong parameter name when configuring both from the same config shape. Reported via MCP docs feedback in Slack. This aligns STT with TTS without breaking existing code. Companion PRs: livekit/agents#6378 (same change for Python), livekit/web#5084 (docs cross-link).

Changes Made

  • Add a model option to STTOptions as the preferred spelling; modelId remains a deprecated alias that logs a deprecation warning (same pattern as the existing useRealtime deprecation and the TTS plugin's legacy modelID).
  • If both are provided, model wins and a warning is logged. Behavior is otherwise unchanged, including the scribe_v1 default.
  • Update the scribe example and existing tests to use model.
  • Add a changeset.

Pre-Review Checklist

  • Build passes: All builds (lint, typecheck, tests) pass locally
  • AI-generated code reviewed: Removed unnecessary comments and ensured code quality
  • Changes explained: All changes are properly documented and justified above
  • Scope appropriate: All changes relate to the PR title, or explanations provided for why they're included
  • Video demo: N/A — no user-visible behavior change

Testing

  • All tests pass (vitest run plugins/elevenlabs/src/stt.test.ts: 6 passed, 1 skipped integration test)
  • Make sure both restaurant_agent.ts and realtime_agent.ts work properly (for major changes) — N/A, plugin-scoped option rename

Additional Notes

The deprecation warning is user-visible log output for anyone currently passing modelId; the option keeps working unchanged.

@u9g u9g requested a review from a team as a code owner July 10, 2026 14:42
@changeset-bot

changeset-bot Bot commented Jul 10, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 8a47ea5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 36 packages
Name Type
@livekit/agents-plugin-elevenlabs Patch
@livekit/agents Patch
@livekit/agents-plugin-anam Patch
@livekit/agents-plugin-anthropic Patch
@livekit/agents-plugin-assemblyai Patch
@livekit/agents-plugin-baseten Patch
@livekit/agents-plugin-bey Patch
@livekit/agents-plugin-cartesia Patch
@livekit/agents-plugin-cerebras Patch
@livekit/agents-plugin-deepgram Patch
@livekit/agents-plugin-did Patch
@livekit/agents-plugin-fishaudio Patch
@livekit/agents-plugin-google Patch
@livekit/agents-plugin-hedra Patch
@livekit/agents-plugin-hume Patch
@livekit/agents-plugin-inworld Patch
@livekit/agents-plugin-lemonslice Patch
@livekit/agents-plugin-liveavatar Patch
@livekit/agents-plugin-livekit Patch
@livekit/agents-plugin-minimax Patch
@livekit/agents-plugin-mistral Patch
@livekit/agents-plugin-mistralai Patch
@livekit/agents-plugin-neuphonic Patch
@livekit/agents-plugin-openai Patch
@livekit/agents-plugin-perplexity Patch
@livekit/agents-plugin-phonic Patch
@livekit/agents-plugin-resemble Patch
@livekit/agents-plugin-rime Patch
@livekit/agents-plugin-runway Patch
@livekit/agents-plugin-sarvam Patch
@livekit/agents-plugin-silero Patch
@livekit/agents-plugin-soniox Patch
@livekit/agents-plugin-tavus Patch
@livekit/agents-plugin-trugen Patch
@livekit/agents-plugin-xai Patch
@livekit/agents-plugins-test Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@u9g u9g merged commit 2d862e9 into main Jul 10, 2026
9 checks passed
@u9g u9g deleted the jl/elevenlabs-stt-model-param branch July 10, 2026 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants