Workspace

  • Basic and Full Seats: Workspaces now support two seat types - Full Seats with unrestricted access to all products, and Basic Seats with full access to ElevenAgents and ElevenAPI and limited ElevenCreative usage. All paid plans include 20 Basic Seats. Enterprise admins can purchase additional Full Seats directly from workspace settings. Learn more.

ElevenAgents

  • Environment Variables API: New environment variables endpoints for managing workspace-level configuration that agents can reference at runtime via {{system_env__<label>}} templating. Supports string, secret, and auth-connection variable types with per-environment value overrides. Endpoints include create, list, get, and update.

  • Auth Connections management: New workspace-level auth connections API for managing authentication credentials used by agent tools and integrations. Supports multiple auth methods including OAuth2 client credentials, JWT, basic auth, bearer tokens, custom headers, and integration-managed OAuth2 authorization code flows. Endpoints include create, list, and delete operations.

  • Knowledge Base URL refresh: New refresh endpoint (POST /v1/convai/knowledge-base/{documentation_id}/refresh) to re-fetch and update content for URL-sourced knowledge base documents. Knowledge base documents also now support auto-sync configuration with enable_auto_sync, auto_remove, and auto_sync_info fields.

  • Guardrail retry with feedback: Custom and content guardrails now support configurable trigger actions with EndCallTriggerAction and RetryTriggerAction options. When set to retry, the agent re-generates its response with injected system feedback up to 3 attempts. Available placeholders include {{trigger_reason}} and {{agent_message}} for contextual retry guidance.

  • Conversation History system variable: Added a new system__conversation_history dynamic variable that provides a lazily-evaluated, JSON-serialized conversation history at runtime. This is useful for passing full conversation context to tools, webhooks, or sub-agent handoffs.

  • Webhook tool content type: Server tools now support a configurable content type for webhook body parameters, allowing you to choose between application/json and application/x-www-form-urlencoded formats. The URL-encoded format is useful for integrating with legacy systems, OAuth token endpoints, and payment processors.

  • WhatsApp outbound messages: Updated the WhatsApp integration with a new outbound message dialog in the dashboard, enabling agents to send outbound messages in addition to calls through the WhatsApp channel.

  • Agent and resource listing filters: The list agents, list knowledge base documents, and list tools endpoints now support a created_by_user_id query parameter (use @me for the current user). The previous show_only_owned_agents and show_only_owned_documents parameters are deprecated.

  • Workflow conditional expressions: Added a new conditional_operator AST node to the workflow expression schema, enabling branching logic within agent workflow definitions.

Music

  • Music Marketplace: New Music Marketplace documentation covering the marketplace for licensing AI-generated music, including usage types, creator payouts, and licensing details.

SDK Releases

Python SDK

  • v2.40.0 - Added environment parameter support for ElevenAgents conversations, enabling environment-specific agent connections. Fern regeneration to match the latest API schema including environment variables, auth connections, knowledge base refresh, and guardrail trigger actions.

JavaScript SDK

  • v2.40.0 - Added multimodal_message WebSocket event type for ElevenAgents real-time conversations. Fern regeneration to match the latest API schema including environment variables, auth connections, knowledge base refresh, and guardrail trigger actions.

iOS SDK

  • v3.1.1 - Added environment parameter support for environment-specific agent connections. Fixed a visionOS build error by bumping the platform requirement to v2.

Packages

Packages v1.0.0 Release Candidate

The first release candidate for v1.0.0 of the ElevenAgents client SDKs is now available. This is a major release with breaking changes that improve the API surface, add granular React hooks for better render performance, and unify the React Native SDK with the React SDK.

To try out the release candidate:

$npm install @elevenlabs/client@next @elevenlabs/react@next @elevenlabs/react-native@next

An elevenlabs:sdk-migration skill is available to help AI coding assistants automatically migrate your codebase to the new APIs. Add it to your Claude Code, Cursor, or Windsurf project to get guided migration support.

Key changes in v1.0.0:

  • @elevenlabs/client: Conversation is now a namespace object and type alias for TextConversation | VoiceConversation instead of a class. The Input and Output classes are replaced by InputController and OutputController interfaces, with new convenience methods on the conversation instance (setMicMuted(), setVolume(), getInputByteFrequencyData(), getOutputByteFrequencyData()). changeInputDevice() and changeOutputDevice() now return void.
  • @elevenlabs/react: useConversation now requires a ConversationProvider ancestor. New granular hooks for fine-grained re-rendering: useConversationControls(), useConversationStatus(), useConversationInput(), useConversationMode(), useConversationFeedback(). New useConversationClientTool() hook for dynamically registering client tools from React components with full type safety.
  • @elevenlabs/react-native: Complete API rewrite replacing ElevenLabsProvider and useConversation with ConversationProvider and the same granular hooks from @elevenlabs/react. WebRTC polyfills and native AudioSession configuration are applied automatically on import.

See the full release notes and migration guides:

API

New Endpoints

ElevenAgents

  • Create environment variable - POST /v1/convai/environment-variables - Create a new environment variable with string, secret, or auth-connection type
  • List environment variables - GET /v1/convai/environment-variables - List all environment variables in the workspace
  • Get environment variable - GET /v1/convai/environment-variables/{env_var_id} - Get a specific environment variable
  • Update environment variable - PATCH /v1/convai/environment-variables/{env_var_id} - Update an environment variable, including per-environment value removal via null
  • Refresh URL document content - POST /v1/convai/knowledge-base/{documentation_id}/refresh - Re-fetch content for URL-sourced knowledge base documents

Workspaces

  • POST /v1/workspace/auth-connections - Create a workspace auth connection with support for OAuth2, JWT, basic, bearer, custom header, and integration-managed auth methods
  • GET /v1/workspace/auth-connections - List all workspace auth connections with dependency information (tools, MCP servers, integration connections)
  • DELETE /v1/workspace/auth-connections/{auth_connection_id} - Delete a workspace auth connection

Speech to Text

  • GET /v1/speech-to-text/evaluation/eval-criteria - List evaluation criteria
  • POST /v1/speech-to-text/evaluation/eval-criteria - Create an evaluation criterion
  • GET /v1/speech-to-text/evaluation/eval-criteria/{criterion_id} - Get a specific evaluation criterion
  • PATCH /v1/speech-to-text/evaluation/eval-criteria/{criterion_id} - Update an evaluation criterion
  • DELETE /v1/speech-to-text/evaluation/eval-criteria/{criterion_id} - Delete an evaluation criterion
  • POST /v1/speech-to-text/evaluation/evaluations - Trigger an evaluation
  • GET /v1/speech-to-text/evaluation/evaluations - List evaluations
  • GET /v1/speech-to-text/evaluation/evaluations/{evaluation_id} - Get a specific evaluation
  • GET /v1/speech-to-text/evaluation/human-agents - List human agents
  • GET /v1/speech-to-text/evaluation/human-agents/{agent_id} - Get a human agent
  • DELETE /v1/speech-to-text/evaluation/human-agents/{agent_id} - Delete a human agent
  • GET /v1/speech-to-text/evaluation/analytics - Get evaluation analytics
  • GET /v1/speech-to-text/evaluation/eval-criteria/{criterion_id}/analytics - Get analytics for a specific criterion
  • GET /v1/speech-to-text/evaluation/human-agents/{agent_id}/analytics - Get analytics for a specific human agent

