Changelog

New endpoints

ElevenAgents

• Create a merge proposal - POST /v1/convai/agents/{agent_id}/merge-proposals - Create a proposal with required source_branch_id, target_branch_id and title fields, plus an optional description, reviewer IDs and triage ticket ID.
• List merge proposals - GET /v1/convai/agents/{agent_id}/merge-proposals - List proposals with status, source branch, target branch and text filters, plus cursor pagination.
• Get a merge proposal - GET /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id} - Retrieve a proposal and its review, comment and outcome details.
• Update a merge proposal - PATCH /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id} - Update its title, description or requested reviewers, or close it without merging.
• Review a merge proposal - POST /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/reviews - Submit an approved or changes_requested decision with an optional comment.
• Comment on a merge proposal - POST /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/comments - Add a Markdown comment of up to 4,096 characters.
• Merge a merge proposal - POST /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/merge - Merge the source branch and optionally control forced conflict resolution and source branch archival.
• List agent deployments - GET /v1/convai/agents/{agent_id}/deployments - List current and historical branch traffic splits with page-based pagination.
• Cancel a test invocation - POST /v1/convai/test-invocations/{test_invocation_id}/cancel - Cancel a running test invocation.

Speech Engine

• Duplicate a Speech Engine - POST /v1/speech-engine/{speech_engine_id}/duplicate - Duplicate a Speech Engine and optionally assign the copy a new name.

Updated endpoints

ElevenAgents

• Create agent, Get agent and Update agent
  • Added gpt-6.1-sol and claude-sonnet-5-5 to the LLM enum.
  • Added eleven_v4 and eleven_v4_turbo to the conversational TTS model options. The default changed from eleven_flash_v2 to eleven_v4_turbo.
  • Agent transfers and standalone workflow agent nodes add optional preserve_voice_settings (boolean, default false) to retain the base voice, TTS model and voice settings after a transfer.
  • Skip-turn tool configurations add optional wait_timeout_secs (number, default -1). A value of -1 keeps the agent silent until the caller speaks.
  • Post-call webhook configurations add optional exclude_transcript (boolean, default false) to omit turn-by-turn transcripts from JSON transcription webhooks.
  • Conversation history redaction configurations add optional excluded_data_collection_ids (string array, maximum 50) to preserve selected extracted values while redacting their rationales.
  • Client tool response_timeout_secs now accepts -1 to wait indefinitely when expects_response is enabled.
• List tickets
  • Added optional priorities (array) with low, medium, high and urgent values.
  • Added sort_by with created_at and priority values; the default is created_at.
  • Ticket responses now require title, nullable priority, and a priority_changes array. Ticket creation and update requests can set priority, and ticket status adds cancelled.
• List tools - Added optional nullable used_by_agent_id (string) to return tools referenced by an agent’s main branch.
• Export batch call results - Added optional nullable limit (integer, minimum 1) to export only the first recipients as a column preview.
• List test invocations and Get test invocation
  • Test invocation summaries add required cancelled_count (integer) and optional cancelled (boolean, default false).
  • Test run status adds cancelled.
• Get conversation details - Transcript entries add optional nullable platform_event with user_turn_timeout and skip_turn_wait_elapsed values.
• Get agent version metadata - Added optional nullable merged_authors, an array describing the people who published changes merged into the main branch.
• Get crawl job - Removed the deprecated max_depth response field.

New endpoints

Flows

• List templates - GET /v1/flows/templates - List published templates and their runnable versions.
• Get template - GET /v1/flows/templates/{template_id} - Retrieve a template and its runnable versions.
• Create template run - POST /v1/flows/templates/{template_id}/runs - Start a template run with input values, an optional version and an optional webhook.
• List template runs - GET /v1/flows/templates/{template_id}/runs - List template runs with cursor pagination and optional version filtering.
• Get template run - GET /v1/flows/templates/{template_id}/runs/{run_id} - Retrieve a template run and its output status.

Updated endpoints

Speech to Text

