Changelog

New Endpoints

• Added 6 new endpoints:
  • Get Signed Url - Get a signed URL to start a conversation with an agent that requires authorization.
  • Simulate Conversation - Run a conversation between an agent and a simulated user.
  • Simulate Conversation (Stream) - Run and stream a conversation simulation between an agent and a simulated user.
  • Update Convai Workspace Secret - Update an existing secret for the Convai workspace.
  • Submit Batch Call Request - Submit a batch call request to schedule calls for multiple recipients.
  • Get All Batch Calls for Workspace - Retrieve all batch calls for the current workspace.

Updated Endpoints

Conversational AI

• Agents & Conversations:
  • Endpoint GET /v1/convai/conversation/get_signed_url (snake_case path) has been deprecated. Use the new GET /v1/convai/conversation/get-signed-url (kebab-case path) instead.
• Phone Numbers:
  • Get Phone Number Details - Response schema for GET /v1/convai/phone-numbers/{phone_number_id} updated to distinct Twilio and SIPTrunk provider details.
  • Update Phone Number - Response schema for PATCH /v1/convai/phone-numbers/{phone_number_id} updated similarly for Twilio and SIPTrunk.
  • List Phone Numbers - Response schema for GET /v1/convai/phone-numbers/ list items updated for Twilio and SIPTrunk providers.

Text To Speech

• Text to Speech Endpoints - Default model_id changed from eleven_monolingual_v1 to eleven_multilingual_v2 for the following endpoints:
  • POST /v1/text-to-speech/{voice_id}/stream
  • POST /v1/text-to-speech/{voice_id}/stream-with-timestamps
  • POST /v1/text-to-speech/{voice_id}
  • POST /v1/text-to-speech/{voice_id}/with-timestamps

Voices

• Get Shared Voices - Added include_custom_rates query parameter to GET /v1/shared-voices.
• Schema Updates:
  • LibraryVoiceResponseModel and VoiceSharingResponseModel now include an optional fiat_rate field (USD per 1000 credits).

New Endpoints

• Update metadata for a speaker
  PATCH /v1/dubbing/resource/{dubbing_id}/speaker/{speaker_id}
  Amend the metadata associated with a speaker, such as their voice. Both voice cloning and using voices from the ElevenLabs library are supported.

• Search similar voices for a speaker
  GET /v1/dubbing/resource/{dubbing_id}/speaker/{speaker_id}/similar-voices
  Fetch the top 10 similar voices to a speaker, including IDs, names, descriptions, and sample audio.

• Simulate a conversation
  POST /v1/convai/agents/{agent_id}/simulate_conversation
  Run a conversation between the agent and a simulated user.

• Simulate a conversation (stream)
  POST /v1/convai/agents/{agent_id}/simulate_conversation/stream
  Stream a simulated conversation between the agent and a simulated user.

• Handle outbound call via SIP trunk
  POST /v1/convai/sip-trunk/outbound-call
  Initiate an outbound call using SIP trunking.

Updated Endpoints

• List conversations
  GET /v1/convai/conversations
  Added call_start_after_unix query parameter to filter conversations by start date.

• Update knowledge base document
  PATCH /v1/convai/knowledge-base/{documentation_id}
  Now supports updating the name of a document.

• Text to Speech endpoints
  The default model for all TTS endpoints is now eleven_multilingual_v2 (was eleven_monolingual_v1).

Removed Endpoints

• None.

New Endpoints

• Added 2 new endpoints for managing Conversational AI dashboard settings:
  • Get Dashboard Settings - Retrieves custom chart configurations for the ConvAI dashboard.
  • Update Dashboard Settings - Updates custom chart configurations for the ConvAI dashboard.

Updated Endpoints

Audio Generation (TTS, S2S, SFX, Voice Design)

• Updated endpoints to support new output_format option pcm_48000:
  • Text to Speech (POST /v1/text-to-speech/{voice_id})
  • Text to Speech with Timestamps (POST /v1/text-to-speech/{voice_id}/with-timestamps)
  • Text to Speech Stream (POST /v1/text-to-speech/{voice_id}/stream)
  • Text to Speech Stream with Timestamps (POST /v1/text-to-speech/{voice_id}/stream/with-timestamps)
  • Speech to Speech (POST /v1/speech-to-speech/{voice_id})
  • Speech to Speech Stream (POST /v1/speech-to-speech/{voice_id}/stream)
  • Sound Generation (POST /v1/sound-generation)
  • Create Voice Previews (POST /v1/text-to-voice/create-previews)

Usage Analytics

• Updated usage metrics endpoint:
  • Get Usage Metrics (GET /v1/usage/character-stats) - Added optional aggregation_interval and metric query parameters.

Conversational AI

• Updated conversation listing endpoint:
  • List Conversations (GET /v1/convai/conversations) - Added optional call_start_before_unix query parameter for filtering by start date.

Schema Changes

Conversational AI

• Added detailed LLM usage and pricing information to conversation charging and history models.
• Added tool_latency_secs to tool result schemas
• Added access_info to GET /v1/convai/agents/{agent_id}