Updated Endpoints

ElevenAgents

  • Get signed URL, Get conversation token

    • Added environment query parameter (string, optional) for environment-specific resolution
  • List agents

    • Added created_by_user_id query parameter (string, optional, supports @me)
    • Deprecated show_only_owned_agents in favor of created_by_user_id
  • List knowledge base documents

    • Added created_by_user_id query parameter (string, optional, supports @me)
    • Deprecated show_only_owned_documents in favor of created_by_user_id
  • List tools

    • Added created_by_user_id query parameter (string, optional, supports @me)
    • Deprecated show_only_owned_documents in favor of created_by_user_id
  • Get knowledge base chunk

    • Added embedding_model query parameter (string, optional) to specify the embedding model for chunk retrieval
  • Create agent, Update agent, Create draft

    • Added guardrail_trigger_action support with EndCallTriggerAction and RetryTriggerAction schemas
    • Added conditional_operator AST node to workflow expression definitions
    • Agent schemas now support ConvAIEnvVarLocator and EnvironmentAuthConnectionLocator for referencing environment variables in tool configs
  • SIP trunk outbound call

    • Request schema updated to accommodate new environment-related fields
  • Simulate conversation, Simulate conversation stream

    • Added simulation_environment field to request schema

Schema Changes

New Schemas

  • ConvAIEnvironmentVariable, ConvAIEnvironmentVariableCreate, ConvAIEnvironmentVariableUpdate - Environment variable models supporting string, secret, and auth-connection types
  • ConvAIEnvVarLocator, EnvironmentAuthConnectionLocator - Locators for referencing environment variables in tool and MCP server configs
  • EndCallTriggerAction, RetryTriggerAction - Guardrail trigger action schemas for end-call and retry-with-feedback behaviors
  • ConditionalOperator - New AST node for conditional expressions in agent workflows
  • AuthConnectionCreateRequest, AuthConnectionResponse, AuthConnectionDependencies - Workspace auth connection management schemas with support for OAuth2, JWT, basic, bearer, custom header, WhatsApp, and integration-managed auth methods
  • SpeechToTextEvaluation* - Suite of schemas for speech-to-text evaluation criteria, evaluations, human agents, and analytics

Modified Schemas

  • MCPServerConfig, MCPServerConfigOutput - Added support for ConvAIEnvVarLocator references in server configuration
  • CustomGuardrailConfig - Added trigger_action field for configuring end-call or retry behavior
  • Contributor - Added optional bio (string) and profile_id (string) fields
  • ASTLLMNode - Added value_schema field; prompt field is deprecated in favor of value_schema
  • TelephonyDirection - Refactored to a shared enum referenced by multiple conversation and telephony models

ElevenAgents

  • Users page is now generally available: The list users page, which groups conversations by a user identifier, is now available to all workspaces. This allows you to view all users who have interacted with your agents, their conversation history, and contact details in a unified view.

  • SIP inbound headers as dynamic variables: Custom SIP X- headers from inbound SIP trunking calls are now automatically exposed as dynamic variables in ElevenAgents conversations. Any custom SIP header (e.g., X-Contact-ID, X-Campaign-ID) passed by the caller is available in the agent prompt using {{sip_contact_id}}, {{sip_campaign_id}}, etc. These variables are also visible in the conversation history under the Phone Call tab. Reserved headers such as X-Call-ID and X-Caller-ID continue to map to system__call_sid and system__caller_id and are not overridden.

  • Conversation filtering by tool outcome: The list conversations and text search conversations endpoints now accept tool_names_successful and tool_names_errored query parameters (array of strings) to filter conversations by which tools succeeded or returned errors during the call.

  • User listing improvements: The list users endpoint now supports a sort_by query parameter accepting last_contact_unix_secs (default) or conversation_count, and a branch_id query parameter to filter users by agent branch.

  • Force delete tools: The delete tool endpoint now accepts a force query parameter (boolean, default false). When set to true, the tool is deleted even if it is used by agents, and it is automatically removed from all dependent agents and branches.

  • Conversation embedding retention: The ElevenAgents settings response now includes conversation_embedding_retention_days, which controls how long conversation embeddings are retained (maximum 365 days). A null value uses the system default of 30 days.

  • Content threshold guardrail: Added the ContentThresholdGuardrail schema, which provides a configurable threshold-based guardrail with an is_enabled flag and a threshold value for content moderation.

Workspaces

  • Get all workspace groups: New GET /v1/workspace/groups endpoint returns all groups in the workspace, including each group’s name, ID, members, permissions, usage limit, and character count.

  • Seat type in bulk workspace invites: The invite multiple users endpoint now accepts an optional seat_type field to specify the seat type (e.g., workspace_member, workspace_admin) for all invited users in a bulk operation.

  • Mobile SSO reliability improvements: Fixed a regression where SSO login on mobile would get stuck on “Authenticating…” after a user logged out and attempted to sign in again. Also fixed workspace switching for mobile SSO users who sign in via SAML or OIDC providers.

Music

  • Section duration control: The generate music detailed endpoint now supports respect_sections_durations (boolean), which controls whether the model adheres to the duration specified for each section in the composition plan.

Studio

  • Chapter visual content indicator: Chapter response models now include a has_visual_content boolean field indicating whether the chapter contains visual content.

  • Text shadow and outline styles: Studio text styling now supports text_shadow and text_outline options via the new StudioTextStyleShadowModel and StudioTextStyleOutlineModel schemas, enabling richer visual text customization within Studio projects.

  • Media generation clip task type: The PendingClipTask.type enum now includes the media_generation value, expanding clip task categorization to cover media generation workflows.

SDK Releases

Python SDK

  • v2.39.0 - Added support for the multimodal_message WebSocket event type in ElevenAgents real-time conversations.
  • v2.39.1 - Fern regeneration to match the latest API schema.

JavaScript SDK

  • v2.39.0 - Fern regeneration to match the latest API schema.

iOS SDK

  • v3.1.0 - Several improvements to the ElevenAgents Swift SDK:
    • Server errors are now surfaced through the onError callback, making error handling more consistent.
    • Added event-based agent state management for cleaner state observation.
    • Software muting is now supported alongside speech detection, enabling more granular audio control.
    • Improved codebase to use Swift Concurrency throughout.
    • Fixed a crash that occurred during startup on iOS release builds.
    • Updated branding to reflect the ElevenAgents rebrand.

Packages

API

New Endpoints

  • Get all workspace groups - GET /v1/workspace/groups - Returns all groups in the workspace with their members, permissions, and usage limits.

Updated Endpoints