• Convert speech to text - POST /v1/speech-to-text
  • Added optional nullable transcript_edit (string), which accepts a natural-language edit instruction of up to 2,000 characters.
  • Responses add optional nullable edited_transcript. A successful edit contains required kind: "transcript" and text fields. A failed edit contains required kind: "error", error_type: "edit_failed" and message fields.
• Realtime Speech to Text accepts transcript_edit (string) and emits edited_transcript events with required text and edited_text fields.

ElevenAgents

• Create agent, Get agent and Update agent
  • Added gpt-6-sol, gpt-6-luna, glm-52, deepseek-v41-flash, claude-opus-5 and claude-opus-5-5 to the LLM enum.
  • Alerting monitors add optional nullable enabled (boolean) to control whether a monitor can send notifications.
• List conversations and Text search
  • data_collection_params and dynamic_variable_params add neq and in operators. Values for in use a pipe delimiter.
  • evaluation_params accepts success, failure or unknown as the result value.
• Smart search - GET /v1/convai/conversations/messages/smart-search
  • Added optional nullable branch_id (string).
• List test invocations - GET /v1/convai/test-invocations
  • Added optional nullable branch_id (string).
  • Test invocation summaries add optional nullable credits_used (integer) and total_price (number).
• Get test invocation - GET /v1/convai/test-invocations/{test_invocation_id}
  • Individual test runs add optional nullable credits_used (integer) and charging (ConversationChargingCommonModel).
• Simulate conversation and Simulate conversation stream
  • Changed the optional new_turns_limit default from 10,000 to 100 and set its maximum to 100.
• Create crawl job and Get crawl job
  • Added optional auto_discover (boolean, default false) to follow links and add newly discovered pages during auto-sync. This requires enable_auto_sync: true.
• Refresh knowledge base document - POST /v1/convai/knowledge-base/{documentation_id}/refresh
  • AutoSyncInfo adds optional auto_discover (boolean, default false) to indicate whether refreshes crawl and add newly discovered pages.
• List MCP server tools - GET /v1/convai/mcp-servers/{mcp_server_id}/tools
  • Responses add optional tool_approval_statuses (array). Each item contains required tool_id (string) and state (up_to_date, needs_review or not_approved), with optional approval policy and approved-definition fields.

Text to Dialogue

• Convert text to dialogue, Stream text to dialogue, Convert with timestamps and Stream with timestamps
  • Added optional use_pvc_as_ivc (boolean, default false) to use the Instant Voice Clone version of a Professional Voice Clone.
  • Added optional nullable previous_text and future_text (strings, maximum 100 characters) and previous_request_ids and next_request_ids (string arrays, maximum 3 IDs) for generation continuity.
  • The optional settings object adds nullable similarity (number, 0–1, default 0.75).

Text to Speech

• Convert text to speech, Stream text to speech, Convert with timestamps and Stream with timestamps
  • The existing use_pvc_as_ivc field is no longer deprecated.

Flows

• Create image generation, Create video generation and Create template run
  • Webhook targets now require an explicit type discriminator (all or ids). The previous defaults were removed.

Voice Design

• Create voice from preview, Create voice previews, Design a voice and Remix a voice
  • Added a 409 response when a generation for the preview is already in progress. Retry the request after receiving this response.

Workspaces

• Create service account API key - POST /v1/service-accounts/{service_account_user_id}/api-keys
  • Added optional nullable tts_concurrency_limit, music_concurrency_limit and dubbing_concurrency_limit (integers) for enterprise service account API keys.
• Update service account API key - PATCH /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}
  • Added optional tts_concurrency_limit, music_concurrency_limit and dubbing_concurrency_limit. Each field accepts an integer, clear, no_update or null and defaults to no_update.

Models

• List models - GET /v1/models
  • Deprecated required max_characters_request_free_user and max_characters_request_subscribed_user. These fields are not enforced; use maximum_text_length_per_request instead.

New endpoints

ElevenAgents

