Changelog

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
  • Add speaker segment - Made text 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

New Endpoints

• Added 7 new endpoints:
  • Add a shared voice to your collection
  • Archive a project snapshot
  • Update a project
  • Create an Audio Native enabled project
  • Get all voices
  • Download a pronunciation dictionary
  • Get Audio Native project settings

Updated Endpoints

Studio Projects

• Updated Studio project endpoints to add source_type property and deprecate quality_check_on and quality_check_on_when_bulk_convert properties:
  • Get projects
  • Get project
  • Add project
  • Update content
  • Create podcast

Voice Management

• Updated Voice endpoints with several property changes:
  • Get voice - Made several properties optional and added preview_url
  • Create voice - Made several properties optional and added preview_url
  • Create voice from preview - Made several properties optional and added preview_url
  • Get similar voices - Made language, description, preview_url, and rate properties optional

Conversational AI

• Updated Conversational AI agent endpoints:
  • Update agent - Modified conversation_config, agent, platform_settings, and widget properties
  • Create agent - Modified conversation_config, agent, prompt, platform_settings, widget properties and added shareable_page_show_terms
  • Get agent - Modified conversation_config, agent, platform_settings, and widget properties
  • Get widget - Modified widget_config property and added shareable_page_show_terms

Knowledge Base

• Updated Knowledge Base endpoints to add metadata property:
  • List knowledge base documents
  • Get knowledge base document

Other Updates

• Dub a video or audio file - Added dubbing_studio property
• Convert text to sound effects - Added output_format query parameter
• Convert speech to text - Added enable_logging query parameter
• Get secrets - Modified secrets and used_by properties
• Get all pronunciation dictionaries - Made next_cursor property optional

Removed Endpoints

• Temporarily removed Conversational AI tools endpoints:

  • Get tool
  • List tools
  • Update tool
  • Create tool
  • Delete tool

New Endpoints

• Added new Dubbing resource management endpoints:
  • for adding languages to dubs
  • for retrieving dubbing resources
  • for creating segments
  • for modifying segments
  • for removing segments
  • for dubbing segments
  • for transcribing segments
  • for translating segments
• Added Knowledge Base RAG indexing endpoint
• Added Studio snapshot retrieval endpoints for projects and chapters

Updated Endpoints

• Added prompt_injectable property to knowledge base endpoints
• Added name property to Knowledge Base document creation and retrieval endpoints:
• Added speed property to agent creation
• Removed secrets property from agent endpoints (now handled by dedicated secrets endpoints)
• Added secret deletion endpoint for removing secrets
• Removed secrets property from settings endpoints

• Launched /v1/speech-to-text endpoint
• Added agents.level property to Conversational AI agents endpoint
• Added platform_settings to Conversational AI agent endpoint
• Added expandable variant to widget_config, with configuration options show_avatar_when_collapsed and disable_banner to Conversational AI agent widget endpoint
• Added webhooks property and used_by to secrets to secrets endpoint
• Added verified_languages to voices endpoint
• Added speed property to voice settings endpoints
• Added verified_languages, is_added_by_user to voices and min_notice_period_days query parameter to shared voices endpoint
• Added verified_languages, is_added_by_user to voices in similar voices endpoint
• Added search, show_only_owned_documents, use_typesense query parameters to knowledge base endpoint
• Added used_by to Conversation AI secrets endpoint
• Added invalidate_affected_text property to Studio pronunciation dictionaries endpoint

• Added phone_numbers property to Agent responses
• Added usage metrics to subscription_extras in User endpoint:
  • unused_characters_rolled_over_from_previous_period
  • overused_characters_rolled_over_from_previous_period
  • usage statistics
• Added enable_conversation_initiation_client_data_from_webhook to Agent creation
• Updated Agent endpoints with consolidated settings for:
  • platform_settings
  • overrides
  • safety
• Deprecated with_settings parameter in Voice retrieval endpoint

Studio (formerly Projects)

All /v1/projects/* endpoints have been deprecated in favor of the new /v1/studio/projects/* endpoints. The following endpoints are now deprecated:

• All operations on /v1/projects/
• All operations related to chapters, snapshots, and content under /v1/projects/*

Conversational AI

• POST /v1/convai/add-tool - Use POST /v1/convai/tools instead

• DELETE /v1/convai/agents/{agent_id} - Response type is no longer an object
• GET /v1/convai/tools - Response type changed from array to object with a tools property

Conversational AI Updates

• GET /v1/convai/agents/{agent_id} - Updated conversation configuration and agent properties
• PATCH /v1/convai/agents/{agent_id} - Added use_tool_ids parameter for tool management
• POST /v1/convai/agents/create - Added tool integration via use_tool_ids

Knowledge Base & Tools

• GET /v1/convai/agents/{agent_id}/knowledge-base/{documentation_id} - Added name and access_level properties
• GET /v1/convai/knowledge-base/{documentation_id} - Added name and access_level properties
• GET /v1/convai/tools/{tool_id} - Added dependent_agents property
• PATCH /v1/convai/tools/{tool_id} - Added dependent_agents property

GenFM

• POST /v1/projects/podcast/create - Added support for multiple input sources

Studio (formerly Projects)

New endpoints replacing the deprecated /v1/projects/* endpoints

• GET /v1/studio/projects: List all projects
• POST /v1/studio/projects: Create a project
• GET /v1/studio/projects/{project_id}: Get project details
• DELETE /v1/studio/projects/{project_id}: Delete a project

Knowledge Base Management

• GET /v1/convai/knowledge-base: List all knowledge base documents
• DELETE /v1/convai/knowledge-base/{documentation_id}: Delete a knowledge base
• GET /v1/convai/knowledge-base/{documentation_id}/dependent-agents: List agents using this knowledge base

Workspace Groups - New enterprise features for team management

• GET /v1/workspace/groups/search: Search workspace groups
• POST /v1/workspace/groups/{group_id}/members: Add members to a group
• POST /v1/workspace/groups/{group_id}/members/remove: Remove members from a group

Tools

• POST /v1/convai/tools: Create new tools for agents