ElevenAgents

  • List conversations

    • Added tool_names_successful query parameter (array of strings, optional) to filter conversations where specified tools had successful calls
    • Added tool_names_errored query parameter (array of strings, optional) to filter conversations where specified tools returned errors
  • Text search conversations

    • Added tool_names_successful query parameter (array of strings, optional)
    • Added tool_names_errored query parameter (array of strings, optional)
  • List users

    • Added sort_by query parameter (string, optional) accepting last_contact_unix_secs (default) or conversation_count
    • Added branch_id query parameter (string, optional) to filter users by agent branch
  • Delete tool

    • Added force query parameter (boolean, optional, default false) to delete a tool regardless of agent dependencies, automatically removing it from all dependent agents and branches
  • Get ElevenAgents settings, Update ElevenAgents settings

    • Added conversation_embedding_retention_days field (integer, optional, max 365) to configure how long conversation embeddings are retained

Workspaces

  • Invite multiple users

    • Added seat_type field (string, optional) to specify the seat type for all invited users

Music

  • Generate music detailed

    • Added respect_sections_durations field (boolean, optional) to control whether the model adheres to per-section durations in the composition plan

Studio

Schema Changes

New Schemas

  • ContentThresholdGuardrail - Threshold-based content guardrail with is_enabled (boolean) and threshold (number, default 0.3) fields
  • AgentPromptChangeToolConfig - System tool configuration for dynamic agent prompt changes
  • StudioTextStyleShadowModel - Text shadow styling for Studio
  • StudioTextStyleOutlineModel - Text outline styling for Studio
  • UsersSortBy - Enum for user listing sort options: last_contact_unix_secs, conversation_count
  • VideoAnalysis, VideoAnalysisResult, VideoKeyMoment, VideoSegment, VideoSubject, VideoTranscription, VideoTranscriptionWord - Video analysis result schemas for clip processing

Modified Schemas

  • ConversationHistorySIPTrunkingPhoneCallModel - Added sip_header_dynamic_variables field for inbound SIP custom X-headers
  • PendingClipTask - Added media_generation to the type enum

ElevenAgents

  • New LLM options: Added claude-sonnet-4-6 and gemini-3.1-flash-lite-preview as supported LLM providers for agent conversation configuration.

  • Guardrail execution mode: Custom guardrails now support a configurable execution_mode field with the GuardrailExecutionMode enum, and have separate input and output schema definitions. This allows more precise control over when guardrail logic runs and which message direction it applies to.

  • Guardrail triggered client event: Added guardrail_triggered to the ClientEvent enum, enabling agent workflows and client-side handlers to respond when a guardrail fires during a conversation.

  • Batch calling concurrency: Added target_concurrency_limit field to the submit batch call request body, allowing you to control the target number of concurrent calls for a given batch.

  • Agent testing type filter: The list agent tests endpoint now accepts a types query parameter to filter results by test type. The include_folders query parameter is deprecated in favor of the new types filter.

  • Telephony call configuration: Added telephony_call_config to outbound call request schemas for Twilio and SIP trunk calls, with a default ringing_timeout_secs of 60 seconds.

  • WhatsApp audio message responses: Added enable_audio_message_response to WhatsApp account configuration, enabling agents to send audio messages in addition to text in WhatsApp conversations.

Studio

  • Studio agent settings: Studio project models now expose an agent_settings field using StudioAgentSettingsModel, giving agent-connected studio projects a consistent settings surface alongside the new StudioAgentToolSettingsModel.

Mobile

  • SAML SSO for iOS and Android: Enterprise customers using SAML-based identity providers can now sign in from the ElevenLabs iOS and Android apps.

Speech to Text

  • No verbatim transcription mode: Added no_verbatim as a transcription option on the convert speech to text endpoint, allowing the model to produce cleaned-up output rather than a verbatim transcript.

Music

  • SDK CRLF fix: Resolved an issue in the Python and JavaScript SDKs where the generate music detailed endpoint response was not correctly parsed when the server used \r\n\r\n line endings. The parsers now handle both \r\n and \n line endings.

Voices

  • Voice captcha font support for non-Latin scripts: Fixed an issue where the instant voice cloning captcha displayed unreadable characters for some non-Latin scripts. Added font support and correct language selection for Hebrew, Thai, Armenian, Georgian, Malayalam, Telugu, and Gurmukhi. The captcha now uses the actual language of the cloned voice rather than defaulting to English.

SDK Releases

JavaScript SDK

  • v2.38.0 - Fern regeneration to match the latest API schema, including new ElevenAgents fields, updated SMB tool types, and studio agent settings.
  • v2.38.1 - Fixed CRLF parsing for the music detailed endpoint response stream.

Python SDK

  • v2.38.0 - Fern regeneration to match the latest API schema, including new ElevenAgents fields, updated SMB tool types, and studio agent settings.
  • v2.38.1 - Fixed CRLF parsing for the music detailed endpoint response stream.

Packages

API

Updated Endpoints

ElevenAgents

  • Create agent

    • Added enable_versioning query parameter (boolean, optional) to enable version tracking on creation
  • Update agent

    • Added enable_versioning_if_not_enabled query parameter (boolean, optional) to opt existing agents into versioning
  • List agent tests

    • Added types query parameter (string, optional) to filter tests by type
    • Deprecated include_folders query parameter
  • Submit batch call

    • Added target_concurrency_limit field (integer, optional) to set the target number of concurrent calls
  • Twilio outbound call, SIP trunk outbound call

    • Added telephony_call_config field with TelephonyCallConfig schema (default ringing_timeout_secs: 60)
  • Get conversation

    • Added environment field to conversation records
  • Get WhatsApp account, Update WhatsApp account

    • Added enable_audio_message_response field (boolean, optional)

Speech to Text

Audio Native

Studio

Schema Changes

New Schemas

  • TelephonyCallConfig - Configuration for telephony outbound calls including ringing_timeout_secs
  • GuardrailExecutionMode - Enum controlling when custom guardrail logic executes
  • StudioAgentSettingsModel - Agent settings attached to studio projects
  • StudioAgentToolSettingsModel - Tool-level settings within studio agent configuration
  • CheckServiceAvailabilityParams, CreateAssetParams, CreateClientAppointmentParams - Additional SMB tool discriminated parameter types for rental and appointment workflows

Modified Schemas

  • ClientEvent - Added guardrail_triggered enum value
  • CustomGuardrailConfig - Added execution_mode field (string, optional) and separate input/output schema definitions
  • ConversationUserResponseModel - last_contact_agent_id is now nullable and non-required
  • SMBToolConfig - Added rental and appointment operation types with corresponding parameter schemas