• List phone numbers page - GET /v1/convai/v2/phone-numbers
  • Added optional page_size (integer, 1–1,000, default 100) and cursor (nullable string) pagination parameters.
  • Added optional search, label, phone_number, provider, supports_outbound, agent_id, branch_id, sort_by and sort_direction filters. sort_by accepts label or phone_number; sort_direction defaults to asc.
  • The response contains required phone_numbers (array), optional nullable next_cursor (string) and has_more (boolean, default false).

Updated endpoints

ElevenAgents

• Create agent, Get agent and Update agent
  • Prompt configuration adds enable_parallel_tool_calls (boolean, default true). Workflow overrides accept a nullable boolean.
  • The LLM enum adds gpt-6-astra, including conversation initiation overrides.
  • Alerting integration notifiers now use integration_type to select pagerduty or slack. Slack notifiers require connection_id and channel_id (strings); channel_id accepts 1–64 characters.
• List conversations and Resolve conversation reference
  • data_collection_params no longer accepts the missing operator. Use an empty value to match conversations where the field was not collected.
  • An empty value in dynamic_variable_params matches conversations where the variable was not set.
• Create Speech Engine, Get Speech Engine and Update Speech Engine
  • Added cascade_timeout_seconds (number, 2–15). Create requests default to 4, update requests accept a nullable value and responses require the field.

Image and video

• Create image generation - POST /v1/flows/image
  • Added request variants for gpt-image-2.5-flare and gpt-image-2.5-sunburst.
  • Both variants require prompt and model_id, accept up to 10 images, and add resolution (1K, 2K or 4K, default 1K).
  • quality accepts low, medium, high, xhigh or max and defaults to high. aspect_ratio accepts auto and 14 fixed ratios and defaults to 16:9.

Dubbing

• Create dubbing project - POST /v1/dubbing/project
  • Multipart keyterms accepts repeated fields or a single JSON array.
  • Multipart webhook_ids accepts repeated fields, a single JSON array or a comma-separated string.
• Get workspace resource, Share workspace resource and Unshare workspace resource
  • WorkspaceResourceType adds dubbing_project.

Knowledge base

• Create crawl job - POST /v1/convai/knowledge-base/crawl
  • Deprecated max_depth (integer, default 3). The field is now a no-op and no longer has minimum or maximum constraints.
  • Crawl job metadata no longer requires max_depth.

User

• Get user and Get subscription
  • Currency enums add gbp.

Schema changes

Text to Speech

• Multi-context WebSocket audio and final messages now define is_final_audio_for_turn as occurring after all buffered bytes for the turn have been delivered.

New endpoints

ElevenAgents

• Upload agent hold audio - POST /v1/convai/agents/{agent_id}/hold-audio
  • Accepts required hold_audio_file (binary) as multipart form data. The file must be MP3 or WAV, up to 40 MB and 180 seconds.
  • Returns required agent_id (string) and hold_audio (AgentHoldAudioConfig). The hold-audio object requires audio_path, audio_url, original_filename (strings), duration_secs (number) and size_bytes (integer).
• Delete agent hold audio - DELETE /v1/convai/agents/{agent_id}/hold-audio
  • Removes the custom clip so queued callers hear the default hold tone.
  • Returns required agent_id (string).

Updated endpoints

ElevenAgents

• Create agent, Get agent and Update agent
  • Added optional platform_settings.queueing_config (AgentQueueingConfig) with enabled (boolean, default false) and wait_timeout_seconds (integer, 1–1,800, default 180).
  • Queue configuration responses include read-only nullable hold_audio (AgentHoldAudioConfig). Agent responses also include optional default_hold_audio_url (string).
• Get conversation - GET /v1/convai/conversations/{conversation_id}
  • Metadata adds optional nullable queue_wait_secs (number). Queue time is excluded from call_duration_secs and billed time.
• Create agent branch - POST /v1/convai/agents/{agent_id}/branches
  • Added optional include_draft (boolean, default false). When true, a branch created from the branch tip includes the caller’s draft procedure set.