New Endpoints

• Added 16 new endpoints:
  • Delete Member - Allows deleting workspace members.
  • Create PVC Voice - Creates a new PVC voice.
  • Edit PVC Voice - Edits PVC voice metadata.
  • Add Samples To PVC Voice - Adds audio samples to a PVC voice.
  • Update PVC Voice Sample - Updates a PVC voice sample (noise removal, speaker selection, trimming).
  • Delete PVC Voice Sample - Deletes a sample from a PVC voice.
  • Retrieve Voice Sample Audio - Retrieves audio for a PVC voice sample.
  • Retrieve Voice Sample Visual Waveform - Retrieves the visual waveform for a PVC voice sample.
  • Retrieve Speaker Separation Status - Gets the status of speaker separation for a sample.
  • Start Speaker Separation - Initiates speaker separation for a sample.
  • Retrieve Separated Speaker Audio - Retrieves audio for a specific separated speaker.
  • Get PVC Voice Captcha - Gets the captcha for PVC voice verification.
  • Verify PVC Voice Captcha - Submits captcha verification for a PVC voice.
  • Run PVC Training - Starts the training process for a PVC voice.
  • Request Manual Verification - Requests manual verification for a PVC voice.

Updated Endpoints

Speech to Text

• Updated endpoint with changes:
  • Create Forced Alignment Task - Added enabled_spooled_file parameter to allow streaming large files (POST /v1/forced-alignment).

Schema Changes

Conversational AI

• GET conversation details: Added has_audio, has_user_audio, has_response_audio boolean fields here

Dubbing

• GET dubbing resource : Added status field to each render here

New Endpoints

• Added render dub endpoint - Regenerate dubs for a specific language.

Updated Endpoints

Pronunciation Dictionaries

• Updated the response for the GET /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/ endpoint and related components to include the permission_on_resource field.

Speech to Text

• Updated Speech to Text endpoint (POST /v1/speech-to-text):
  • Added cloud_storage_url parameter to allow transcription directly from public S3 or GCS URLs (up to 2GB).
  • Made the file parameter optional; exactly one of file or cloud_storage_url must now be provided.

Speech to Speech

• Added optional file_format parameter (pcm_s16le_16 or other) for lower latency with PCM input to POST /v1/speech-to-speech/{voice_id}

Conversational AI

• Updated components to support agent-agent transfer tool

Voices

• Updated GET /v1/voices/{voice_id} samples field to include optional trim_start and trim_end parameters.

AudioNative

• Updated Get /v1/audio-native/{project_id}/settings to include status field (processing or ready).

New Endpoints

• Added Forced alignment endpoint for aligning audio with text
• Added dedicated endpoints for knowledge base document types:
  • Create text document
  • Create file document
  • Create URL document

Updated Endpoints

Text to Speech

• Added a-law format (8kHz) to all audio endpoints:
  • Text to speech
  • Stream text to speech
  • Convert with timestamps
  • Stream with timestamps
  • Speech to speech
  • Stream speech to speech
  • Create voice previews
  • Sound generation

Voices

• Get voices - Added collection_id parameter for filtering voices by collection

Knowledge Base

• Get knowledge base - Added types parameter for filtering documents by type
• General endpoint for creating knowledge base documents marked as deprecated in favor of specialized endpoints

User Subscription

• Get user subscription - Added professional_voice_slots_used property to track number of professional voices used in a workspace

Conversational AI

• Added silence_end_call_timeout parameter to set maximum wait time before terminating a call
• Removed /v1/convai/agents/{agent_id}/add-secret endpoint (now handled by workspace secrets endpoints)

Updated Endpoints

Text to Speech

• Updated Text to Speech endpoints:
  • Convert text to speech - Added apply_language_text_normalization parameter for improved text pronunciation in supported languages (currently Japanese)
  • Stream text to speech - Added apply_language_text_normalization
  • Convert with timestamps - Added apply_language_text_normalization
  • Stream with timestamps - Added apply_language_text_normalization

Audio Format

• Added Opus format support to multiple endpoints:
  • Text to speech - Added support for Opus format with 48kHz sample rate at multiple bitrates (32, 64, 96, 128, 192 kbps)
  • Stream text to speech - Added Opus format options
  • Convert with timestamps - Added Opus format options
  • Stream with timestamps - Added Opus format options
  • Speech to speech - Added Opus format options
  • Stream speech to speech - Added Opus format options
  • Create voice previews - Added Opus format options
  • Sound generation - Added Opus format options

Conversational AI

• Updated Conversational AI endpoints:
  • Delete agent - Changed success response code from 200 to 204
  • Updated RAG embedding model options - replaced gte_Qwen2_15B_instruct with multilingual_e5_large_instruct

Voices

• Updated Voice endpoints:
  • Get shared voices - Added locale parameter for filtering voices by language region

Dubbing

• Updated Dubbing endpoint:
  • Dub a video or audio file - Renamed beta feature use_replacement_voices_from_library parameter to disable_voice_cloning for clarity