ElevenAgents

  • New widget configuration options: Several new settings are now available for the ElevenAgents conversation widget in the agent dashboard:

    • Collapsible widget (widget.dismissible): Allow users to minimize or dismiss the widget during a conversation.
    • Action indicator (widget.show_agent_status): Display a visual indicator when the agent is actively using tools, with distinct states for working, done, and error. Enabling this setting automatically adds agent_tool_request and agent_tool_response to the agent’s client events.
    • Conversation ID display (widget.show_conversation_id): Show the conversation ID to users after a call ends. Defaults to true for both new and existing agents.
    • Audio tag visibility (widget.strip_audio_tags): Hide audio tags from conversation transcripts. Defaults to true for both new and existing agents.
    • Syntax highlighting theme (widget.syntax_highlight_theme): Configure code block highlighting in transcripts. Accepts null (Auto), light, or dark.
  • Folder-aware agent testing: The List agent tests endpoint now supports organizing tests into folders. Added parent_folder_id, include_folders, and sort_mode query parameters for filtered listing. Test creation and update endpoints accept parent_folder_id to assign tests to folders, and test summaries now include entity type, parent folder path, and children count.

  • Workflow say node: Added a new say node type to agent workflows (WorkflowSayNodeModel). This node supports conversation_config, additional_prompt, and tool and knowledge base overrides. The node’s message payload uses a discriminated union with two variants: literal (static text via text) and prompt (LLM-generated via prompt).

  • SMB tool configuration: Formalized the SMBToolConfig schema with a required, discriminated params object. Supported operation types are create, list, search, update, and delete, each applicable to SMB entity categories including clients, staff, services, products, and assets.

  • Summary language for agents: Added summary_language field to agent configuration to specify the language for post-conversation summaries.

  • Twilio call recording: Added optional call_recording_enabled field to the Twilio outbound call request body to enable recording of outbound calls.

  • WhatsApp messaging flag: Added enable_messaging flag to WhatsApp account models and update requests to control whether messaging is enabled for a given phone number.

Pronunciation Dictionaries

  • Set all rules at once: New Set rules endpoint (POST /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/set-rules) replaces all existing rules in a pronunciation dictionary in a single call, as an alternative to incrementally adding or removing individual rules.

  • Rule matching options: Added case_sensitive (boolean) and word_boundaries (boolean) fields to pronunciation dictionary rule definitions for more precise control over how rules match text.

Music

  • Upload audio: New Upload music endpoint (POST /v1/music/upload) accepts a multipart/form-data request with an audio file. Optionally extracts a composition plan from the uploaded audio and returns a MusicUploadResponse with a song_id.

  • Phonetic name support: Added use_phonetic_names parameter to Generate music, Generate music detailed, and Stream music endpoints.

  • Song ID in responses: Music generation responses now surface the song_id field, making it easier to reference generated songs in subsequent API calls.

Audio Native

  • Update project content from URL: New Update content endpoint (POST /v1/audio-native/content) allows updating an AudioNative project by providing a URL. The endpoint extracts the content from the URL and queues it for conversion and auto-publishing.

Voices

  • Voice bookmarking: Added bookmarked field to voice update requests and is_bookmarked to voice response objects, enabling users to bookmark voices for easy access.

SDK Releases

JavaScript SDK

  • v2.37.0 - Added support for surfacing song_id in music generation responses. Updated to include latest API schema changes from Fern regeneration.

Python SDK

  • v2.37.0 - Added support for new music generation parameters and surfacing song_id in music generation responses. Updated to include latest API schema changes from Fern regeneration.

Packages

  • @elevenlabs/convai-widget-core@0.10.0 - Propagated event_id through transcript and streaming callbacks. Refactored tool status tracking from Map-based to inline transcript entries with a display-transcript utility. Added show-conversation-id config option (boolean, defaults to true) to control visibility of conversation ID in disconnection messages.
  • @elevenlabs/convai-widget-embed@0.10.0 - Propagated event_id through transcript and streaming callbacks. Refactored tool status tracking to inline transcript entries.
  • @elevenlabs/types@0.6.0 - Propagated event_id through transcript and streaming callbacks.

API

New Endpoints

  • Set pronunciation dictionary rules - POST /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/set-rules - Replace all rules in a pronunciation dictionary in a single call
  • Upload music - POST /v1/music/upload - Upload an audio file to create or reference a song, optionally extracting a composition plan
  • Update Audio Native content from URL - POST /v1/audio-native/content - Update an AudioNative project by extracting content from a provided URL and queuing for conversion

Updated Endpoints

ElevenAgents

  • List agent tests

    • Added parent_folder_id query parameter (string, optional) to filter tests by folder
    • Added include_folders query parameter (boolean, optional) to include folder objects in results
    • Added sort_mode query parameter (string, optional) to control result ordering
    • Response now includes folder metadata: entity type, parent path, and children count on UnitTestSummaryResponseModel
  • Create agent test, Update agent test

    • Added parent_folder_id field (string, optional) for assigning a test to a folder
  • Create agent, Update agent, Get agent

    • Added summary_language field (string, optional) to agent configuration for post-conversation summary language
    • Added widget.dismissible (boolean) - allow users to collapse or dismiss the widget
    • Added widget.show_agent_status (boolean) - display tool usage status indicator in widget
    • Added widget.show_conversation_id (boolean) - show conversation ID after call ends; defaults to true
    • Added widget.strip_audio_tags (boolean) - hide audio tags from transcripts; defaults to true
    • Added widget.syntax_highlight_theme (string, nullable) - code block highlighting theme (null, light, or dark)
    • Added new workflow node type say with WorkflowSayNodeModel schema, including conversation_config, additional_prompt, and tool/knowledge base overrides; message payload supports literal and prompt discriminated variants
  • Twilio outbound call

    • Added call_recording_enabled field (boolean, optional) to enable recording of outbound Twilio calls
  • Update WhatsApp account

    • Added enable_messaging field (boolean, optional) to enable or disable messaging for the account
  • Update webhook

    • Added schema_overrides field (object, optional) for customizing webhook payload schema

Pronunciation Dictionaries

Music

Voices

Schema Changes

New Schemas

  • WorkflowSayNodeModel - Workflow node for agent say operations with conversation config, prompts, and tool overrides
  • WorkflowSayNodeMessageLiteral - Literal (static text) message payload for say nodes
  • WorkflowSayNodeMessagePrompt - Prompt-based (LLM-generated) message payload for say nodes
  • MusicUploadResponse - Response model for music upload including song_id
  • SMBToolConfigCreateClientParams, SMBToolConfigListClientsParams, SMBToolConfigSearchClientsParams, SMBToolConfigUpdateClientParams, SMBToolConfigDeleteClientParams - Discriminated parameter types for SMB tool operations

Modified Schemas

  • AgentConfig - Added summary_language field
  • WidgetConfigV2 - Added dismissible, show_agent_status, show_conversation_id, strip_audio_tags, and syntax_highlight_theme fields
  • SMBToolConfig - params field is now required and uses a discriminated union
  • PronunciationDictionaryRule - Added case_sensitive and word_boundaries fields
  • CustomGuardrailConfig - model field is now optional with a default value
  • UnitTestSummaryResponseModel - Added folder metadata fields: entity type, parent path, children count

February 23, 2026