• List procedures and procedure create, get and draft endpoints
  • List items add optional referenced_tool_ids, referenced_kb_ids, referenced_procedure_ids and referenced_dynamic_variables (string arrays).
  • Agent and merge-preview responses add optional procedures, a map keyed by procedure ID.
• List test invocations - GET /v1/convai/test-invocations
  • Added optional nullable search (string) to filter tests and folders by name.
• Run tests on agent and Get test invocation
  • Test suite invocation and unit test run responses add optional nullable version_id (string) and optional ran_against_draft (boolean, default false).
  • Invocation summaries also add optional runs_diverged_from_version (boolean, default false).
• POST /v1/convai/agents/{agent_id}/knowledge-base/rag-query
  • The request body adds optional nullable max_documents_length (integer, 1–50,000) and max_retrieved_rag_chunks_count (integer, 1–20) query-specific overrides.
• Get WhatsApp account - GET /v1/convai/whatsapp-accounts/{phone_number_id}
  • Added optional account_type (WhatsAppAccountType, default cloud_api). Values are cloud_api and coexistence.
• Calculate expected LLM usage - POST /v1/convai/agent/{agent_id}/llm-usage/calculate
  • LLMUsageCalculatorLLMResponseModel adds required price_per_message (number).

Music

• MusicModelID adds music_v2_5 for POST /v1/music/video-to-music, POST /v1/music/plan, Compose music, POST /v1/music/detailed, POST /v1/music/detailed/stream, POST /v1/music/stream, POST /v1/music/upload and POST /v1/music/finetunes.
• GenerationChunk.text increases maxLength from 6,000 to 6,132 characters for POST /v1/music/plan, POST /v1/music, POST /v1/music/detailed, POST /v1/music/detailed/stream, POST /v1/music/stream and POST /v1/music/upload. Section names can contain 1–100 characters, and chunks can contain up to 30 lines with 200 characters per line.

Schema changes

ElevenAgents

• Real-time server events add queue_status. Its required queue_status_event.status accepts waiting, admitted or timed_out; timed_out precedes WebSocket close code 4300. Hold audio continues to arrive as regular audio events.
• The LLM enum adds gemini-3.8-flash, including conversation initiation overrides.
• Conversation system tool result unions add start_procedure_success, start_procedure_error, end_procedure_success and end_procedure_error.
• FeaturesUsageCommonModel adds optional freeform_procedure and structured_procedure feature statuses.

New endpoints

ElevenAgents

• List workspace tickets - GET /v1/convai/triage-tickets
  • Lists conversation triage tickets across every agent the caller can access, ordered by most recently created first.
  • Added optional page_size (integer, 1–100, default 100), status (AgentConversationTicketStatus), assignee_user_id (string or unassigned) and cursor (string) query parameters.
  • Returns GetAgentConversationTicketsPageResponseModel.

Updated endpoints

ElevenAgents

• List conversations - GET /v1/convai/conversations
  • Added optional nullable dynamic_variable_params (repeatable string array). Each value uses name:op:value, where op is eq, gt, gte, lt or lte.
• Text search conversation messages - GET /v1/convai/conversations/messages/text-search
  • Added optional nullable dynamic_variable_params (repeatable string array) with the same syntax.
• Twilio outbound call, SIP trunk outbound call, Exotel outbound call and Submit batch calling
  • telephony_call_config now uses separate input and output schemas.
  • Added optional nullable twilio_machine_detection (TwilioMachineDetectionConfig). Its mode accepts enable or detect_message_end and defaults to enable. The setting is ignored for non-Twilio providers and inbound calls.
• Import phone number - POST /v1/convai/phone-numbers
  • Added optional nullable account_auth_token (string) for Twilio API key imports to validate inbound webhook signatures.

Schema changes

ElevenAgents

