Skip to content

v3.0.0-alpha.1

Pre-release
Pre-release

Choose a tag to compare

@PaulAsjes PaulAsjes released this 03 Sep 13:16
a8a6116

First v3 alpha. Breaking changes; see the v3 upgrade guide in the wiki.

Install: npm i @elevenlabs/elevenlabs-js@alpha / pip install --pre elevenlabs

Renamed

  • conversationalAi / conversational_aiagents; the old agents
    sub-resource is flattened onto the group (client.agents.create).
    API URLs are unchanged (/v1/convai/*). Per-agent LLM usage stays
    nested at agents.agents.llmUsage.
  • Per-endpoint request/response helper types are now verb-first
    (AgentsListRequestListAgentsRequest).
  • Python: OnPremInitiationDataOrchestratorConfig,
    on_prem_configorchestrator_config, on_prem_conversation_url
    url (now validated as ws/wss). Wire format unchanged. Closes #840.
  • Python: internal speech_engine.typesspeech_engine.session_types.

WebSockets — now generated clients

  • Hand-written realtime clients removed in favour of generated ones:
    speechToText.realtime, textToSpeech.realtime,
    textToSpeechMultiContext, textToDialogue(.MultiContext),
    translate.realtime, dubbing.realtime, speechEngine.upstream.
  • Dropped: URL-based streaming (the ffmpeg-backed url option) and the
    RealtimeConnection / RealtimeEvents / AudioFormat /
    CommitStrategy root exports.

Removed (deprecated in v2)

  • voices.getAllvoices.search
  • textToVoice.createPreviewstextToVoice.design
  • conversationalAi.addToKnowledgeBaseagents.knowledgeBase.documents.*
  • agents.simulateConversation (+stream) → agent-testing endpoints
  • mcpServers.approvalPolicy.updateagents.mcpServers.update
  • usage.get → workspace analytics usage queries
  • dubbing.transcript.getdubbing.transcripts.get
  • all 13 dubbing.resource.* methods → Dubbing Studio endpoints
  • cloudStorageUrl on speechToText.convertsourceUrl

Runtime / packaging

  • JS: requires Node 18+; native fetch (node-fetch dependency gone).
  • JS: dual CJS/ESM build with a full exports map; deep imports of
    dist/... must move to the documented subpaths.
  • JS: request properties explicitly set to undefined are now omitted
    rather than sent as null.
  • JS: ws stubbed in the browser field so bundlers don't include it.

Other

  • JS: Speech Engine attach() takes one options object —
    engine.attach({ server, path, ...callbacks }).
  • JS: the never-exported conversationalAi/conversation deep-import
    classes are deleted; use @elevenlabs/client for voice conversations.
  • Both repos ship an elevenlabs:sdk-migration agent skill for
    automated v2 → v3 migration.