ElevenAgents

  • OAuth and advanced authentication for MCP servers: MCP servers now support workspace auth connections, enabling OAuth2 Client Credentials, Basic Auth, Bearer Auth, JWT, and custom header authentication. Select an auth connection when creating or editing an MCP server to automatically handle token refresh and authentication headers. See the MCP server documentation for more details.
  • LLM information endpoint: Added a new endpoint to list available LLMs with deprecation status, capabilities, and context limits. This enables clients to programmatically discover which models are available and which are being deprecated. See List Available LLMs for details.
  • Conversation history redaction: Added support for redacting sensitive information from conversation transcripts, audio, and analysis before being stored. Configure specific entity types to redact (such as names, email addresses, etc.) using the new conversation_history_redaction setting in agent privacy configuration. See the docs page for more details.
  • Enhanced guardrails: Introduced two new guardrail types for agents:
    • focus: Helps keep conversations on-topic
    • prompt_injection: Detects and prevents prompt injection attempts
    • Note: The alignment guardrail has been removed
  • Conversation search endpoints: Added two new endpoints for searching conversation messages:
    • Text search - Full-text and fuzzy search over transcript messages
    • Smart search - Semantic search using embeddings
  • File uploads in conversations: Added endpoints to upload and manage files within conversations:
  • New embedding model: Added support for qwen3_embedding_4b embedding model in knowledge base RAG indexing.

Workspaces

  • Image and video generation permission: Workspace administrators can now control access to image and video generation features. This new permission allows you to restrict which workspace members can use these capabilities. Configure this in your workspace settings under member permissions.

Music

  • Workspace sharing: Songs can now be shared within workspaces. The songs resource type has been added to workspace resource sharing endpoints.

SDK Releases

JavaScript SDK

  • v2.36.0 - Added overloaded convert method signatures to Speech to Text wrapper for improved type safety and ergonomics. Updated SDK to include latest API schema changes including LLM list endpoint, conversation search, and MCP auth connection support.

Python SDK

  • v2.36.1 - Added missing music generation parameters including seed, loudness, quality, and guidance_scale to ensure full feature parity with the API.
  • v2.36.0 - Renamed package references from “Conversational AI” to “ElevenAgents” to reflect the product rebrand. Updated SDK to include latest API schema changes including LLM list endpoint, conversation search, and MCP auth connection support.

Packages

API

New Endpoints

  • Text search conversation messages - GET /v1/convai/conversations/messages/text-search - Perform full-text or fuzzy search over conversation transcript messages
  • Smart search conversation messages - GET /v1/convai/conversations/messages/smart-search - Perform semantic search over conversation messages using embeddings
  • List available LLMs - GET /v1/convai/llm/list - Retrieve available LLMs with deprecation information, capabilities, and context limits
  • Upload file to conversation - POST /v1/convai/conversations/{conversation_id}/files - Upload files to a conversation context
  • Delete conversation file - DELETE /v1/convai/conversations/{conversation_id}/files/{file_id} - Remove an uploaded file from a conversation

Removed Endpoints

The following legacy voice generation endpoints have been removed:

  • GET /v1/voice-generation/generate-voice/parameters - Voice Generation Parameters
  • POST /v1/voice-generation/generate-voice - Generate A Random Voice
  • POST /v1/voice-generation/create-voice - Create A Previously Generated Voice

Use the Voice Design and Voice Remix endpoints instead.

Updated Endpoints

ElevenAgents

  • Create agent, Update agent, Get agent

    • Added coaching_settings field for agent training configuration
    • Added conversation_history_redaction in platform_settings.privacy with configurable entity types
    • Added new guardrails: focus and prompt_injection in platform_settings.guardrails
    • Removed alignment guardrail from platform_settings.guardrails
    • Added qwen3_embedding_4b as an embedding model option in RAG configuration
    • Updated numeric field descriptions for better clarity on ranges and defaults
  • Create MCP server, Update MCP server, Get MCP server

    • Added auth_connection field (optional) to enable OAuth and advanced authentication methods
    • Added secret_token field to PATCH endpoint for backward compatibility
    • Auth connection takes precedence over secret_token when both are provided
  • Create MCP tool config, Update MCP tool config, Get MCP tool config

    • Added input_overrides field - allows overriding tool input parameters with constants, dynamic variables, or LLM-generated values
  • Create RAG index, Delete RAG index

    • Added qwen3_embedding_4b to the embedding_model enum
  • Get conversations

    • Deprecated search query parameter (use the new dedicated search endpoints instead)
  • Get conversation

    • Added hiding_reason field to indicate why a conversation might be hidden
    • Extended conversation transcript entries to support file_input metadata with new ChatSourceMedium type (audio, text, image, file)
  • Simulate conversation, Simulate conversation stream

    • Updated all nested configuration fields with improved descriptions and validation ranges
  • Get agent branches, Update agent branch

    • Updated current_live_percentage field description for clarity
  • Get ElevenAgents settings, Update ElevenAgents settings

    • Updated rag_retention_period_days field with improved description

Workspaces

Music

  • Generate music, Generate music detailed, Stream music
    • Clarified seed parameter description: Random seed for music generation initialization. Providing the same seed with identical parameters helps achieve more consistent results, but exact reproducibility is not guaranteed and outputs may change across system updates. Cannot be used with prompt parameter.

Text to Voice

  • Create voice previews, Design voice, Remix voice
    • Updated loudness parameter description: Controls the volume level of the generated voice. -1 is quietest, 1 is loudest, 0 corresponds to roughly -24 LUFS
    • Updated guidance_scale parameter description: Controls how closely the AI follows the prompt. Lower numbers give the AI more freedom to be creative, while higher numbers force it to stick more to the prompt. High numbers can cause voice to sound artificial or robotic. Longer, more detailed prompts work better at lower guidance scale.
    • Updated quality parameter description for voice preview creation

Voices

  • Get voices, Get voice settings, Get default voice settings, Edit voice settings
    • Updated style parameter description: Determines the style exaggeration of the voice. Attempts to amplify the style of the original speaker. Consumes additional computational resources and might increase latency if set to anything other than 0
    • Updated speed parameter description: Adjusts the speed of the voice. 1.0 is default, values less than 1.0 slow down speech, values greater than 1.0 speed it up

ElevenAgents

  • Conversation users endpoint: Added Get conversation users endpoint (GET /v1/convai/users) to list users who have had conversations with your agents. Supports pagination and filtering by agent, time range, and other criteria.
  • Agent versioning: Fetch specific agent configurations by version using the new version_id and branch_id query parameters on the Get agent endpoint. The Update agent endpoint also now accepts a branch_id parameter for branch-specific updates.
  • Search documentation tool: Added search_documentation as a new built-in system tool for RAG (retrieval-augmented generation). Configure multi-source retrieval with MultiSourceConfigJson, SourceConfigJson, and SourceRetrievalConfig schemas. Supports configurable merging strategies via the MergingStrategy enum.
  • MCP tool support: Added mcp as a new tool type alongside webhook, client, and system tools. Configure MCP tools using the new MCPToolConfig schema in your agent tool definitions.
  • Content guardrails: Added content moderation guardrails to GuardrailsV1 with configurable thresholds for different content categories: sexual, violence, harassment, self-harm, profanity, religion/politics, and medical/legal content. Use the new ContentGuardrail and ContentConfig schemas.
  • Expressive mode: Added expressive_mode field (boolean) to agent configuration schemas to automatically prompt your agent to make the most of the new v3 conversational model.
  • Post-dial digits: Phone number transfers now support post_dial_digits for sending DTMF tones after connection. Configurable as static values or dynamic variables.
  • Agent testing types: Agent testing now supports three distinct test types with dedicated schemas: llm (response evaluation), tool (tool-call verification), and simulation (full conversation simulation). Simulation tests include simulation_scenario and simulation_max_turns configuration fields.