• WebhookEventType adds answering_machine_detection.
• AgentBranchSummary adds optional nullable draft_created_at (integer) and optional draft_is_behind_tip (boolean, default false).
• AgentKnowledgeBaseRagChunkResponseModel adds required nullable source_url (string).
• AgentSummaryResponseModel and SpeechEngineSummaryResponse add required voice_id (string).
• AnalysisProperty adds optional nullable name (string) and allowed_values (AllowedValues). LiteralJsonSchemaProperty also adds allowed_values. Both deprecate allowed_values_dynamic_variable.
• DataCollectionResultCommonModel adds optional nullable name (string).
• WorkspaceApiKeyResponseModel adds optional nullable platform_limits (PlatformLimits).
• MCP tool Icon adds optional nullable theme (light or dark).
• SMBToolConfig adds send_custom_email, create_service_quote_request and create_product_quote_request parameter variants.
• Webhook query parameter schemas and telephony call configuration now use separate input and output models.
• agent_response WebSocket events add optional attachments (array). Each item requires url and name (strings) and accepts optional mime_type (string).

ElevenCreative

• ReferenceVideo.studio_clip now uses StudioClipLocator instead of StudioClipReference. The fields and wire format are unchanged.

Updated endpoints

ElevenAgents

• List agents - GET /v1/convai/agents
  • Added optional nullable tags (string array). Repeat the query parameter to match any supplied tag.
• Create agent, Get agent and Update agent
  • Added optional nullable conversation_config.conversation.dtmf_input_settings (DTMFInputConfig). It supports dtmf_input_timeout (number, 0.5–10 seconds, default 2), hash_terminator (boolean, default true) and redact_input (boolean, default false).
  • Added optional sip_refer_play_dialtone (boolean, default true) to phone-number transfer configuration. Set it to false to keep the original call leg silent while a SIP REFER transfer completes.
  • Start- and end-procedure system tools now accept either a ProcedureVersionRef or a ProcedureDraftRef. Draft references require procedure_id (string) and set version_id to null.
• Get conversation - GET /v1/convai/conversations/{conversation_id}
  • Added file_inputs (array of ConversationHistoryTranscriptFileInputResponseModel) to transcript entries. Each item requires file_id, original_filename, mime_type and file_url (strings).
  • Added optional nullable campaign (BatchCallingCampaignInformation) to batch-call metadata. The object requires campaign_id and campaign_lead_id (strings).
  • Added dtmf to ChatSourceMedium.
• Conversation triage ticket issue types add incorrect_information, documentation_gap, platform_bug and wrong_action.

Music

• Generate music detailed (POST /v1/music/detailed) and Stream music with details (POST /v1/music/detailed/stream)
  • Added optional with_waveform_visual (boolean, default false).
  • Detailed responses add nullable waveform_visual (integer array), sampled four times per second from -1000 to 1000.
• Upload music - POST /v1/music/upload
  • Added optional with_waveform_visual (boolean, default false) and nullable waveform_visual (integer array) in the response.

ElevenCreative

• Create Studio project and Create podcast
  • quality_preset now accepts null, and its standard schema default was removed.

Dubbing

• List Dubbing projects - GET /v1/dubbing/project
  • page_size remains an optional integer with default 20, but values are now clamped to 1–100 instead of rejected.
  • The status filter now documents queued, preparing, ready and failed.
  • Pass the preceding response’s next_cursor in cursor; omit it for the first page.
• List language targets - GET /v1/dubbing/project/{project_id}/language
  • page_size remains an optional integer with default 20, but values are now clamped to 1–100 instead of rejected.
  • The status filter supports queued, processing, completed, stale and failed.
  • Pass the preceding response’s next_cursor in cursor; omit it for the first page.

Schema changes

Workspace

• PendingSubscriptionSwitchResponseModel.next_tier adds grant.

New Endpoints

ElevenAgents