New Endpoints

• Added 5 new endpoints:
  • List voices (v2) - Enhanced voice search capabilities with additional filtering options
  • Initiate outbound call - New endpoint for making outbound calls via Twilio integration
  • Add pronunciation dictionary from rules - Create pronunciation dictionaries directly from rules without file upload
  • Get knowledge base document content - Retrieve full document content from the knowledge base
  • Get knowledge base document chunk - Retrieve specific chunks from knowledge base documents

Updated Endpoints

Conversational AI

• Updated Conversational AI endpoints:
  • Create agent - Added mic_muting_enabled property for UI control and workspace_overrides property for workspace-specific configurations
  • Update agent - Added workspace_overrides property for customizing agent behavior per workspace
  • Get agent - Added workspace_overrides property to the response
  • Get widget - Added mic_muting_enabled property for controlling microphone muting in the widget UI
  • Get conversation - Added rag information to view knowledge base content used during conversations
  • Create phone number - Replaced generic structure with specific twilio phone number and sip trunk options
  • Compute RAG index - Removed force_reindex query parameter for more controlled indexing
  • List knowledge base documents - Changed response structure to support different document types
  • Get knowledge base document - Modified to return different response models based on document type

Text to Speech

• Updated Text to Speech endpoints:
  • Convert text to speech - Made properties optional, including stability and similarity settings
  • Stream text to speech - Made voice settings properties optional for more flexible streaming requests
  • Convert with timestamps - Made settings optional and modified pronunciation_dictionary_locators property
  • Stream with timestamps - Made voice settings properties optional for more flexible requests

Speech to Text

• Updated Speech to Text endpoint:
  • Convert speech to text - Removed biased_keywords property from form data and improved internal repetition detection algorithm

Voice Management

• Updated Voice endpoints:
  • Get voices - Updated voice settings properties in the response
  • Get default voice settings - Made stability and similarity properties optional
  • Get voice settings - Made numeric properties optional for more flexible configuration
  • Edit voice settings - Made stability and similarity settings optional
  • Create voice - Modified array properties to accept null values
  • Create voice from preview - Updated voice settings model with optional properties

Studio

• Updated Studio endpoints:
  • Get project - Added version_rules_num to project metadata
  • Get project snapshot - Removed status property
  • Create pronunciation dictionaries - Modified pronunciation_dictionary_locators property and string properties to accept null values

Pronunciation Dictionary

• Updated Pronunciation Dictionary endpoints:
  • Get all pronunciation dictionaries - Added sort and sort_direction query parameters, plus latest_version_rules_num and integer properties to response
  • Get pronunciation dictionary - Added latest_version_rules_num and integer properties to response
  • Add from file - Added version_rules_num property to response for tracking rules quantity
  • Add rules - Added version_rules_num to response for rules tracking
  • Remove rules - Added version_rules_num to response for rules tracking

New Endpoints

• Added 3 new endpoints:
  • Get workspace resource
  • Share workspace resource
  • Unshare workspace resource

Updated Endpoints

Dubbing

• Updated Dubbing endpoints:
  • Dub a video or audio file - Added use_replacement_voices_from_library property and made source_path, target_language, source_language nullable
  • Resource dubbing - Made language_codes array nullable
  • Add language to dubbing resource - Made language_code nullable
  • Translate dubbing resource - Made target_languages array nullable
  • Update dubbing segment - Made start_time and end_time nullable

Project Management

• Updated Project endpoints:
  • Add project - Made metadata, project_name, description nullable
  • Create podcast - Made title, description, author nullable
  • Get project - Made last_modified_at, created_at, project_name nullable
  • Add chapter - Made chapter_id, word_count, statistics nullable
  • Update chapter - Made content and blocks properties nullable

Conversational AI

• Updated Conversational AI endpoints:
  • Update agent - Made conversation_config, platform_settings nullable and added workspace_overrides property
  • Create agent - Made agent_name, prompt, widget_config nullable and added workspace_overrides property
  • Add to knowledge base - Made document_name nullable
  • Get conversation - Added twilio_call_data model and made transcript, metadata nullable

Text to Speech

• Updated Text to Speech endpoints:
  • Convert text to speech - Made voice_settings, text_input nullable and deprecated use_pvc_as_ivc property
  • Stream text to speech - Made voice_settings, text_input nullable and deprecated use_pvc_as_ivc property
  • Convert with timestamps - Made character_alignment and word_alignment nullable

Voice Management

• Updated Voice endpoints:
  • Create voice previews - Added loudness, quality, guidance_scale properties
  • Create voice from preview - Added speaker_separation properties and made voice_id, name, labels nullable
  • Get voice - Added speaker_boost, speaker_clarity, speaker_isolation properties

Speech to Text

• Updated Speech to Text endpoint:
  • Convert speech to text - Added biased_keywords property

Other Updates

• Download history - Added application/zip content type and 400 response
• Add pronunciation dictionary from file - Made dictionary_name and description nullable