Pronunciation Dictionaries

  • Rules in API response: The Get pronunciation dictionary endpoint now returns a rules array containing full rule details. Response uses the new GetPronunciationDictionaryWithRulesResponseModel schema with PronunciationDictionaryAliasRuleResponseModel and PronunciationDictionaryPhonemeRuleResponseModel for rule types.

Knowledge Base

  • Folder deletion: The Delete knowledge base document endpoint now supports deleting folders in addition to documents. When deleting folders, set force=true to enable recursive deletion of all contained documents and subfolders.

SDK Releases

Python SDK

  • v2.36.0 - Added conversation users endpoint, agent versioning, search documentation tool, MCP tool support, content guardrails, and agent testing types

JavaScript SDK

  • v2.36.0 - Added overloaded convert signatures to speechToText.convert() for improved type inference based on request parameters (access .text, .transcripts, or webhook fields without manual type narrowing), added conversation users endpoint, agent versioning, search documentation tool, MCP tool support, content guardrails, and agent testing types

Widget Packages

  • @elevenlabs/convai-widget-core@0.9.0 - Added agent tool usage status display and new status badge for long-running tool calls, fixed emotion tag stripping, fixed rating and feedback submission for signed-url widget embedding
  • @elevenlabs/convai-widget-embed@0.9.0 - Added agent tool usage status display and new status badge for long-running tool calls, fixed emotion tag stripping

API

New Endpoints

Updated Endpoints

ElevenAgents

  • Get agent
    • Added version_id query parameter (string, optional) for fetching a specific agent version
    • Added branch_id query parameter (string, optional) for fetching from a specific branch
  • Update agent
    • Added branch_id query parameter (string, optional) for branch-specific updates
  • Create agent
    • Added search_documentation to system tools with multi-source RAG configuration
    • Added mcp tool type to tool discriminator
    • Added content field to GuardrailsV1 for content moderation guardrails
    • Added expressive_mode field (boolean) to agent configuration
  • Create agent test, Update agent test, Get agent test
    • Changed to discriminated union schemas with type field (llm, tool, simulation)
    • Added simulation_scenario and simulation_max_turns fields for simulation tests

Pronunciation Dictionaries

Knowledge Base

Schema Changes

New Schemas

  • GetPronunciationDictionaryWithRulesResponseModel - Response model with embedded rules array
  • PronunciationDictionaryAliasRuleResponseModel - Alias rule with string_to_replace and alias
  • PronunciationDictionaryPhonemeRuleResponseModel - Phoneme rule with string_to_replace, phoneme, and alphabet
  • MultiSourceConfigJson - Multi-source RAG configuration
  • SourceConfigJson - Individual source configuration for RAG
  • SourceRetrievalConfig - Retrieval configuration for RAG sources
  • MergingStrategy - Enum for RAG result merging strategies
  • MCPToolConfig - Configuration for MCP tools
  • ContentGuardrail-Input, ContentGuardrail-Output - Content moderation guardrail configuration
  • ContentConfig - Content category thresholds configuration
  • TestType - Enum with values llm, tool, simulation
  • CreateAgentTestResponseModel - Response for test creation
  • LLMResponseTest*, ToolCallTest*, SimulationTest* - Per-type test schemas replacing legacy Create/Get/UpdateUnitTest* models

Modified Schemas

  • GuardrailsV1-Input, GuardrailsV1-Output - Added content field for content guardrails
  • AgentConfig - Added expressive_mode field (boolean)
  • PhoneNumberTransferConfig - Added post_dial_digits field (string or dynamic variable)
  • DistributionTerritories - Relaxed items constraint to allow arbitrary territory strings

ElevenAgents, ElevenCreative and ElevenAPI

We’re moving from a single-product perception (“ElevenLabs”) to a platform-based structure with clearly defined product families:

  • ElevenAgents (Formerly Agents Platform)
  • ElevenCreative (Formerly Creative Platform)
  • ElevenAPI (New, the Developer Platform)

You’ll already see this reflected in the docs and SDK readmes.

Global servers out of beta

Global routing is now the default rather than opt-in.

Previously the default ElevenLabs API server was located in the United States, with an opt-in beta for routing traffic through the Netherlands or Singapore based servers. As of now global routing is the default, meaning that the server will automatically be chosen based on geographic proximity to optimize latency.

The opt-in base URL api-global-preview.elevenlabs.io is now deprecated, please use the default api.elevenlabs.io base URL instead. If you’re using the SDKs, this is already the default.

Text to Speech

  • TTS Normalizer v3.1: Upgraded the text normalizer to version 3.1, which includes improved accuracy and lower latency for text-to-speech conversion.

Agents Platform

  • Custom guardrails: Added support for user-defined output guardrails that allow you to create custom content filtering rules beyond standard moderation. Configure guardrails with a name, prompt instruction (up to 10,000 characters), and choice of evaluation model (gemini-2.5-flash-lite or gemini-2.0-flash). When triggered, the guardrail ends the conversation. See the Create agent API reference for configuration details.
  • WhatsApp outbound messaging: Added Send outbound message endpoint (POST /v1/convai/whatsapp/outbound-message) to initiate conversations via WhatsApp using message templates. Required fields include whatsapp_phone_number_id, whatsapp_user_id, template_name, template_language_code, template_params, and agent_id.
  • Eleven v3 conversational model: Added eleven_v3_conversational to the available TTS models for agents, providing improved voice quality and expressiveness in agent conversations.
  • Suggested audio tags: Added suggested_audio_tags field to TTS configuration for agents using v3 models. Define up to 20 tags (e.g., “happy”, “excited”) to guide expressive speech generation, with optional descriptions for when each tag should be used.
  • Tool error handling: Added tool_error_handling_mode field to webhook tool configurations with options: auto (default, determines handling based on tool type), summarized (sends LLM-generated summary), passthrough (sends raw error), or hide (does not share error with agent).
  • Dynamic variable sanitization: Added sanitize field (boolean, default false) to DynamicVariableAssignment. When enabled, the assignment value is removed from tool responses and transcripts while still being processed for variable assignment.
  • Turn model selection: Added TurnModel enum with turn_v2 and turn_v3 options for selecting the turn detection model version.
  • Workflow node transfers: Added is_workflow_node_transfer field (boolean, default false) to AgentTransfer schema for identifying transfers within workflow nodes.
  • Transfer branch metadata: Added TransferBranchInfoTrafficSplit and TransferBranchInfoDefaultingToMain schemas for tracking branch routing information in agent transfers.
  • Workflow node transition testing: Added workflow_node_transition assertion type for unit tests with UnitTestWorkflowNodeTransitionEvaluationNodeId schema to validate agent workflow transitions.

Studio

  • Muted tracks endpoint: Added Get project muted tracks endpoint (GET /v1/studio/projects/{project_id}/muted-tracks) that returns a list of chapter IDs with muted tracks in a project.