• Added nine conversation triage ticket endpoints:
  • Create conversation ticket - POST /v1/convai/triage-tickets. The request requires conversation_id (string) and accepts qa_comment (nullable string, 1–10,000 characters) and up to 200 turn comments.
  • List tickets - GET /v1/convai/agents/{agent_id}/triage-tickets, with cursor pagination.
  • Create manual ticket - POST /v1/convai/agents/{agent_id}/triage-tickets. The request requires qa_comment (string, 1–10,000 characters).
  • List assignable users - GET /v1/convai/agents/{agent_id}/triage-tickets/assignable-users. The response lists non-service-account workspace members and whether each member has access to the agent.
  • Get ticket - GET /v1/convai/triage-tickets/{agentqa_ticket_id}.
  • Update ticket - PATCH /v1/convai/triage-tickets/{agentqa_ticket_id}. The request accepts optional status and nullable assignee_user_id.
  • Delete ticket - DELETE /v1/convai/triage-tickets/{agentqa_ticket_id}.
  • Add comment - POST /v1/convai/triage-tickets/{agentqa_ticket_id}/comments. The request requires comment (string, 1–10,000 characters).
  • Add turn comment - POST /v1/convai/triage-tickets/{agentqa_ticket_id}/turn-comments. The request requires zero-based turn_index (integer) and comment (string, 1–10,000 characters).

Updated Endpoints

ElevenAgents

• Get signed URL - GET /v1/convai/conversation/get-signed-url
  • Added optional debug_events_request (boolean, default false). Debug events require editor access to the agent.
• Get WebRTC token - GET /v1/convai/conversation/token
  • Added optional debug_events_request (boolean, default false). The legacy GET /v1/convai/conversation/get_signed_url route accepts the same parameter.
• List conversations - GET /v1/convai/conversations
  • Added optional triggered_procedure_ids (nullable string array, maximum 50) to match conversations where any specified procedure ran.
  • Added optional include_invalid_tool_calls (boolean, default false) to include tool calls that did not run.
  • Added optional sort_direction (asc or desc, default desc) for call start time.
• Text search conversation messages - GET /v1/convai/conversations/messages/text-search
  • Added optional triggered_procedure_ids (nullable string array, maximum 50).
  • Added optional include_invalid_tool_calls (boolean, default false).
• Get agent conversation topics - GET /v1/convai/agents/{agent_id}/topics
  • Added optional include_evaluation_criteria (boolean, default true).
  • Added frustration to sort_by.
  • Topic responses add nullable success_rate (number), while the overall response adds aggregated_run_count (integer, default 0).
  • from_unix_secs is floored to the start of its UTC day. A bounded range aggregates completed daily discovery runs; omitting both bounds returns the latest run.
• List procedures (GET /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures) and Get procedure (GET /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id})
  • Added optional nullable agent_version_id (string) to retrieve procedures from a specific agent version.
• Create test and Update test
  • Added optional nullable environment (string) to response, simulation and tool-call unit test schemas. The value selects environment-specific URLs, headers and auth connections; it defaults to production.
• Create URL document, Create crawl job and Create folder
  • Added optional nullable minimum_frequency_days (integer, 1–180) for auto-sync. The default is 7, and a stricter parent-folder frequency takes precedence.

Music

• List Music Finetunes - GET /v1/music/finetunes
  • Increased the maximum page_size from 100 to 150. The default remains 50.

Schema Changes

ElevenAgents

• Agent update requests add optional nullable procedures (object<string, ProcedureVersionRef>). Each value requires procedure_id and version_id (strings). An empty object removes all procedures.
• Conversation initiation configuration adds enable_procedure_ids_from_client (boolean, default false). Initiation data adds optional nullable procedure_ids (string array); an empty array disables all procedures for the starting agent.
• ClientEvent adds context_usage.
• Soft-timeout overrides add optional nullable additional_soft_timeout_messages (string array).
• Constant values in analysis and schema override models now accept null.
• Widget configuration defaults for mic_muting_enabled and transcript_enabled changed from false to true. Set them explicitly to false to preserve the previous behavior.

Workspace

• Get user responses removed xi_api_key from UserResponseModel.
• ResourceMetadataResponseModel.role_to_group_ids now accepts custom role IDs as keys instead of restricting keys to admin, editor, commenter and viewer.
• Direct publishing responses add optional nullable restricted_to_user_email_domains (string array).
• Pending subscription switch responses add go to next_tier.