Workspaces

  • Lite member seat type: Added workspace_lite_member to the SeatType enum for workspaces with limited access permissions.
  • Content templates resource: Added content_templates to WorkspaceResourceType enum for sharing content templates within workspaces.

User Interface

  • Voice collection scrolling: Fixed an issue preventing mouse wheel and touch scrolling in the voice collection icon picker on macOS.

SDK Releases

Python SDK

  • v2.35.0 - Added custom guardrails, WhatsApp outbound messaging, tool error handling mode, dynamic variable sanitization, turn model selection, and Eleven v3 conversational model support

JavaScript SDK

  • v2.35.0 - Added custom guardrails, WhatsApp outbound messaging, tool error handling mode, dynamic variable sanitization, turn model selection, and Eleven v3 conversational model support

React and Client SDKs

API

New Endpoints

Updated Endpoints

Agents Platform

  • Create agent, Update agent, Get agent
    • Added custom field to GuardrailsV1 schema for custom guardrails configuration
    • Added alignment field to GuardrailsV1 schema for alignment guardrails
    • Added suggested_audio_tags field to TTS conversational config (array of SuggestedAudioTag, max 20 items)
    • Added eleven_v3_conversational to TTSConversationalModel enum
  • Create tool, Update tool
    • Added tool_error_handling_mode field to ApiIntegrationWebhookToolConfig (enum: auto, summarized, passthrough, hide, default auto)
    • Added sanitize field to DynamicVariableAssignment (boolean, default false)

Workspaces

Schema Changes

New Schemas

  • CustomGuardrail-Input, CustomGuardrail-Output - Container for custom guardrails configuration
  • CustomGuardrailsConfig - Config container for custom guardrails list
  • CustomGuardrailConfig - Single custom guardrail with name (string, required), prompt (string, required, max 10,000 chars), model (enum: gemini-2.5-flash-lite, gemini-2.0-flash, required), and is_enabled (boolean, default false)
  • ToolErrorHandlingMode - Enum for tool error handling: auto, summarized, passthrough, hide
  • TurnModel - Enum for turn detection model version: turn_v2, turn_v3
  • SuggestedAudioTag - Audio tag configuration with tag (string, required, max 30 chars) and description (string, optional, max 200 chars)
  • TransferBranchInfoTrafficSplit - Branch info for traffic split transfers with branch_id and traffic_percentage
  • TransferBranchInfoDefaultingToMain - Branch info for default-to-main transfers with branch_id
  • UnitTestWorkflowNodeTransitionEvaluationNodeId - Workflow node transition test configuration with agent_id and target_node_id
  • ProjectMutedTracksResponseModel - Response model with chapter_ids array
  • WhatsAppOutboundMessageResponse - Response for WhatsApp outbound message endpoint
  • WhatsAppTemplateHeaderComponentParams, WhatsAppTemplateBodyComponentParams, WhatsAppTemplateButtonComponentParams - Template parameter schemas for WhatsApp messages
  • ConversationHistoryTranscriptSystemToolResultCommonModel-Input, ConversationHistoryTranscriptSystemToolResultCommonModel-Output - Split system tool result models for input/output variants

Modified Schemas

  • GuardrailsV1-Input, GuardrailsV1-Output - Added custom (CustomGuardrail) and alignment (AlignmentGuardrail) fields
  • TTSConversationalConfig-Input, TTSConversationalConfig-Output - Added suggested_audio_tags field
  • TTSConversationalModel - Added eleven_v3_conversational enum value
  • ApiIntegrationWebhookToolConfig-Input, ApiIntegrationWebhookToolConfig-Output - Added tool_error_handling_mode field (required)
  • DynamicVariableAssignment - Added sanitize field (boolean, default false)
  • AgentTransfer - Added is_workflow_node_transfer field (boolean, default false)
  • SeatType - Added workspace_lite_member enum value
  • WorkspaceResourceType - Added content_templates enum value

Removed Schemas

  • AgentBan - Removed unused schema
  • BanReasonType - Removed unused enum
  • DubbingReleaseChannel - Removed unused enum

Eleven v3

v3 is out of alpha - it’s more stable, accurate and has lower latency. Read more about Eleven v3.

Text-to-Dialogue

  • WAV output formats: Text-to-Dialogue endpoints now support WAV output formats (wav_8000, wav_16000, wav_22050, wav_24000, wav_32000, wav_44100, wav_48000) in addition to existing MP3, PCM, OPUS, and other formats. WAV formats with 44.1kHz sample rate require a Pro tier subscription or above.

Agents Platform

  • Agent branch renaming: You can now rename agent branches using the Update branch endpoint. The new optional name field accepts 1-140 characters.
  • Alignment guardrails: Added AlignmentGuardrail type to GuardrailsV1 schema for enhanced conversation safety controls.
  • Speculative turn configuration: Added speculative_turn field to turn configuration for fine-tuning agent turn-taking behavior.
  • Procedure references: Agent patch requests now support procedure_refs for referencing reusable procedures.
  • Webhook response filtering: Added response_filter_mode and response_filters fields to webhook overrides, with new ResponseFilterMode enum for controlling which response data is passed through.
  • Error details in tool events: Added raw_error_message field to API integration webhook, system, and workflow tool event models for improved debugging.
  • Flexible tool call matching: Testing models now include check_any_tool_matches option to relax tool call matching requirements during agent testing.
  • Secrets pagination: Get workspace secrets endpoint now supports pagination with page_size (max 100) and cursor query parameters, returning next_cursor and has_more in responses.

Workspaces

  • Permission clarifications: Workspace group and invite endpoints now document specific permission requirements (group_members_manage for group member operations, WORKSPACE_MEMBERS_INVITE for workspace invitations) instead of requiring workspace administrator status.
  • New permission types: Added group_members_manage and terms_of_service_accept to the PermissionType enum.

User

  • Compliance terms visibility: Added show_compliance_terms field to user response model.

Metrics

  • ASR provider tracking: Added convai_asr_provider field to metrics for tracking automatic speech recognition provider usage.

SDK Releases

Python SDK

  • v2.34.0 - Added WAV output formats for Text-to-Dialogue, webhook response filtering, agent branch renaming, secrets pagination, and speculative turn configuration
  • v2.33.1 - Fixed bug with URL streaming in Scribe
  • v2.33.0 - Fixed bug with agent initialization and user_id handling, added audio alignment callback for agent conversations

JavaScript SDK

  • v2.34.0 - Added WAV output formats for Text-to-Dialogue, webhook response filtering, agent branch renaming, secrets pagination, and speculative turn configuration

React and Client SDKs

Widget Packages

API

Updated Endpoints

Text-to-Dialogue

  • Text to Dialogue, Text to Dialogue with timestamps
    • Added WAV output formats to output_format parameter: wav_8000, wav_16000, wav_22050, wav_24000, wav_32000, wav_44100, wav_48000
    • Updated description to clarify that WAV formats with 44.1kHz sample rate require Pro tier subscription
    • Added NonStreamingOutputFormats schema reference for non-streaming endpoints

Agents Platform

  • Update agent branch
    • Added optional name field (string, 1-140 characters, nullable) for renaming branches
  • Get workspace secrets
    • Added page_size query parameter (integer, optional, max 100) for pagination
    • Added cursor query parameter (string, optional) for fetching next page
    • Response now includes next_cursor (string) and has_more (boolean) fields
  • Create agent, Update agent
    • Added speculative_turn field to turn configuration
    • Added procedure_refs field to agent patch schema
    • Added AlignmentGuardrail to GuardrailsV1 schema
    • Added response_filter_mode and response_filters to webhook overrides
  • Create agent test, Update agent test
    • Added check_any_tool_matches field (boolean, optional) for relaxed tool call matching

Workspaces

User

  • Get user info
    • Added show_compliance_terms field (boolean) to response

Schema Changes

New Schemas

  • NonStreamingOutputFormats - Enum for non-streaming audio output formats including WAV variants
  • ResponseFilterMode - Enum for webhook response filtering modes
  • AlignmentGuardrail - Configuration for alignment-based conversation guardrails

Modified Schemas

  • SongMetadata - Removed bpm and time_signature fields
  • PermissionType - Added group_members_manage and terms_of_service_accept enum values
  • TurnConfig - Added speculative_turn field
  • GetWorkspaceSecretsResponseModel - Added next_cursor and has_more pagination fields
  • UserResponseModel - Added show_compliance_terms field
  • WebhookToolApiConfigOutput - Added response_filter_mode and response_filters fields
  • AgentTestingCriteriaEvaluateToolCall - Added check_any_tool_matches field
  • Multiple tool event models (ApiIntegrationWebhookToolEventModel, SystemToolEventModel, WorkflowToolEventModel) - Added raw_error_message field

Agents Platform

  • Agent branching and deployments: Added a complete version control system for agents, enabling teams to create branches, iterate on agent configurations in isolation, and merge changes when ready. New endpoints include POST /v1/convai/agents/{agent_id}/branches for creating branches, POST /v1/convai/agents/{agent_id}/branches/{source_branch_id}/merge for merging, and POST /v1/convai/agents/{agent_id}/deployments for creating deployments. Drafts can also be created and deleted via the new drafts endpoints. See the Branches and Deployments documentation for details.
  • WhatsApp account management: Added PATCH and DELETE endpoints for WhatsApp Business accounts, allowing you to update and remove connected WhatsApp accounts from agents.
  • Conversation agent name: The Get conversation endpoint now returns agent_name in the response for easier identification of which agent handled a conversation.
  • Error type tracking: Added error_type field to conversation event models for improved debugging and error categorization.

Knowledge Base

  • Folder management: Added support for organizing knowledge base documents into folders. New endpoints include Create folder for creating folders, Move document for moving single documents, and Bulk move for moving multiple documents at once.

Tools

  • Enhanced tools listing: The Get tools endpoint now supports filtering and pagination with new query parameters including search, page_size, types, sort_by, sort_direction, and cursor. Response now includes next_cursor and has_more fields for pagination.

Music

  • Song metadata enhancements: Added bpm and time_signature fields to song metadata for richer audio analysis information.

Studio

  • Caption style templates: Added caption_style_template_overrides field to project models, allowing customization of caption styling per template.
  • Video dubbing project type: Added dub_video to the project creation type enum.
  • Publishing metadata: Added last_updated_from_project_unix timestamp to publishing and project metadata.

Workspaces

  • Seat type management: Introduced new SeatType enum with seat_type and workspace_seat_type fields, deprecating the previous workspace_permission and workspace_role fields.
  • Workspace analytics permission: Added workspace_analytics_full_read to the PermissionType enum for granular analytics access control.

SDK Releases

Python SDK

  • v2.32.0 - Added agent branching, deployments, and drafts endpoints, knowledge base folder management, enhanced tools listing with filtering and pagination, and seat type management

JavaScript SDK

  • v2.33.0 - Added agent branching, deployments, and drafts endpoints, knowledge base folder management, enhanced tools listing with filtering and pagination, and seat type management

API

New Endpoints

  • List agent branches - GET /v1/convai/agents/{agent_id}/branches - List all branches for an agent
  • Create agent branch - POST /v1/convai/agents/{agent_id}/branches - Create a new branch for an agent
  • Get agent branch - GET /v1/convai/agents/{agent_id}/branches/{branch_id} - Get a specific branch
  • Update agent branch - PATCH /v1/convai/agents/{agent_id}/branches/{branch_id} - Update branch configuration
  • Merge agent branch - POST /v1/convai/agents/{agent_id}/branches/{source_branch_id}/merge - Merge a branch into a target branch
  • Create deployment - POST /v1/convai/agents/{agent_id}/deployments - Create or update agent deployments
  • Create draft - POST /v1/convai/agents/{agent_id}/drafts - Create an agent draft
  • Delete draft - DELETE /v1/convai/agents/{agent_id}/drafts - Delete an agent draft
  • Create folder - POST /v1/convai/knowledge-base/folder - Create a folder for grouping documents
  • Move document - POST /v1/convai/knowledge-base/{document_id}/move - Move a document to a folder
  • Bulk move - POST /v1/convai/knowledge-base/bulk-move - Move multiple documents to a folder

Updated Endpoints

Agents Platform

  • Get tools
    • Added search query parameter (string, optional) for filtering tools by name prefix
    • Added page_size query parameter (integer, optional, max 100, default 30)
    • Added show_only_owned_documents query parameter (boolean, optional, default false)
    • Added types query parameter (array, optional) for filtering by tool type
    • Added sort_by query parameter (enum, optional) for sorting results
    • Added sort_direction query parameter (enum, optional) for sort order
    • Added cursor query parameter (string, optional) for pagination
    • Response now includes next_cursor (string) and has_more (boolean, required) fields
  • Create agent
    • Request schema updated with branching support
  • Get conversation
    • Added agent_name (string, optional) to response model
  • Create agent draft
    • Made tags field optional and removed from required fields

Pronunciation Dictionaries

  • Add rules
    • Updated description to clarify that rules with duplicate string_to_replace values will be replaced

Workspaces

Studio

  • Create project
    • Added create_publishing_read (boolean, optional) field
    • Added dub_video to project type enum
  • Get project, Update project
    • Added caption_style_template_overrides (object, optional) for custom caption styling

Schema Changes

New Schemas

  • AgentBranch, AgentBranchInput, AgentBranchOutput - Branch configuration for agents
  • AgentDeployment, AgentDeploymentInput - Deployment configuration for agents
  • AgentVersion - Agent version information
  • BranchProtectionStatus - Branch protection settings
  • SeatType - Enum for workspace seat types
  • ToolSortBy - Enum for tools sorting options
  • ToolTypeFilter - Enum for filtering tools by type
  • CaptionStyleModel - Caption style configuration

Modified Schemas

  • ToolsResponseModel - Added next_cursor and has_more fields for pagination
  • SongMetadata - Added bpm (number) and time_signature (string) fields
  • GetConversationResponseModel - Added agent_name field
  • PermissionType - Added workspace_analytics_full_read enum value
  • ProjectCreationType - Added dub_video enum value
  • Multiple event models - Added error_type field for error categorization