{"files":{"SKILL.md":"---\nname: elevenlabs-api-documentation\ndescription: \"ElevenLabs API Documentation API skill. Use when working with ElevenLabs API Documentation for history, sound-generation, audio-isolation. Covers 547 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# ElevenLabs API Documentation\nAPI version: 1.0\n\n## Auth\nApiKey xi-api-key in header\n\n## Base URL\nNot specified.\n\n## Setup\n1. Set your API key in the appropriate header\n2. GET /v1/history -- verify access\n3. POST /v1/history/download -- create first download\n\n## Endpoints\n\n547 endpoints across 33 groups. See references/api-spec.lap for full details.\n\n### history\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/history | List Generated Items |\n| GET | /v1/history/{history_item_id} | Get History Item |\n| DELETE | /v1/history/{history_item_id} | Delete History Item |\n| GET | /v1/history/{history_item_id}/audio | Get Audio From History Item |\n| POST | /v1/history/download | Download History Items |\n\n### sound-generation\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/sound-generation | Sound Generation |\n\n### audio-isolation\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/audio-isolation | Audio Isolation |\n| GET | /v1/audio-isolation/history | Get Audio Isolation History |\n| DELETE | /v1/audio-isolation/history/{history_item_id} | Delete Audio Isolation History Item |\n| POST | /v1/audio-isolation/stream | Audio Isolation Stream |\n\n### audio-effects\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/audio-effects/catalog | Get Audio Effects Catalog |\n\n### voices\n| Method | Path | Description |\n|--------|------|-------------|\n| DELETE | /v1/voices/{voice_id}/samples/{sample_id} | Delete Sample |\n| GET | /v1/voices/{voice_id}/samples/{sample_id}/audio | Get Audio From Sample |\n| GET | /v1/voices/collections | List Voice Collections |\n| POST | /v1/voices/collections | Create Voice Collection |\n| GET | /v1/voices/collections/{collection_id} | Get Voice Collection |\n| PATCH | /v1/voices/collections/{collection_id} | Update Voice Collection |\n| DELETE | /v1/voices/collections/{collection_id} | Delete Voice Collection |\n| POST | /v1/voices/collections/{collection_id}/voice/{voice_id} | Add Voice To Collection |\n| DELETE | /v1/voices/collections/{collection_id}/voice/{voice_id} | Remove Voice From Collection |\n| GET | /v1/voices/settings/default | Get Default Voice Settings. |\n| GET | /v1/voices/{voice_id}/settings | Get Voice Settings |\n| POST | /v1/voices/{voice_id}/settings/edit | Edit Voice Settings |\n| GET | /v1/voices/accents | Get Voice Accents |\n| GET | /v1/voices | List Voices |\n| GET | /v1/voices/{voice_id} | Get Voice |\n| DELETE | /v1/voices/{voice_id} | Delete Voice |\n| POST | /v1/voices/{voice_id}/edit | Edit Voice |\n| GET | /v2/voices | Get Voices V2 |\n| POST | /v1/voices/{voice_id}/replicate-to-isolated-environment | Replicate Voice To Isolated Environment |\n| POST | /v1/voices/add | Add Voice |\n| POST | /v1/voices/add/{public_user_id}/{voice_id} | Add Shared Voice |\n| POST | /v1/voices/pvc | Create Pvc Voice |\n| POST | /v1/voices/pvc/{voice_id} | Edit Pvc Voice |\n| POST | /v1/voices/pvc/{voice_id}/samples | Add Samples To Pvc Voice |\n| POST | /v1/voices/pvc/{voice_id}/samples/{sample_id} | Update Pvc Voice Sample |\n| DELETE | /v1/voices/pvc/{voice_id}/samples/{sample_id} | Delete Pvc Voice Sample |\n| GET | /v1/voices/pvc/{voice_id}/samples/{sample_id}/audio | Retrieve Voice Sample Audio |\n| GET | /v1/voices/pvc/{voice_id}/samples/{sample_id}/waveform | Retrieve Voice Sample Visual Waveform |\n| GET | /v1/voices/pvc/{voice_id}/samples/{sample_id}/speakers | Retrieve Speaker Separation Status |\n| POST | /v1/voices/pvc/{voice_id}/samples/{sample_id}/separate-speakers | Start Speaker Separation |\n| GET | /v1/voices/pvc/{voice_id}/samples/{sample_id}/speakers/{speaker_id}/audio | Retrieve Separated Speaker Audio |\n| GET | /v1/voices/pvc/{voice_id}/captcha | Get Pvc Voice Captcha |\n| POST | /v1/voices/pvc/{voice_id}/captcha | Verify Pvc Voice Captcha |\n| POST | /v1/voices/pvc/{voice_id}/train | Run Pvc Training |\n| POST | /v1/voices/pvc/{voice_id}/verification | Request Manual Verification |\n\n### text-to-speech\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/text-to-speech/{voice_id} | Text To Speech |\n| POST | /v1/text-to-speech/{voice_id}/with-timestamps | Text To Speech With Timestamps |\n| POST | /v1/text-to-speech/{voice_id}/stream | Text To Speech Streaming |\n| POST | /v1/text-to-speech/{voice_id}/stream/with-timestamps | Text To Speech Streaming With Timestamps |\n\n### text-to-dialogue\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/text-to-dialogue | Text To Dialogue (Multi-Voice) |\n| POST | /v1/text-to-dialogue/stream | Text To Dialogue (Multi-Voice) Streaming |\n| POST | /v1/text-to-dialogue/stream/with-timestamps | Text To Dialogue Streaming With Timestamps |\n| POST | /v1/text-to-dialogue/with-timestamps | Text To Dialogue With Timestamps |\n\n### voice-changer\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/voice-changer/{voice_id} | Voice Changer |\n| POST | /v1/voice-changer/{voice_id}/stream | Voice Changer Streaming |\n\n### text-to-voice\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/text-to-voice/create-previews | [Deprecated] Generate A Voice Preview From Description |\n| POST | /v1/text-to-voice | Create A New Voice From Voice Preview |\n| POST | /v1/text-to-voice/design | Design A Voice. |\n| POST | /v1/text-to-voice/{voice_id}/remix | Remix A Voice. |\n| GET | /v1/text-to-voice/{generated_voice_id}/stream | Text To Voice Preview Streaming |\n\n### user\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/user | Get User Info |\n| GET | /v1/user/subscription | Get User Subscription Info |\n\n### studio\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/studio/podcasts | Create Podcast |\n| POST | /v1/studio/projects/{project_id}/pronunciation-dictionaries | Create Pronunciation Dictionaries |\n| GET | /v1/studio/projects | List Studio Projects |\n| POST | /v1/studio/projects | Create Studio Project |\n| POST | /v1/studio/projects/{project_id} | Update Studio Project |\n| GET | /v1/studio/projects/{project_id} | Get Studio Project |\n| DELETE | /v1/studio/projects/{project_id} | Delete Studio Project |\n| POST | /v1/studio/projects/{project_id}/content | Update Studio Project Content |\n| POST | /v1/studio/projects/{project_id}/convert | Convert Studio Project |\n| GET | /v1/studio/projects/{project_id}/snapshots | List Studio Project Snapshots |\n| GET | /v1/studio/projects/{project_id}/snapshots/{project_snapshot_id} | Get Project Snapshot |\n| POST | /v1/studio/projects/{project_id}/snapshots/{project_snapshot_id}/stream | Stream Studio Project Audio |\n| POST | /v1/studio/projects/{project_id}/snapshots/{project_snapshot_id}/archive | Stream Archive With Studio Project Audio |\n| GET | /v1/studio/projects/{project_id}/chapters | List Chapters |\n| POST | /v1/studio/projects/{project_id}/chapters | Create Chapter |\n| GET | /v1/studio/projects/{project_id}/chapters/{chapter_id} | Get Chapter |\n| POST | /v1/studio/projects/{project_id}/chapters/{chapter_id} | Update Chapter |\n| DELETE | /v1/studio/projects/{project_id}/chapters/{chapter_id} | Delete Chapter |\n| POST | /v1/studio/projects/{project_id}/chapters/{chapter_id}/convert | Convert Chapter |\n| GET | /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots | List Chapter Snapshots |\n| GET | /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots/{chapter_snapshot_id} | Get Chapter Snapshot |\n| POST | /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots/{chapter_snapshot_id}/stream | Stream Chapter Audio |\n| GET | /v1/studio/projects/{project_id}/muted-tracks | Get Project Muted Tracks |\n\n### dubbing\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/dubbing/project | Create Dubbing Project |\n| GET | /v1/dubbing/project | List Dubbing Projects |\n| GET | /v1/dubbing/project/{project_id} | Get Dubbing Project |\n| DELETE | /v1/dubbing/project/{project_id} | Delete Dubbing Project |\n| POST | /v1/dubbing/project/{project_id}/language | Create Dubbing Language Target |\n| GET | /v1/dubbing/project/{project_id}/language | List Dubbing Language Targets |\n| GET | /v1/dubbing/project/{project_id}/language/{language_id} | Get Dubbing Language Target |\n| DELETE | /v1/dubbing/project/{project_id}/language/{language_id} | Delete Dubbing Language Target |\n| GET | /v1/dubbing/project/{project_id}/transcript | Get Dubbing Transcript |\n| PATCH | /v1/dubbing/project/{project_id}/transcript/segment/{segment_id} | Update Dubbing Transcript Segment |\n| DELETE | /v1/dubbing/project/{project_id}/transcript/segment/{segment_id} | Delete Dubbing Transcript Segment |\n| PATCH | /v1/dubbing/project/{project_id}/transcript/segments | Update Dubbing Transcript Segments |\n| POST | /v1/dubbing/project/{project_id}/transcript/segment | Add Dubbing Transcript Segment |\n| GET | /v1/dubbing/project/{project_id}/language/{language_id}/transcript | Get Dubbing Target Transcript |\n| PATCH | /v1/dubbing/project/{project_id}/language/{language_id}/transcript/segment/{segment_id} | Update Dubbing Target Transcript Segment |\n| PATCH | /v1/dubbing/project/{project_id}/language/{language_id}/transcript/segments | Update Dubbing Target Transcript Segments |\n| POST | /v1/dubbing/project/{project_id}/language/{language_id}/transcript/regenerate | Regenerate Dubbing Target |\n| GET | /v1/dubbing/resource/{dubbing_id} | Get The Dubbing Resource For An Id. |\n| POST | /v1/dubbing/resource/{dubbing_id}/language | Add A Language To The Resource |\n| POST | /v1/dubbing/resource/{dubbing_id}/speaker/{speaker_id}/segment | Create A Segment For The Speaker |\n| PATCH | /v1/dubbing/resource/{dubbing_id}/segment/{segment_id}/{language} | Modify A Single Segment |\n| POST | /v1/dubbing/resource/{dubbing_id}/migrate-segments | Move Segments Between Speakers |\n| DELETE | /v1/dubbing/resource/{dubbing_id}/segment/{segment_id} | Deletes A Single Segment |\n| POST | /v1/dubbing/resource/{dubbing_id}/transcribe | Transcribes Segments |\n| POST | /v1/dubbing/resource/{dubbing_id}/translate | Translates All Or Some Segments And Languages |\n| POST | /v1/dubbing/resource/{dubbing_id}/dub | Dubs All Or Some Segments And Languages |\n| PATCH | /v1/dubbing/resource/{dubbing_id}/speaker/{speaker_id} | Update Metadata For A Speaker |\n| POST | /v1/dubbing/resource/{dubbing_id}/speaker | Create A New Speaker |\n| GET | /v1/dubbing/resource/{dubbing_id}/speaker/{speaker_id}/similar-voices | Search The Elevenlabs Library For Voices Similar To A Speaker. |\n| POST | /v1/dubbing/resource/{dubbing_id}/render/{language} | Render Audio Or Video For The Given Language |\n| GET | /v1/dubbing | List Dubs |\n| POST | /v1/dubbing | Dub A Video Or An Audio File |\n| GET | /v1/dubbing/{dubbing_id} | Get Dubbing |\n| DELETE | /v1/dubbing/{dubbing_id} | Delete Dubbing |\n| GET | /v1/dubbing/{dubbing_id}/audio/{language_code} | Get Dubbed File |\n| GET | /v1/dubbing/{dubbing_id}/transcript/{language_code} | Get Dubbed Transcript |\n| GET | /v1/dubbing/{dubbing_id}/transcripts/{language_code}/format/{format_type} | Retrieve A Transcript |\n\n### models\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/models | Get Models |\n\n### audio-native\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/audio-native | Creates Audio Native Enabled Project. |\n| GET | /v1/audio-native/{project_id}/settings | Get Audio Native Project Settings |\n| POST | /v1/audio-native/{project_id}/content | Update Audio-Native Project Content |\n| POST | /v1/audio-native/content | Update Audio-Native Content From Url |\n\n### content-provenance\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/content-provenance/watermark | Check Watermark |\n\n### similar-voices\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/similar-voices | Get Similar Library Voices |\n\n### shared-voices\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/shared-voices | Get Voices |\n\n### usage\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/usage/character-stats | Get Characters Usage Metrics (Deprecated) |\n\n### pronunciation-dictionaries\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/pronunciation-dictionaries/add-from-file | Add A Pronunciation Dictionary |\n| POST | /v1/pronunciation-dictionaries/add-from-rules | Add A Pronunciation Dictionary |\n| PATCH | /v1/pronunciation-dictionaries/{pronunciation_dictionary_id} | Update Pronunciation Dictionary |\n| GET | /v1/pronunciation-dictionaries/{pronunciation_dictionary_id} | Get Metadata For A Pronunciation Dictionary |\n| POST | /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/set-rules | Set Rules On The Pronunciation Dictionary |\n| POST | /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/add-rules | Add Rules To The Pronunciation Dictionary |\n| POST | /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/remove-rules | Remove Rules From The Pronunciation Dictionary |\n| GET | /v1/pronunciation-dictionaries/{dictionary_id}/{version_id}/download | Get A Pls File With A Pronunciation Dictionary Version Rules |\n| GET | /v1/pronunciation-dictionaries | Get Pronunciation Dictionaries |\n\n### workspaces\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/workspaces/api-keys/disable | Disable Api Key |\n| POST | /v1/workspaces/api-keys/third-party-disabling | Set Workspace Third-Party Disabling Policy |\n\n### service-accounts\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/service-accounts/{service_account_user_id}/api-keys | Get Service Account Api Keys Route |\n| POST | /v1/service-accounts/{service_account_user_id}/api-keys | Create Service Account Api Key |\n| PATCH | /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id} | Edit Service Account Api Key |\n| DELETE | /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id} | Delete Service Account Api Key |\n| POST | /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}/disable | Disable Service Account Api Key |\n| GET | /v1/service-accounts | Get Workspace Service Accounts |\n| POST | /v1/service-accounts | Create Service Account |\n\n### workspace\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/workspace/audit-logs | Get Workspace Audit Logs |\n| POST | /v1/workspace/auth-connections | Create Workspace Auth Connection |\n| GET | /v1/workspace/auth-connections | Get Workspace Auth Connections |\n| PATCH | /v1/workspace/auth-connections/{auth_connection_id} | Update Workspace Auth Connection |\n| DELETE | /v1/workspace/auth-connections/{auth_connection_id} | Delete Workspace Auth Connection |\n| GET | /v1/workspace/groups | Get All Groups |\n| GET | /v1/workspace/groups/search | Search User Groups |\n| POST | /v1/workspace/groups/{group_id}/members/remove | Delete Member From User Group |\n| POST | /v1/workspace/groups/{group_id}/members | Add Member To User Group |\n| POST | /v1/workspace/invites/add | Invite User |\n| POST | /v1/workspace/invites/add-bulk | Invite Multiple Users |\n| DELETE | /v1/workspace/invites | Delete Existing Invitation |\n| GET | /v1/workspace/members | Get Workspace Members |\n| POST | /v1/workspace/members | Update Member |\n| PUT | /v1/workspace/members/{user_id}/usage-limit | Update Member Usage Limit |\n| GET | /v1/workspace/resources/{resource_id} | Get Resource |\n| POST | /v1/workspace/resources/{resource_id}/share | Share Workspace Resource |\n| POST | /v1/workspace/resources/{resource_id}/unshare | Unshare Workspace Resource |\n| GET | /v1/workspace/webhooks | List Workspace Webhooks |\n| POST | /v1/workspace/webhooks | Create Workspace Webhook |\n| PATCH | /v1/workspace/webhooks/{webhook_id} | Update Workspace Webhook |\n| DELETE | /v1/workspace/webhooks/{webhook_id} | Delete Workspace Webhook |\n| POST | /v1/workspace/analytics/query/usage-by-product-over-time | Get Workspace Usage |\n| POST | /v1/workspace/analytics/usage | Get Workspace Cost Usage |\n| POST | /v1/workspace/analytics/requests | List Api Requests |\n| POST | /v1/workspace/webhooks/{webhook_id}/test | Send Test Webhook Event |\n| POST | /v1/workspace/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliver | Redeliver Webhook Delivery |\n\n### music\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/music/video-to-music | Video To Music |\n| POST | /v1/music/plan | Generate Composition Plan |\n| POST | /v1/music | Compose Music |\n| POST | /v1/music/detailed | Compose Music With A Detailed Response |\n| POST | /v1/music/detailed/stream | Stream Composed Music With A Detailed Response |\n| POST | /v1/music/stream | Stream Composed Music |\n| POST | /v1/music/upload | Upload Music |\n| POST | /v1/music/stem-separation | Stem Separation |\n| GET | /v1/music/finetunes | Get Music Finetunes |\n| POST | /v1/music/finetunes | Create Music Finetune |\n| GET | /v1/music/finetunes/{finetune_id} | Get Music Finetune |\n| PATCH | /v1/music/finetunes/{finetune_id} | Update Music Finetune |\n| DELETE | /v1/music/finetunes/{finetune_id} | Delete Music Finetune |\n\n### speech-to-text\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/speech-to-text | Speech To Text |\n| GET | /v1/speech-to-text/transcripts/{transcription_id} | Get Transcript By Id |\n| DELETE | /v1/speech-to-text/transcripts/{transcription_id} | Delete Transcript By Id |\n\n### single-use-token\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/single-use-token/{token_type} | Create Single Use Token |\n\n### forced-alignment\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/forced-alignment | Create Forced Alignment |\n\n### convai\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/convai/conversation/get-signed-url | Get Signed Url |\n| GET | /v1/convai/conversation/get_signed_url | Get Signed Url |\n| GET | /v1/convai/conversation/token | Get Webrtc Token |\n| POST | /v1/convai/twilio/outbound-call | Handle An Outbound Call Via Twilio |\n| POST | /v1/convai/twilio/register-call | Register A Twilio Call And Return Twiml |\n| POST | /v1/convai/exotel/outbound-call | Handle An Outbound Call Via Exotel |\n| POST | /v1/convai/whatsapp/outbound-call | Make An Outbound Call Via Whatsapp |\n| POST | /v1/convai/whatsapp/outbound-message | Send An Outbound Message Via Whatsapp |\n| POST | /v1/convai/agents/create | Create Agent |\n| GET | /v1/convai/agents/summaries | Get Agent Summaries |\n| GET | /v1/convai/agents/{agent_id} | Get Agent |\n| PATCH | /v1/convai/agents/{agent_id} | Patches An Agent Settings |\n| DELETE | /v1/convai/agents/{agent_id} | Delete Agent |\n| GET | /v1/convai/agents/{agent_id}/subagent-dependents | Get Agent Subagent Dependents |\n| GET | /v1/convai/agents/{agent_id}/widget | Get Agent Widget Config |\n| GET | /v1/convai/agents/{agent_id}/link | Get Shareable Agent Link |\n| POST | /v1/convai/agents/{agent_id}/avatar | Post Agent Avatar |\n| POST | /v1/convai/agents/{agent_id}/hold-audio | Post Agent Hold Audio |\n| DELETE | /v1/convai/agents/{agent_id}/hold-audio | Delete Agent Hold Audio |\n| GET | /v1/convai/agents | List Agents |\n| GET | /v1/convai/agent/{agent_id}/knowledge-base/size | Returns The Size Of The Agent'S Knowledge Base |\n| POST | /v1/convai/agent/{agent_id}/llm-usage/calculate | Calculate Expected Llm Usage For An Agent |\n| POST | /v1/convai/agents/{agent_id}/duplicate | Duplicate Agent |\n| POST | /v1/convai/agents/{agent_id}/simulate-conversation | Simulates A Conversation |\n| POST | /v1/convai/agents/{agent_id}/simulate-conversation/stream | Simulates A Conversation (Stream) |\n| POST | /v1/convai/agent-testing/create | Create Agent Response Test |\n| POST | /v1/convai/agent-testing/folders | Create Agent Test Folder |\n| GET | /v1/convai/agent-testing/folders/{folder_id} | Get Agent Test Folder By Id |\n| PATCH | /v1/convai/agent-testing/folders/{folder_id} | Update Agent Test Folder |\n| DELETE | /v1/convai/agent-testing/folders/{folder_id} | Delete Agent Test Folder |\n| POST | /v1/convai/agent-testing/bulk-move | Bulk Move Tests To Folder |\n| GET | /v1/convai/agent-testing/{test_id} | Get Agent Response Test By Id |\n| PUT | /v1/convai/agent-testing/{test_id} | Update Agent Response Test |\n| DELETE | /v1/convai/agent-testing/{test_id} | Delete Agent Response Test |\n| POST | /v1/convai/agent-testing/summaries | Get Agent Response Test Summaries By Ids |\n| GET | /v1/convai/agent-testing | List Agent Response Tests |\n| GET | /v1/convai/test-invocations | List Test Invocations |\n| POST | /v1/convai/agents/{agent_id}/run-tests | Run Tests On The Agent |\n| GET | /v1/convai/test-invocations/{test_invocation_id} | Get Test Invocation |\n| PATCH | /v1/convai/test-invocations/{test_invocation_id} | Update Test Invocation |\n| POST | /v1/convai/test-invocations/{test_invocation_id}/cancel | Cancel Test Invocation |\n| POST | /v1/convai/test-invocations/{test_invocation_id}/resubmit | Resubmit Tests |\n| GET | /v1/convai/conversations | Get Conversations |\n| POST | /v1/convai/conversations | Create Conversation |\n| GET | /v1/convai/users | Get Conversation Users |\n| GET | /v1/convai/conversations/resolve | Resolve Conversation Reference |\n| GET | /v1/convai/conversations/{conversation_id} | Get Conversation Details |\n| DELETE | /v1/convai/conversations/{conversation_id} | Delete Conversation |\n| GET | /v1/convai/conversations/{conversation_id}/summary | Get Conversation Summary |\n| GET | /v1/convai/conversations/{conversation_id}/sip-messages | Get Sip Messages For A Conversation |\n| GET | /v1/convai/conversations/{conversation_id}/audio | Get Conversation Audio |\n| GET | /v1/convai/conversations/{conversation_id}/files/{file_id} | Get Conversation File |\n| DELETE | /v1/convai/conversations/{conversation_id}/files/{file_id} | Delete File Upload |\n| POST | /v1/convai/conversations/{conversation_id}/feedback | Send Conversation Feedback |\n| GET | /v1/convai/conversations/messages/text-search | Text Search Conversation Messages |\n| GET | /v1/convai/conversations/messages/smart-search | Smart Search Conversation Messages |\n| POST | /v1/convai/conversations/{conversation_id}/tags | Assign Conversation Tags |\n| DELETE | /v1/convai/conversations/{conversation_id}/tags/{tag_id} | Unassign Conversation Tag |\n| GET | /v1/convai/tags | List Conversation Tags |\n| POST | /v1/convai/tags | Create Conversation Tag |\n| GET | /v1/convai/tags/{tag_id} | Get Conversation Tag |\n| PATCH | /v1/convai/tags/{tag_id} | Update Conversation Tag |\n| DELETE | /v1/convai/tags/{tag_id} | Delete Conversation Tag |\n| GET | /v1/convai/agents/{agent_id}/triage-tickets | List Agent Conversation Tickets |\n| POST | /v1/convai/agents/{agent_id}/triage-tickets | Create Manual Agent Ticket |\n| GET | /v1/convai/triage-tickets | List Workspace Conversation Tickets |\n| POST | /v1/convai/triage-tickets | Create Agent Conversation Ticket |\n| GET | /v1/convai/agents/{agent_id}/triage-tickets/assignable-users | Get Agent Conversation Ticket Assignable Users |\n| GET | /v1/convai/triage-tickets/{agentqa_ticket_id} | Get Agent Conversation Ticket |\n| PATCH | /v1/convai/triage-tickets/{agentqa_ticket_id} | Update Agent Conversation Ticket |\n| DELETE | /v1/convai/triage-tickets/{agentqa_ticket_id} | Delete Agent Conversation Ticket |\n| POST | /v1/convai/triage-tickets/{agentqa_ticket_id}/comments | Add Comment To Agent Conversation Ticket |\n| POST | /v1/convai/triage-tickets/{agentqa_ticket_id}/merge | Merge Agent Conversation Tickets |\n| POST | /v1/convai/triage-tickets/{agentqa_ticket_id}/turn-comments | Add Turn Comment To Agent Conversation Ticket |\n| POST | /v1/convai/phone-numbers | Import Phone Number |\n| GET | /v1/convai/phone-numbers | List Phone Numbers |\n| GET | /v1/convai/phone-numbers/{phone_number_id} | Get Phone Number |\n| DELETE | /v1/convai/phone-numbers/{phone_number_id} | Delete Phone Number |\n| PATCH | /v1/convai/phone-numbers/{phone_number_id} | Update Phone Number |\n| GET | /v1/convai/v2/phone-numbers | List Phone Numbers Page |\n| GET | /v1/convai/phone-numbers/{phone_number_id}/sip-messages | Get Sip Messages For A Phone Number |\n| POST | /v1/convai/llm-usage/calculate | Calculate Expected Llm Usage |\n| GET | /v1/convai/llm/list | List Available Llms |\n| POST | /v1/convai/conversations/{conversation_id}/files | Upload File |\n| GET | /v1/convai/analytics/live-count | Get Live Count |\n| GET | /v1/convai/knowledge-base/summaries | Get Knowledge Base Summaries By Ids |\n| POST | /v1/convai/knowledge-base | Add To Knowledge Base |\n| GET | /v1/convai/knowledge-base | Get Knowledge Base List |\n| POST | /v1/convai/knowledge-base/url | Create Url Document |\n| POST | /v1/convai/knowledge-base/crawl | Create Crawl Job |\n| GET | /v1/convai/knowledge-base/crawl | List Ongoing And Recent Crawl Jobs Created By A User |\n| GET | /v1/convai/knowledge-base/crawl/{crawl_job_id} | Get Crawl Job Details |\n| POST | /v1/convai/knowledge-base/crawl/{crawl_job_id}/cancel | Cancel Crawl Job |\n| POST | /v1/convai/knowledge-base/file | Create File Document |\n| POST | /v1/convai/knowledge-base/text | Create Text Document |\n| POST | /v1/convai/knowledge-base/folder | Create Folder |\n| PATCH | /v1/convai/knowledge-base/{documentation_id} | Update Document |\n| GET | /v1/convai/knowledge-base/{documentation_id} | Get Documentation From Knowledge Base |\n| DELETE | /v1/convai/knowledge-base/{documentation_id} | Delete Knowledge Base Document Or Folder |\n| GET | /v1/convai/knowledge-base/{documentation_id}/chunking-override | Get Chunking Override |\n| PATCH | /v1/convai/knowledge-base/{documentation_id}/chunking-override | Update Chunking Override |\n| PATCH | /v1/convai/knowledge-base/{documentation_id}/update-file | Update File Document |\n| POST | /v1/convai/knowledge-base/rag-index | Compute Rag Indexes In Batch |\n| GET | /v1/convai/knowledge-base/rag-index | Get Rag Index Overview. |\n| POST | /v1/convai/knowledge-base/{documentation_id}/refresh | Refresh Url Document Content |\n| POST | /v1/convai/knowledge-base/{documentation_id}/rag-index | Compute Rag Index. |\n| GET | /v1/convai/knowledge-base/{documentation_id}/rag-index | Get Rag Indexes Of The Specified Knowledgebase Document. |\n| DELETE | /v1/convai/knowledge-base/{documentation_id}/rag-index/{rag_index_id} | Delete Rag Index. |\n| GET | /v1/convai/knowledge-base/search | Search Knowledge Base Content |\n| POST | /v1/convai/agents/{agent_id}/knowledge-base/rag-query | Query Agent Knowledge Base Rag |\n| GET | /v1/convai/knowledge-base/{documentation_id}/dependent-agents | Get Dependent Agents List |\n| POST | /v1/convai/knowledge-base/dependent-agents | Get Dependent Agents For Multiple Documents |\n| GET | /v1/convai/knowledge-base/{documentation_id}/content | Get Document Content |\n| GET | /v1/convai/knowledge-base/{documentation_id}/source-file-url | Get Document Source File Url |\n| GET | /v1/convai/knowledge-base/{documentation_id}/chunk/{chunk_id} | Get Documentation Chunk From Knowledge Base |\n| GET | /v1/convai/knowledge-base/{documentation_id}/chunks | Get All Rag Chunks For A Document |\n| POST | /v1/convai/knowledge-base/{document_id}/move | Move Entity To Folder |\n| POST | /v1/convai/knowledge-base/bulk-move | Bulk Move Entities To Folder |\n| POST | /v1/convai/knowledge-base/bulk-delete | Bulk Delete Knowledge Base Documents |\n| GET | /v1/convai/agents/{agent_id}/topics | Get Agent Conversation Topics |\n| POST | /v1/convai/tools | Add Tool |\n| GET | /v1/convai/tools | Get Tools |\n| GET | /v1/convai/tools/{tool_id} | Get Tool |\n| PATCH | /v1/convai/tools/{tool_id} | Update Tool |\n| DELETE | /v1/convai/tools/{tool_id} | Delete Tool |\n| GET | /v1/convai/tools/{tool_id}/dependent-agents | Get Dependent Agents List |\n| GET | /v1/convai/tools/{tool_id}/executions | Get Tool Executions |\n| POST | /v1/convai/analysis-items | Create Analysis Item |\n| GET | /v1/convai/analysis-items | List Analysis Items |\n| PATCH | /v1/convai/analysis-items/{analysis_item_id}/attachments | Update Analysis Item Attachments |\n| GET | /v1/convai/analysis-items/{analysis_item_id} | Get Analysis Item |\n| PATCH | /v1/convai/analysis-items/{analysis_item_id} | Update Analysis Item |\n| DELETE | /v1/convai/analysis-items/{analysis_item_id} | Delete Analysis Item |\n| GET | /v1/convai/analysis-items/{analysis_item_id}/versions | List Analysis Item Versions |\n| POST | /v1/convai/analysis-items/{analysis_item_id}/copy | Copy Analysis Item |\n| GET | /v1/convai/analysis-items/{analysis_item_id}/dependent-agents | Get Analysis Item Dependent Agents |\n| GET | /v1/convai/settings | Get Convai Settings |\n| PATCH | /v1/convai/settings | Update Convai Settings |\n| GET | /v1/convai/settings/dashboard | Get Convai Dashboard Settings |\n| PATCH | /v1/convai/settings/dashboard | Update Convai Dashboard Settings |\n| POST | /v1/convai/secrets | Create Convai Workspace Secret |\n| GET | /v1/convai/secrets | Get Convai Workspace Secrets |\n| GET | /v1/convai/secrets/{secret_id} | Get Convai Workspace Secret |\n| DELETE | /v1/convai/secrets/{secret_id} | Delete Convai Workspace Secret |\n| PATCH | /v1/convai/secrets/{secret_id} | Update Convai Workspace Secret |\n| GET | /v1/convai/secrets/{secret_id}/dependencies/{resource_type} | Get Secret Dependencies By Type |\n| POST | /v1/convai/batch-calling/submit | Submit A Batch Call Request. |\n| GET | /v1/convai/batch-calling/workspace | Get All Batch Calls For A Workspace. |\n| GET | /v1/convai/batch-calling/{batch_id} | Get A Batch Call By Id. |\n| DELETE | /v1/convai/batch-calling/{batch_id} | Delete A Batch Call. |\n| POST | /v1/convai/batch-calling/{batch_id}/cancel | Cancel A Batch Call. |\n| POST | /v1/convai/batch-calling/{batch_id}/retry | Retry A Batch Call. |\n| GET | /v1/convai/batch-calling/{batch_id}/export | Export Batch Call Results |\n| POST | /v1/convai/sip-trunk/outbound-call | Handle An Outbound Call Via Sip Trunk |\n| POST | /v1/convai/mcp-servers | Create Mcp Server |\n| GET | /v1/convai/mcp-servers | List Mcp Servers |\n| GET | /v1/convai/mcp-servers/{mcp_server_id} | Get Mcp Server |\n| DELETE | /v1/convai/mcp-servers/{mcp_server_id} | Delete Mcp Server |\n| PATCH | /v1/convai/mcp-servers/{mcp_server_id} | Update Mcp Server Configuration |\n| GET | /v1/convai/mcp-servers/{mcp_server_id}/tools | List Mcp Server Tools |\n| PATCH | /v1/convai/mcp-servers/{mcp_server_id}/approval-policy | Update Mcp Server Approval Policy |\n| POST | /v1/convai/mcp-servers/{mcp_server_id}/tool-approvals | Create Mcp Server Tool Approval |\n| DELETE | /v1/convai/mcp-servers/{mcp_server_id}/tool-approvals/{tool_name} | Delete Mcp Server Tool Approval |\n| POST | /v1/convai/mcp-servers/{mcp_server_id}/tool-configs | Create Mcp Tool Configuration Override |\n| GET | /v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name} | Get Mcp Tool Configuration Override |\n| PATCH | /v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name} | Update Mcp Tool Configuration Override |\n| DELETE | /v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name} | Delete Mcp Tool Configuration Override |\n| GET | /v1/convai/whatsapp-accounts/{phone_number_id} | Get Whatsapp Account |\n| PATCH | /v1/convai/whatsapp-accounts/{phone_number_id} | Update Whatsapp Account |\n| DELETE | /v1/convai/whatsapp-accounts/{phone_number_id} | Delete Whatsapp Account |\n| GET | /v1/convai/whatsapp-accounts | List Whatsapp Accounts |\n| POST | /v1/convai/agents/{agent_id}/branches | Create A New Branch |\n| GET | /v1/convai/agents/{agent_id}/branches | List Agent Branches |\n| GET | /v1/convai/agents/{agent_id}/branches/{branch_id} | Get Agent Branch |\n| PATCH | /v1/convai/agents/{agent_id}/branches/{branch_id} | Update Agent Branch |\n| GET | /v1/convai/agents/{agent_id}/versions/{version_id} | Get Agent Version Metadata |\n| GET | /v1/convai/agents/{agent_id}/branches/{source_branch_id}/merge-preview | Preview Merged Configuration |\n| POST | /v1/convai/agents/{agent_id}/branches/{source_branch_id}/merge | Merge A Branch Into A Target Branch |\n| GET | /v1/convai/agents/{agent_id}/branches/{branch_id}/rebase-preview | Preview Rebased Configuration |\n| POST | /v1/convai/agents/{agent_id}/branches/{branch_id}/rebase | Rebase A Branch Onto Main |\n| POST | /v1/convai/agents/{agent_id}/deployments | Create Or Update Deployments |\n| GET | /v1/convai/agents/{agent_id}/deployments | List Agent Deployments |\n| POST | /v1/convai/agents/{agent_id}/drafts | Create Agent Draft |\n| DELETE | /v1/convai/agents/{agent_id}/drafts | Delete Agent Draft |\n| POST | /v1/convai/agents/{agent_id}/merge-proposals | Create A Merge Proposal |\n| GET | /v1/convai/agents/{agent_id}/merge-proposals | List Proposals |\n| GET | /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id} | Get A Merge Proposal |\n| PATCH | /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id} | Update A Merge Proposal |\n| POST | /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/reviews | Review A Merge Proposal |\n| POST | /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/comments | Comment On A Merge Proposal |\n| POST | /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/merge | Merge A Merge Proposal |\n| GET | /v1/convai/outbound-campaigns/config | Get Outbound Campaign Configuration |\n| PUT | /v1/convai/outbound-campaigns/config | Replace Outbound Campaign Configuration |\n| GET | /v1/convai/outbound-campaigns/campaigns | List Outbound Campaigns |\n| POST | /v1/convai/outbound-campaigns/campaigns/pause-all | Pause All Outbound Campaigns |\n| POST | /v1/convai/outbound-campaigns/campaigns/stop-all | Stop All Outbound Campaigns |\n| POST | /v1/convai/outbound-campaigns/campaigns/submit | Create An Outbound Campaign |\n| GET | /v1/convai/outbound-campaigns/campaigns/{campaign_id} | Get An Outbound Campaign |\n| GET | /v1/convai/outbound-campaigns/campaigns/{campaign_id}/progress | Get Outbound Campaign Progress |\n| GET | /v1/convai/outbound-campaigns/campaigns/{campaign_id}/leads | List Outbound Campaign Leads |\n| GET | /v1/convai/outbound-campaigns/campaigns/{campaign_id}/calls | List Outbound Campaign Calls |\n| GET | /v1/convai/outbound-campaigns/campaigns/{campaign_id}/follow-up-requests | Get Outbound Campaign Follow-Up Requests |\n| GET | /v1/convai/outbound-campaigns/campaigns/{campaign_id}/export | Export Outbound Campaign Calls |\n| GET | /v1/convai/outbound-campaigns/campaigns/{campaign_id}/leads/{lead_id} | Get An Outbound Campaign Lead |\n| DELETE | /v1/convai/outbound-campaigns/campaigns/{campaign_id}/leads/{lead_id} | Remove An Outbound Campaign Lead |\n| POST | /v1/convai/outbound-campaigns/campaigns/{campaign_id}/pause | Pause An Outbound Campaign |\n| POST | /v1/convai/outbound-campaigns/campaigns/{campaign_id}/resume | Resume An Outbound Campaign |\n| POST | /v1/convai/outbound-campaigns/campaigns/{campaign_id}/stop | Stop An Outbound Campaign |\n| GET | /v1/convai/outbound-campaigns/attention | List Outbound Campaign Attention Items |\n| POST | /v1/convai/outbound-campaigns/attention/{attention_id}/retry | Retry An Outbound Campaign Attention Item |\n| POST | /v1/convai/outbound-campaigns/attention/{attention_id}/resolve | Resolve An Outbound Campaign Attention Item |\n| POST | /v1/convai/conversations/{conversation_id}/messages | Send Conversation Message |\n| POST | /v1/convai/conversations/{conversation_id}/messages/stream | Send Conversation Message Stream |\n| GET | /v1/convai/conversations/{conversation_id}/turns/{turn_id} | Get Conversation Turn |\n| GET | /v1/convai/conversations/{conversation_id}/turns/{turn_id}/events | Stream Conversation Turn Events |\n| POST | /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures | Create Procedure |\n| GET | /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures | List Procedures |\n| POST | /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/compile | Legacy: Compile Procedures |\n| DELETE | /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id} | Remove Procedure |\n| GET | /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id} | Get Procedure |\n| GET | /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft | Get Procedure Draft |\n| PATCH | /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft | Update Procedure Draft |\n| DELETE | /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft | Delete Procedure Draft |\n| POST | /v1/convai/conversations/{conversation_id}/analysis/run | Run Conversation Analysis |\n| POST | /v1/convai/conversations/{conversation_id}/analysis/evaluations/run | Run Conversation Evaluation |\n| GET | /v1/convai/environment-variables | List Environment Variables |\n| POST | /v1/convai/environment-variables | Create Environment Variable |\n| GET | /v1/convai/environment-variables/{env_var_id} | Get Environment Variable |\n| PATCH | /v1/convai/environment-variables/{env_var_id} | Update Environment Variable |\n| DELETE | /v1/convai/environment-variables/{env_var_id} | Delete Environment Variable |\n| GET | /v1/convai/environments | List Environments |\n| POST | /v1/convai/environments | Create Environment |\n| DELETE | /v1/convai/environments/{environment} | Delete Environment |\n| GET | /v1/convai/realtime/conversation-groups | List Realtime Conversation Groups |\n| POST | /v1/convai/realtime/conversation-groups | Create Realtime Conversation Group |\n| GET | /v1/convai/realtime/conversation-groups/{conversation_group_id} | Get Realtime Conversation Group |\n| PATCH | /v1/convai/realtime/conversation-groups/{conversation_group_id} | Update Realtime Conversation Group |\n| DELETE | /v1/convai/realtime/conversation-groups/{conversation_group_id} | Delete Realtime Conversation Group |\n| PUT | /v1/convai/realtime/conversations/{conversation_id}/conversation-group | Set Realtime Conversation Group |\n| DELETE | /v1/convai/realtime/conversations/{conversation_id}/conversation-group | Clear Realtime Conversation Group |\n| POST | /v1/convai/realtime/client_secrets | Create Realtime Client Secret |\n\n### speech-engine\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/speech-engine | List Speech Engines |\n| POST | /v1/speech-engine | Create Speech Engine |\n| GET | /v1/speech-engine/{speech_engine_id} | Get Speech Engine |\n| PATCH | /v1/speech-engine/{speech_engine_id} | Update Speech Engine |\n| DELETE | /v1/speech-engine/{speech_engine_id} | Delete Speech Engine |\n| POST | /v1/speech-engine/{speech_engine_id}/duplicate | Duplicate Speech Engine |\n\n### productions\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/productions/orders | Create Order |\n| GET | /v1/productions/orders | List Orders |\n| GET | /v1/productions/orders/{order_id} | Get Order |\n| PATCH | /v1/productions/orders/{order_id} | Update Order |\n| POST | /v1/productions/orders/{order_id}/media | Register Media |\n| GET | /v1/productions/orders/{order_id}/media/{media_id} | Get Media Info |\n| POST | /v1/productions/orders/{order_id}/items | Upsert Order Item |\n| DELETE | /v1/productions/orders/{order_id}/items/{item_id} | Remove Order Item |\n| POST | /v1/productions/orders/{order_id}/submit | Submit Order |\n| GET | /v1/productions/orders/{order_id}/deliverables | Get Order Deliverables |\n| GET | /v1/productions/orders/languages/{order_item_kind} | Get Available Languages |\n\n### flows\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/flows/video | Create Video Generation |\n| GET | /v1/flows/video | List Video Generations |\n| GET | /v1/flows/video/{generation_id} | Get Video Generation |\n| POST | /v1/flows/image | Create Image Generation |\n| GET | /v1/flows/image | List Image Generations |\n| GET | /v1/flows/image/{generation_id} | Get Image Generation |\n| POST | /v1/flows/text-to-speech | Create Speech Generation |\n| GET | /v1/flows/text-to-speech | List Speech Generations |\n| GET | /v1/flows/text-to-speech/{generation_id} | Get Speech Generation |\n| POST | /v1/flows/templates/{template_id}/runs | Create Template Run |\n| GET | /v1/flows/templates/{template_id}/runs | List Template Runs |\n| GET | /v1/flows/templates/{template_id}/runs/{run_id} | Get Template Run |\n| GET | /v1/flows/templates | List Templates |\n| GET | /v1/flows/templates/{template_id} | Get Template |\n\n### assets\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /v1/assets | Upload Asset |\n| GET | /v1/assets | List Assets |\n| GET | /v1/assets/{asset_id} | Get Asset |\n| DELETE | /v1/assets/{asset_id} | Delete Asset |\n\n### reception\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /v1/reception/services | Get All Services |\n| POST | /v1/reception/services | Create Service |\n| GET | /v1/reception/services/{service_id} | Get Service |\n| PUT | /v1/reception/services/{service_id} | Update Service |\n| DELETE | /v1/reception/services/{service_id} | Delete Service |\n| POST | /v1/reception/services/{service_id}/confirm-update | Confirm Service Update |\n| GET | /v1/reception/assets | Get All Assets |\n| POST | /v1/reception/assets | Create Asset |\n| GET | /v1/reception/assets/{asset_id} | Get Asset |\n| PUT | /v1/reception/assets/{asset_id} | Update Asset |\n| DELETE | /v1/reception/assets/{asset_id} | Delete Asset |\n| GET | /v1/reception/products | Get All Products |\n| POST | /v1/reception/products | Create Product |\n| GET | /v1/reception/products/{product_id} | Get Product |\n| PUT | /v1/reception/products/{product_id} | Update Product |\n| DELETE | /v1/reception/products/{product_id} | Delete Product |\n| PATCH | /v1/reception/products/{product_id}/stock | Update Product Stock |\n| POST | /v1/reception/products/{product_id}/stock/adjust | Adjust Product Stock |\n| GET | /v1/reception/staff | Get All Staff |\n| POST | /v1/reception/staff | Create Staff Member |\n| GET | /v1/reception/staff/{staff_id} | Get Staff Member |\n| PUT | /v1/reception/staff/{staff_id} | Update Staff Member |\n| DELETE | /v1/reception/staff/{staff_id} | Delete Staff Member |\n| GET | /v1/reception/customer-facing-agents | List Receptionists |\n| PATCH | /v1/reception/customer-facing-agents/{agent_id} | Update Receptionist |\n| POST | /v1/reception/customer-facing-agents/{agent_id}/activate | Activate Receptionist |\n| POST | /v1/reception/customer-facing-agents/{agent_id}/rules | Add Rule |\n| PUT | /v1/reception/customer-facing-agents/{agent_id}/rules/{rule_id} | Update Rule |\n| DELETE | /v1/reception/customer-facing-agents/{agent_id}/rules/{rule_id} | Delete Rule |\n| GET | /v1/reception/customer-facing-agents/{agent_id}/procedures | List Procedures |\n| POST | /v1/reception/customer-facing-agents/{agent_id}/procedures | Add Procedure |\n| PUT | /v1/reception/customer-facing-agents/{agent_id}/procedures/{procedure_id} | Update Procedure |\n| DELETE | /v1/reception/customer-facing-agents/{agent_id}/procedures/{procedure_id} | Delete Procedure |\n| POST | /v1/reception/customer-facing-agents/{agent_id}/transfer-rules | Add Transfer Rule |\n| PUT | /v1/reception/customer-facing-agents/{agent_id}/transfer-rules/{rule_id} | Update Transfer Rule |\n| DELETE | /v1/reception/customer-facing-agents/{agent_id}/transfer-rules/{rule_id} | Delete Transfer Rule |\n| GET | /v1/reception/phone-numbers/assignments | List Phone Numbers |\n| POST | /v1/reception/phone-numbers/assignments | Assign Phone Number |\n| DELETE | /v1/reception/phone-numbers/assignments/{phone_assignment_id} | Release Phone Number |\n| PATCH | /v1/reception/phone-numbers/assignments/{phone_assignment_id} | Move Phone Number |\n| GET | /v1/reception/holidays | Get All Holidays |\n| POST | /v1/reception/holidays | Create Holiday |\n| GET | /v1/reception/holidays/{holiday_id} | Get Holiday |\n| PUT | /v1/reception/holidays/{holiday_id} | Update Holiday |\n| DELETE | /v1/reception/holidays/{holiday_id} | Delete Holiday |\n| GET | /v1/reception/locations | List Locations |\n| POST | /v1/reception/locations | Create Location |\n| GET | /v1/reception/locations/{location_id} | Get Location |\n| PUT | /v1/reception/locations/{location_id} | Update Location |\n| DELETE | /v1/reception/locations/{location_id} | Delete Location |\n| GET | /v1/reception/agent-info | Get Business Profile |\n| PUT | /v1/reception/agent-info | Update Business Profile |\n| GET | /v1/reception/knowledge-sources | List Knowledge Sources |\n| POST | /v1/reception/knowledge-sources | Upload Knowledge Source |\n| GET | /v1/reception/knowledge-sources/{source_id} | Get Knowledge Source |\n| DELETE | /v1/reception/knowledge-sources/{source_id} | Delete Knowledge Source |\n| POST | /v1/reception/knowledge-sources/urls | Add Url Source |\n| GET | /v1/reception/reseller/workspaces | List Reseller Workspaces |\n| POST | /v1/reception/reseller/workspaces | Create Reseller Workspace |\n| POST | /v1/reception/reseller/workspaces/{workspace_id}/complete-onboarding | Complete Reseller Workspace Onboarding |\n| POST | /v1/reception/reseller/workspaces/{workspace_id}/subscription | Assign Reseller Tier |\n| PATCH | /v1/reception/reseller/workspaces/{workspace_id}/subscription | Change Reseller Tier |\n| DELETE | /v1/reception/reseller/workspaces/{workspace_id}/subscription | Unassign Reseller Tier |\n| POST | /v1/reception/reseller/workspaces/{workspace_id}/subscription/restore | Restore Reseller Subscription |\n| POST | /v1/reception/reseller/workspaces/{workspace_id}/subscription/cancel-downgrade | Cancel Reseller Pending Downgrade |\n| GET | /v1/reception/reseller/tier-ladder | List Reseller Tiers |\n| GET | /v1/reception/reseller/billing/invoices | List Reseller Invoices |\n| GET | /v1/reception/reseller/billing/invoices/{invoice_id} | Get Reseller Invoice |\n| GET | /v1/reception/reseller/billing/upcoming | List Reseller Upcoming Payments |\n| GET | /v1/reception/team/members | Get Team Members |\n| GET | /v1/reception/team/invites | Get Pending Team Invites |\n| POST | /v1/reception/team/invites | Invite Team Member |\n| DELETE | /v1/reception/team/invites | Cancel Team Invite |\n| PATCH | /v1/reception/team/members/{user_id} | Update Team Member Role |\n| DELETE | /v1/reception/team/members/{user_id} | Remove Team Member |\n\n### docs\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /docs | Redirect To Mintlify |\n\n## Common Questions\n\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"Search history?\" -> GET /v1/history\n- \"Get history details?\" -> GET /v1/history/{history_item_id}\n- \"Delete a history?\" -> DELETE /v1/history/{history_item_id}\n- \"List all audio?\" -> GET /v1/history/{history_item_id}/audio\n- \"Create a download?\" -> POST /v1/history/download\n- \"Create a sound-generation?\" -> POST /v1/sound-generation\n- \"Create a audio-isolation?\" -> POST /v1/audio-isolation\n- \"Search history?\" -> GET /v1/audio-isolation/history\n- \"Delete a history?\" -> DELETE /v1/audio-isolation/history/{history_item_id}\n- \"Create a stream?\" -> POST /v1/audio-isolation/stream\n- \"List all catalog?\" -> GET /v1/audio-effects/catalog\n- \"Delete a sample?\" -> DELETE /v1/voices/{voice_id}/samples/{sample_id}\n- \"List all audio?\" -> GET /v1/voices/{voice_id}/samples/{sample_id}/audio\n- \"Create a with-timestamp?\" -> POST /v1/text-to-speech/{voice_id}/with-timestamps\n- \"Create a stream?\" -> POST /v1/text-to-speech/{voice_id}/stream\n- \"Create a with-timestamp?\" -> POST /v1/text-to-speech/{voice_id}/stream/with-timestamps\n- \"Create a text-to-dialogue?\" -> POST /v1/text-to-dialogue\n- \"Create a stream?\" -> POST /v1/text-to-dialogue/stream\n- \"Create a with-timestamp?\" -> POST /v1/text-to-dialogue/stream/with-timestamps\n- \"Create a with-timestamp?\" -> POST /v1/text-to-dialogue/with-timestamps\n- \"Create a stream?\" -> POST /v1/voice-changer/{voice_id}/stream\n- \"Create a create-preview?\" -> POST /v1/text-to-voice/create-previews\n- \"Create a text-to-voice?\" -> POST /v1/text-to-voice\n- \"Create a design?\" -> POST /v1/text-to-voice/design\n- \"Create a remix?\" -> POST /v1/text-to-voice/{voice_id}/remix\n- \"List all stream?\" -> GET /v1/text-to-voice/{generated_voice_id}/stream\n- \"List all user?\" -> GET /v1/user\n- \"List all subscription?\" -> GET /v1/user/subscription\n- \"List all collections?\" -> GET /v1/voices/collections\n- \"Create a collection?\" -> POST /v1/voices/collections\n- \"Get collection details?\" -> GET /v1/voices/collections/{collection_id}\n- \"Partially update a collection?\" -> PATCH /v1/voices/collections/{collection_id}\n- \"Delete a collection?\" -> DELETE /v1/voices/collections/{collection_id}\n- \"Delete a voice?\" -> DELETE /v1/voices/collections/{collection_id}/voice/{voice_id}\n- \"List all default?\" -> GET /v1/voices/settings/default\n- \"List all settings?\" -> GET /v1/voices/{voice_id}/settings\n- \"Create a edit?\" -> POST /v1/voices/{voice_id}/settings/edit\n- \"List all accents?\" -> GET /v1/voices/accents\n- \"List all voices?\" -> GET /v1/voices\n- \"Get voice details?\" -> GET /v1/voices/{voice_id}\n- \"Delete a voice?\" -> DELETE /v1/voices/{voice_id}\n- \"Create a edit?\" -> POST /v1/voices/{voice_id}/edit\n- \"Search voices?\" -> GET /v2/voices\n- \"Create a replicate-to-isolated-environment?\" -> POST /v1/voices/{voice_id}/replicate-to-isolated-environment\n- \"Create a add?\" -> POST /v1/voices/add\n- \"Create a podcast?\" -> POST /v1/studio/podcasts\n- \"Create a pronunciation-dictionary?\" -> POST /v1/studio/projects/{project_id}/pronunciation-dictionaries\n- \"List all projects?\" -> GET /v1/studio/projects\n- \"Create a project?\" -> POST /v1/studio/projects\n- \"Get project details?\" -> GET /v1/studio/projects/{project_id}\n- \"Delete a project?\" -> DELETE /v1/studio/projects/{project_id}\n- \"Create a content?\" -> POST /v1/studio/projects/{project_id}/content\n- \"Create a convert?\" -> POST /v1/studio/projects/{project_id}/convert\n- \"List all snapshots?\" -> GET /v1/studio/projects/{project_id}/snapshots\n- \"Get snapshot details?\" -> GET /v1/studio/projects/{project_id}/snapshots/{project_snapshot_id}\n- \"Create a stream?\" -> POST /v1/studio/projects/{project_id}/snapshots/{project_snapshot_id}/stream\n- \"Create a archive?\" -> POST /v1/studio/projects/{project_id}/snapshots/{project_snapshot_id}/archive\n- \"List all chapters?\" -> GET /v1/studio/projects/{project_id}/chapters\n- \"Create a chapter?\" -> POST /v1/studio/projects/{project_id}/chapters\n- \"Get chapter details?\" -> GET /v1/studio/projects/{project_id}/chapters/{chapter_id}\n- \"Delete a chapter?\" -> DELETE /v1/studio/projects/{project_id}/chapters/{chapter_id}\n- \"Create a convert?\" -> POST /v1/studio/projects/{project_id}/chapters/{chapter_id}/convert\n- \"List all snapshots?\" -> GET /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots\n- \"Get snapshot details?\" -> GET /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots/{chapter_snapshot_id}\n- \"Create a stream?\" -> POST /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots/{chapter_snapshot_id}/stream\n- \"List all muted-tracks?\" -> GET /v1/studio/projects/{project_id}/muted-tracks\n- \"Create a project?\" -> POST /v1/dubbing/project\n- \"List all project?\" -> GET /v1/dubbing/project\n- \"Get project details?\" -> GET /v1/dubbing/project/{project_id}\n- \"Delete a project?\" -> DELETE /v1/dubbing/project/{project_id}\n- \"Create a language?\" -> POST /v1/dubbing/project/{project_id}/language\n- \"List all language?\" -> GET /v1/dubbing/project/{project_id}/language\n- \"Get language details?\" -> GET /v1/dubbing/project/{project_id}/language/{language_id}\n- \"Delete a language?\" -> DELETE /v1/dubbing/project/{project_id}/language/{language_id}\n- \"List all transcript?\" -> GET /v1/dubbing/project/{project_id}/transcript\n- \"Partially update a segment?\" -> PATCH /v1/dubbing/project/{project_id}/transcript/segment/{segment_id}\n- \"Delete a segment?\" -> DELETE /v1/dubbing/project/{project_id}/transcript/segment/{segment_id}\n- \"Create a segment?\" -> POST /v1/dubbing/project/{project_id}/transcript/segment\n- \"List all transcript?\" -> GET /v1/dubbing/project/{project_id}/language/{language_id}/transcript\n- \"Partially update a segment?\" -> PATCH /v1/dubbing/project/{project_id}/language/{language_id}/transcript/segment/{segment_id}\n- \"Create a regenerate?\" -> POST /v1/dubbing/project/{project_id}/language/{language_id}/transcript/regenerate\n- \"Get resource details?\" -> GET /v1/dubbing/resource/{dubbing_id}\n- \"Create a language?\" -> POST /v1/dubbing/resource/{dubbing_id}/language\n- \"Create a segment?\" -> POST /v1/dubbing/resource/{dubbing_id}/speaker/{speaker_id}/segment\n- \"Partially update a segment?\" -> PATCH /v1/dubbing/resource/{dubbing_id}/segment/{segment_id}/{language}\n- \"Create a migrate-segment?\" -> POST /v1/dubbing/resource/{dubbing_id}/migrate-segments\n- \"Delete a segment?\" -> DELETE /v1/dubbing/resource/{dubbing_id}/segment/{segment_id}\n- \"Create a transcribe?\" -> POST /v1/dubbing/resource/{dubbing_id}/transcribe\n- \"Create a translate?\" -> POST /v1/dubbing/resource/{dubbing_id}/translate\n- \"Create a dub?\" -> POST /v1/dubbing/resource/{dubbing_id}/dub\n- \"Partially update a speaker?\" -> PATCH /v1/dubbing/resource/{dubbing_id}/speaker/{speaker_id}\n- \"Create a speaker?\" -> POST /v1/dubbing/resource/{dubbing_id}/speaker\n- \"List all similar-voices?\" -> GET /v1/dubbing/resource/{dubbing_id}/speaker/{speaker_id}/similar-voices\n- \"List all dubbing?\" -> GET /v1/dubbing\n- \"Create a dubbing?\" -> POST /v1/dubbing\n- \"Get dubbing details?\" -> GET /v1/dubbing/{dubbing_id}\n- \"Delete a dubbing?\" -> DELETE /v1/dubbing/{dubbing_id}\n- \"Get audio details?\" -> GET /v1/dubbing/{dubbing_id}/audio/{language_code}\n- \"Get transcript details?\" -> GET /v1/dubbing/{dubbing_id}/transcript/{language_code}\n- \"Get format details?\" -> GET /v1/dubbing/{dubbing_id}/transcripts/{language_code}/format/{format_type}\n- \"List all models?\" -> GET /v1/models\n- \"Create a audio-native?\" -> POST /v1/audio-native\n- \"List all settings?\" -> GET /v1/audio-native/{project_id}/settings\n- \"Create a content?\" -> POST /v1/audio-native/{project_id}/content\n- \"Create a content?\" -> POST /v1/audio-native/content\n- \"Create a watermark?\" -> POST /v1/content-provenance/watermark\n- \"Create a similar-voice?\" -> POST /v1/similar-voices\n- \"Search shared-voices?\" -> GET /v1/shared-voices\n- \"List all character-stats?\" -> GET /v1/usage/character-stats\n- \"Create a add-from-file?\" -> POST /v1/pronunciation-dictionaries/add-from-file\n- \"Create a add-from-rule?\" -> POST /v1/pronunciation-dictionaries/add-from-rules\n- \"Partially update a pronunciation-dictionary?\" -> PATCH /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}\n- \"Get pronunciation-dictionary details?\" -> GET /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}\n- \"Create a set-rule?\" -> POST /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/set-rules\n- \"Create a add-rule?\" -> POST /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/add-rules\n- \"Create a remove-rule?\" -> POST /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/remove-rules\n- \"List all download?\" -> GET /v1/pronunciation-dictionaries/{dictionary_id}/{version_id}/download\n- \"List all pronunciation-dictionaries?\" -> GET /v1/pronunciation-dictionaries\n- \"Create a disable?\" -> POST /v1/workspaces/api-keys/disable\n- \"Create a third-party-disabling?\" -> POST /v1/workspaces/api-keys/third-party-disabling\n- \"List all api-keys?\" -> GET /v1/service-accounts/{service_account_user_id}/api-keys\n- \"Create a api-key?\" -> POST /v1/service-accounts/{service_account_user_id}/api-keys\n- \"Partially update a api-key?\" -> PATCH /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}\n- \"Delete a api-key?\" -> DELETE /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}\n- \"Create a disable?\" -> POST /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}/disable\n- \"List all audit-logs?\" -> GET /v1/workspace/audit-logs\n- \"Create a auth-connection?\" -> POST /v1/workspace/auth-connections\n- \"List all auth-connections?\" -> GET /v1/workspace/auth-connections\n- \"Partially update a auth-connection?\" -> PATCH /v1/workspace/auth-connections/{auth_connection_id}\n- \"Delete a auth-connection?\" -> DELETE /v1/workspace/auth-connections/{auth_connection_id}\n- \"List all service-accounts?\" -> GET /v1/service-accounts\n- \"Create a service-account?\" -> POST /v1/service-accounts\n- \"List all groups?\" -> GET /v1/workspace/groups\n- \"List all search?\" -> GET /v1/workspace/groups/search\n- \"Create a remove?\" -> POST /v1/workspace/groups/{group_id}/members/remove\n- \"Create a member?\" -> POST /v1/workspace/groups/{group_id}/members\n- \"Create a add?\" -> POST /v1/workspace/invites/add\n- \"Create a add-bulk?\" -> POST /v1/workspace/invites/add-bulk\n- \"List all members?\" -> GET /v1/workspace/members\n- \"Create a member?\" -> POST /v1/workspace/members\n- \"Get resource details?\" -> GET /v1/workspace/resources/{resource_id}\n- \"Create a share?\" -> POST /v1/workspace/resources/{resource_id}/share\n- \"Create a unshare?\" -> POST /v1/workspace/resources/{resource_id}/unshare\n- \"List all webhooks?\" -> GET /v1/workspace/webhooks\n- \"Create a webhook?\" -> POST /v1/workspace/webhooks\n- \"Partially update a webhook?\" -> PATCH /v1/workspace/webhooks/{webhook_id}\n- \"Delete a webhook?\" -> DELETE /v1/workspace/webhooks/{webhook_id}\n- \"Create a video-to-music?\" -> POST /v1/music/video-to-music\n- \"Create a speech-to-text?\" -> POST /v1/speech-to-text\n- \"Get transcript details?\" -> GET /v1/speech-to-text/transcripts/{transcription_id}\n- \"Delete a transcript?\" -> DELETE /v1/speech-to-text/transcripts/{transcription_id}\n- \"Create a forced-alignment?\" -> POST /v1/forced-alignment\n- \"List all get-signed-url?\" -> GET /v1/convai/conversation/get-signed-url\n- \"List all get_signed_url?\" -> GET /v1/convai/conversation/get_signed_url\n- \"List all token?\" -> GET /v1/convai/conversation/token\n- \"Create a outbound-call?\" -> POST /v1/convai/twilio/outbound-call\n- \"Create a register-call?\" -> POST /v1/convai/twilio/register-call\n- \"Create a outbound-call?\" -> POST /v1/convai/exotel/outbound-call\n- \"Create a outbound-call?\" -> POST /v1/convai/whatsapp/outbound-call\n- \"Create a outbound-message?\" -> POST /v1/convai/whatsapp/outbound-message\n- \"Create a create?\" -> POST /v1/convai/agents/create\n- \"List all summaries?\" -> GET /v1/convai/agents/summaries\n- \"Get agent details?\" -> GET /v1/convai/agents/{agent_id}\n- \"Partially update a agent?\" -> PATCH /v1/convai/agents/{agent_id}\n- \"Delete a agent?\" -> DELETE /v1/convai/agents/{agent_id}\n- \"List all subagent-dependents?\" -> GET /v1/convai/agents/{agent_id}/subagent-dependents\n- \"List all widget?\" -> GET /v1/convai/agents/{agent_id}/widget\n- \"List all link?\" -> GET /v1/convai/agents/{agent_id}/link\n- \"Create a avatar?\" -> POST /v1/convai/agents/{agent_id}/avatar\n- \"Create a hold-audio?\" -> POST /v1/convai/agents/{agent_id}/hold-audio\n- \"Search agents?\" -> GET /v1/convai/agents\n- \"List all size?\" -> GET /v1/convai/agent/{agent_id}/knowledge-base/size\n- \"Create a calculate?\" -> POST /v1/convai/agent/{agent_id}/llm-usage/calculate\n- \"Create a duplicate?\" -> POST /v1/convai/agents/{agent_id}/duplicate\n- \"Create a simulate-conversation?\" -> POST /v1/convai/agents/{agent_id}/simulate-conversation\n- \"Create a stream?\" -> POST /v1/convai/agents/{agent_id}/simulate-conversation/stream\n- \"Create a create?\" -> POST /v1/convai/agent-testing/create\n- \"Create a folder?\" -> POST /v1/convai/agent-testing/folders\n- \"Get folder details?\" -> GET /v1/convai/agent-testing/folders/{folder_id}\n- \"Partially update a folder?\" -> PATCH /v1/convai/agent-testing/folders/{folder_id}\n- \"Delete a folder?\" -> DELETE /v1/convai/agent-testing/folders/{folder_id}\n- \"Create a bulk-move?\" -> POST /v1/convai/agent-testing/bulk-move\n- \"Get agent-testing details?\" -> GET /v1/convai/agent-testing/{test_id}\n- \"Update a agent-testing?\" -> PUT /v1/convai/agent-testing/{test_id}\n- \"Delete a agent-testing?\" -> DELETE /v1/convai/agent-testing/{test_id}\n- \"Create a summary?\" -> POST /v1/convai/agent-testing/summaries\n- \"Search agent-testing?\" -> GET /v1/convai/agent-testing\n- \"Search test-invocations?\" -> GET /v1/convai/test-invocations\n- \"Create a run-test?\" -> POST /v1/convai/agents/{agent_id}/run-tests\n- \"Get test-invocation details?\" -> GET /v1/convai/test-invocations/{test_invocation_id}\n- \"Partially update a test-invocation?\" -> PATCH /v1/convai/test-invocations/{test_invocation_id}\n- \"Create a cancel?\" -> POST /v1/convai/test-invocations/{test_invocation_id}/cancel\n- \"Create a resubmit?\" -> POST /v1/convai/test-invocations/{test_invocation_id}/resubmit\n- \"Search conversations?\" -> GET /v1/convai/conversations\n- \"Create a conversation?\" -> POST /v1/convai/conversations\n- \"Search users?\" -> GET /v1/convai/users\n- \"List all resolve?\" -> GET /v1/convai/conversations/resolve\n- \"Get conversation details?\" -> GET /v1/convai/conversations/{conversation_id}\n- \"Delete a conversation?\" -> DELETE /v1/convai/conversations/{conversation_id}\n- \"List all summary?\" -> GET /v1/convai/conversations/{conversation_id}/summary\n- \"List all sip-messages?\" -> GET /v1/convai/conversations/{conversation_id}/sip-messages\n- \"List all audio?\" -> GET /v1/convai/conversations/{conversation_id}/audio\n- \"Get file details?\" -> GET /v1/convai/conversations/{conversation_id}/files/{file_id}\n- \"Delete a file?\" -> DELETE /v1/convai/conversations/{conversation_id}/files/{file_id}\n- \"Create a feedback?\" -> POST /v1/convai/conversations/{conversation_id}/feedback\n- \"List all text-search?\" -> GET /v1/convai/conversations/messages/text-search\n- \"List all smart-search?\" -> GET /v1/convai/conversations/messages/smart-search\n- \"Create a tag?\" -> POST /v1/convai/conversations/{conversation_id}/tags\n- \"Delete a tag?\" -> DELETE /v1/convai/conversations/{conversation_id}/tags/{tag_id}\n- \"List all tags?\" -> GET /v1/convai/tags\n- \"Create a tag?\" -> POST /v1/convai/tags\n- \"Get tag details?\" -> GET /v1/convai/tags/{tag_id}\n- \"Partially update a tag?\" -> PATCH /v1/convai/tags/{tag_id}\n- \"Delete a tag?\" -> DELETE /v1/convai/tags/{tag_id}\n- \"Search triage-tickets?\" -> GET /v1/convai/agents/{agent_id}/triage-tickets\n- \"Create a triage-ticket?\" -> POST /v1/convai/agents/{agent_id}/triage-tickets\n- \"Search triage-tickets?\" -> GET /v1/convai/triage-tickets\n- \"Create a triage-ticket?\" -> POST /v1/convai/triage-tickets\n- \"List all assignable-users?\" -> GET /v1/convai/agents/{agent_id}/triage-tickets/assignable-users\n- \"Get triage-ticket details?\" -> GET /v1/convai/triage-tickets/{agentqa_ticket_id}\n- \"Partially update a triage-ticket?\" -> PATCH /v1/convai/triage-tickets/{agentqa_ticket_id}\n- \"Delete a triage-ticket?\" -> DELETE /v1/convai/triage-tickets/{agentqa_ticket_id}\n- \"Create a comment?\" -> POST /v1/convai/triage-tickets/{agentqa_ticket_id}/comments\n- \"Create a merge?\" -> POST /v1/convai/triage-tickets/{agentqa_ticket_id}/merge\n- \"Create a turn-comment?\" -> POST /v1/convai/triage-tickets/{agentqa_ticket_id}/turn-comments\n- \"Create a phone-number?\" -> POST /v1/convai/phone-numbers\n- \"List all phone-numbers?\" -> GET /v1/convai/phone-numbers\n- \"Get phone-number details?\" -> GET /v1/convai/phone-numbers/{phone_number_id}\n- \"Delete a phone-number?\" -> DELETE /v1/convai/phone-numbers/{phone_number_id}\n- \"Partially update a phone-number?\" -> PATCH /v1/convai/phone-numbers/{phone_number_id}\n- \"Search phone-numbers?\" -> GET /v1/convai/v2/phone-numbers\n- \"List all sip-messages?\" -> GET /v1/convai/phone-numbers/{phone_number_id}/sip-messages\n- \"Create a calculate?\" -> POST /v1/convai/llm-usage/calculate\n- \"List all list?\" -> GET /v1/convai/llm/list\n- \"Create a file?\" -> POST /v1/convai/conversations/{conversation_id}/files\n- \"List all live-count?\" -> GET /v1/convai/analytics/live-count\n- \"List all summaries?\" -> GET /v1/convai/knowledge-base/summaries\n- \"Create a knowledge-base?\" -> POST /v1/convai/knowledge-base\n- \"Search knowledge-base?\" -> GET /v1/convai/knowledge-base\n- \"Create a url?\" -> POST /v1/convai/knowledge-base/url\n- \"Create a crawl?\" -> POST /v1/convai/knowledge-base/crawl\n- \"List all crawl?\" -> GET /v1/convai/knowledge-base/crawl\n- \"Get crawl details?\" -> GET /v1/convai/knowledge-base/crawl/{crawl_job_id}\n- \"Create a cancel?\" -> POST /v1/convai/knowledge-base/crawl/{crawl_job_id}/cancel\n- \"Create a file?\" -> POST /v1/convai/knowledge-base/file\n- \"Create a text?\" -> POST /v1/convai/knowledge-base/text\n- \"Create a folder?\" -> POST /v1/convai/knowledge-base/folder\n- \"Partially update a knowledge-base?\" -> PATCH /v1/convai/knowledge-base/{documentation_id}\n- \"Get knowledge-base details?\" -> GET /v1/convai/knowledge-base/{documentation_id}\n- \"Delete a knowledge-base?\" -> DELETE /v1/convai/knowledge-base/{documentation_id}\n- \"List all chunking-override?\" -> GET /v1/convai/knowledge-base/{documentation_id}/chunking-override\n- \"Create a rag-index?\" -> POST /v1/convai/knowledge-base/rag-index\n- \"List all rag-index?\" -> GET /v1/convai/knowledge-base/rag-index\n- \"Create a refresh?\" -> POST /v1/convai/knowledge-base/{documentation_id}/refresh\n- \"Create a rag-index?\" -> POST /v1/convai/knowledge-base/{documentation_id}/rag-index\n- \"List all rag-index?\" -> GET /v1/convai/knowledge-base/{documentation_id}/rag-index\n- \"Delete a rag-index?\" -> DELETE /v1/convai/knowledge-base/{documentation_id}/rag-index/{rag_index_id}\n- \"Search search?\" -> GET /v1/convai/knowledge-base/search\n- \"Create a rag-query?\" -> POST /v1/convai/agents/{agent_id}/knowledge-base/rag-query\n- \"List all dependent-agents?\" -> GET /v1/convai/knowledge-base/{documentation_id}/dependent-agents\n- \"Create a dependent-agent?\" -> POST /v1/convai/knowledge-base/dependent-agents\n- \"List all content?\" -> GET /v1/convai/knowledge-base/{documentation_id}/content\n- \"List all source-file-url?\" -> GET /v1/convai/knowledge-base/{documentation_id}/source-file-url\n- \"Get chunk details?\" -> GET /v1/convai/knowledge-base/{documentation_id}/chunk/{chunk_id}\n- \"List all chunks?\" -> GET /v1/convai/knowledge-base/{documentation_id}/chunks\n- \"Create a move?\" -> POST /v1/convai/knowledge-base/{document_id}/move\n- \"Create a bulk-move?\" -> POST /v1/convai/knowledge-base/bulk-move\n- \"Create a bulk-delete?\" -> POST /v1/convai/knowledge-base/bulk-delete\n- \"List all topics?\" -> GET /v1/convai/agents/{agent_id}/topics\n- \"Create a tool?\" -> POST /v1/convai/tools\n- \"Search tools?\" -> GET /v1/convai/tools\n- \"Get tool details?\" -> GET /v1/convai/tools/{tool_id}\n- \"Partially update a tool?\" -> PATCH /v1/convai/tools/{tool_id}\n- \"Delete a tool?\" -> DELETE /v1/convai/tools/{tool_id}\n- \"List all dependent-agents?\" -> GET /v1/convai/tools/{tool_id}/dependent-agents\n- \"List all executions?\" -> GET /v1/convai/tools/{tool_id}/executions\n- \"Create a analysis-item?\" -> POST /v1/convai/analysis-items\n- \"Search analysis-items?\" -> GET /v1/convai/analysis-items\n- \"Get analysis-item details?\" -> GET /v1/convai/analysis-items/{analysis_item_id}\n- \"Partially update a analysis-item?\" -> PATCH /v1/convai/analysis-items/{analysis_item_id}\n- \"Delete a analysis-item?\" -> DELETE /v1/convai/analysis-items/{analysis_item_id}\n- \"List all versions?\" -> GET /v1/convai/analysis-items/{analysis_item_id}/versions\n- \"Create a copy?\" -> POST /v1/convai/analysis-items/{analysis_item_id}/copy\n- \"List all dependent-agents?\" -> GET /v1/convai/analysis-items/{analysis_item_id}/dependent-agents\n- \"List all settings?\" -> GET /v1/convai/settings\n- \"List all dashboard?\" -> GET /v1/convai/settings/dashboard\n- \"Create a secret?\" -> POST /v1/convai/secrets\n- \"Search secrets?\" -> GET /v1/convai/secrets\n- \"Get secret details?\" -> GET /v1/convai/secrets/{secret_id}\n- \"Delete a secret?\" -> DELETE /v1/convai/secrets/{secret_id}\n- \"Partially update a secret?\" -> PATCH /v1/convai/secrets/{secret_id}\n- \"Get dependency details?\" -> GET /v1/convai/secrets/{secret_id}/dependencies/{resource_type}\n- \"Create a submit?\" -> POST /v1/convai/batch-calling/submit\n- \"List all workspace?\" -> GET /v1/convai/batch-calling/workspace\n- \"Get batch-calling details?\" -> GET /v1/convai/batch-calling/{batch_id}\n- \"Delete a batch-calling?\" -> DELETE /v1/convai/batch-calling/{batch_id}\n- \"Create a cancel?\" -> POST /v1/convai/batch-calling/{batch_id}/cancel\n- \"Create a retry?\" -> POST /v1/convai/batch-calling/{batch_id}/retry\n- \"List all export?\" -> GET /v1/convai/batch-calling/{batch_id}/export\n- \"Create a outbound-call?\" -> POST /v1/convai/sip-trunk/outbound-call\n- \"Create a mcp-server?\" -> POST /v1/convai/mcp-servers\n- \"List all mcp-servers?\" -> GET /v1/convai/mcp-servers\n- \"Get mcp-server details?\" -> GET /v1/convai/mcp-servers/{mcp_server_id}\n- \"Delete a mcp-server?\" -> DELETE /v1/convai/mcp-servers/{mcp_server_id}\n- \"Partially update a mcp-server?\" -> PATCH /v1/convai/mcp-servers/{mcp_server_id}\n- \"List all tools?\" -> GET /v1/convai/mcp-servers/{mcp_server_id}/tools\n- \"Create a tool-approval?\" -> POST /v1/convai/mcp-servers/{mcp_server_id}/tool-approvals\n- \"Delete a tool-approval?\" -> DELETE /v1/convai/mcp-servers/{mcp_server_id}/tool-approvals/{tool_name}\n- \"Create a tool-config?\" -> POST /v1/convai/mcp-servers/{mcp_server_id}/tool-configs\n- \"Get tool-config details?\" -> GET /v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}\n- \"Partially update a tool-config?\" -> PATCH /v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}\n- \"Delete a tool-config?\" -> DELETE /v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}\n- \"Get whatsapp-account details?\" -> GET /v1/convai/whatsapp-accounts/{phone_number_id}\n- \"Partially update a whatsapp-account?\" -> PATCH /v1/convai/whatsapp-accounts/{phone_number_id}\n- \"Delete a whatsapp-account?\" -> DELETE /v1/convai/whatsapp-accounts/{phone_number_id}\n- \"List all whatsapp-accounts?\" -> GET /v1/convai/whatsapp-accounts\n- \"Create a branche?\" -> POST /v1/convai/agents/{agent_id}/branches\n- \"List all branches?\" -> GET /v1/convai/agents/{agent_id}/branches\n- \"Get branche details?\" -> GET /v1/convai/agents/{agent_id}/branches/{branch_id}\n- \"Partially update a branche?\" -> PATCH /v1/convai/agents/{agent_id}/branches/{branch_id}\n- \"Get version details?\" -> GET /v1/convai/agents/{agent_id}/versions/{version_id}\n- \"List all merge-preview?\" -> GET /v1/convai/agents/{agent_id}/branches/{source_branch_id}/merge-preview\n- \"Create a merge?\" -> POST /v1/convai/agents/{agent_id}/branches/{source_branch_id}/merge\n- \"List all rebase-preview?\" -> GET /v1/convai/agents/{agent_id}/branches/{branch_id}/rebase-preview\n- \"Create a rebase?\" -> POST /v1/convai/agents/{agent_id}/branches/{branch_id}/rebase\n- \"Create a deployment?\" -> POST /v1/convai/agents/{agent_id}/deployments\n- \"List all deployments?\" -> GET /v1/convai/agents/{agent_id}/deployments\n- \"Create a draft?\" -> POST /v1/convai/agents/{agent_id}/drafts\n- \"Create a merge-proposal?\" -> POST /v1/convai/agents/{agent_id}/merge-proposals\n- \"Search merge-proposals?\" -> GET /v1/convai/agents/{agent_id}/merge-proposals\n- \"Get merge-proposal details?\" -> GET /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}\n- \"Partially update a merge-proposal?\" -> PATCH /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}\n- \"Create a review?\" -> POST /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/reviews\n- \"Create a comment?\" -> POST /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/comments\n- \"Create a merge?\" -> POST /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/merge\n- \"List all config?\" -> GET /v1/convai/outbound-campaigns/config\n- \"Search campaigns?\" -> GET /v1/convai/outbound-campaigns/campaigns\n- \"Create a pause-all?\" -> POST /v1/convai/outbound-campaigns/campaigns/pause-all\n- \"Create a stop-all?\" -> POST /v1/convai/outbound-campaigns/campaigns/stop-all\n- \"Create a submit?\" -> POST /v1/convai/outbound-campaigns/campaigns/submit\n- \"Get campaign details?\" -> GET /v1/convai/outbound-campaigns/campaigns/{campaign_id}\n- \"List all progress?\" -> GET /v1/convai/outbound-campaigns/campaigns/{campaign_id}/progress\n- \"Search leads?\" -> GET /v1/convai/outbound-campaigns/campaigns/{campaign_id}/leads\n- \"List all calls?\" -> GET /v1/convai/outbound-campaigns/campaigns/{campaign_id}/calls\n- \"List all follow-up-requests?\" -> GET /v1/convai/outbound-campaigns/campaigns/{campaign_id}/follow-up-requests\n- \"List all export?\" -> GET /v1/convai/outbound-campaigns/campaigns/{campaign_id}/export\n- \"Get lead details?\" -> GET /v1/convai/outbound-campaigns/campaigns/{campaign_id}/leads/{lead_id}\n- \"Delete a lead?\" -> DELETE /v1/convai/outbound-campaigns/campaigns/{campaign_id}/leads/{lead_id}\n- \"Create a pause?\" -> POST /v1/convai/outbound-campaigns/campaigns/{campaign_id}/pause\n- \"Create a resume?\" -> POST /v1/convai/outbound-campaigns/campaigns/{campaign_id}/resume\n- \"Create a stop?\" -> POST /v1/convai/outbound-campaigns/campaigns/{campaign_id}/stop\n- \"List all attention?\" -> GET /v1/convai/outbound-campaigns/attention\n- \"Create a retry?\" -> POST /v1/convai/outbound-campaigns/attention/{attention_id}/retry\n- \"Create a resolve?\" -> POST /v1/convai/outbound-campaigns/attention/{attention_id}/resolve\n- \"Search speech-engine?\" -> GET /v1/speech-engine\n- \"Create a speech-engine?\" -> POST /v1/speech-engine\n- \"Get speech-engine details?\" -> GET /v1/speech-engine/{speech_engine_id}\n- \"Partially update a speech-engine?\" -> PATCH /v1/speech-engine/{speech_engine_id}\n- \"Delete a speech-engine?\" -> DELETE /v1/speech-engine/{speech_engine_id}\n- \"Create a duplicate?\" -> POST /v1/speech-engine/{speech_engine_id}/duplicate\n- \"Create a message?\" -> POST /v1/convai/conversations/{conversation_id}/messages\n- \"Create a stream?\" -> POST /v1/convai/conversations/{conversation_id}/messages/stream\n- \"Get turn details?\" -> GET /v1/convai/conversations/{conversation_id}/turns/{turn_id}\n- \"List all events?\" -> GET /v1/convai/conversations/{conversation_id}/turns/{turn_id}/events\n- \"Create a procedure?\" -> POST /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures\n- \"List all procedures?\" -> GET /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures\n- \"Create a compile?\" -> POST /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/compile\n- \"Delete a procedure?\" -> DELETE /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}\n- \"Get procedure details?\" -> GET /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}\n- \"List all draft?\" -> GET /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft\n- \"Create a run?\" -> POST /v1/convai/conversations/{conversation_id}/analysis/run\n- \"Create a run?\" -> POST /v1/convai/conversations/{conversation_id}/analysis/evaluations/run\n- \"List all environment-variables?\" -> GET /v1/convai/environment-variables\n- \"Create a environment-variable?\" -> POST /v1/convai/environment-variables\n- \"Get environment-variable details?\" -> GET /v1/convai/environment-variables/{env_var_id}\n- \"Partially update a environment-variable?\" -> PATCH /v1/convai/environment-variables/{env_var_id}\n- \"Delete a environment-variable?\" -> DELETE /v1/convai/environment-variables/{env_var_id}\n- \"List all environments?\" -> GET /v1/convai/environments\n- \"Create a environment?\" -> POST /v1/convai/environments\n- \"Delete a environment?\" -> DELETE /v1/convai/environments/{environment}\n- \"Search conversation-groups?\" -> GET /v1/convai/realtime/conversation-groups\n- \"Create a conversation-group?\" -> POST /v1/convai/realtime/conversation-groups\n- \"Get conversation-group details?\" -> GET /v1/convai/realtime/conversation-groups/{conversation_group_id}\n- \"Partially update a conversation-group?\" -> PATCH /v1/convai/realtime/conversation-groups/{conversation_group_id}\n- \"Delete a conversation-group?\" -> DELETE /v1/convai/realtime/conversation-groups/{conversation_group_id}\n- \"Create a client_secret?\" -> POST /v1/convai/realtime/client_secrets\n- \"Create a plan?\" -> POST /v1/music/plan\n- \"Create a music?\" -> POST /v1/music\n- \"Create a detailed?\" -> POST /v1/music/detailed\n- \"Create a stream?\" -> POST /v1/music/detailed/stream\n- \"Create a stream?\" -> POST /v1/music/stream\n- \"Create a upload?\" -> POST /v1/music/upload\n- \"Create a stem-separation?\" -> POST /v1/music/stem-separation\n- \"List all finetunes?\" -> GET /v1/music/finetunes\n- \"Create a finetune?\" -> POST /v1/music/finetunes\n- \"Get finetune details?\" -> GET /v1/music/finetunes/{finetune_id}\n- \"Partially update a finetune?\" -> PATCH /v1/music/finetunes/{finetune_id}\n- \"Delete a finetune?\" -> DELETE /v1/music/finetunes/{finetune_id}\n- \"Create a order?\" -> POST /v1/productions/orders\n- \"List all orders?\" -> GET /v1/productions/orders\n- \"Get order details?\" -> GET /v1/productions/orders/{order_id}\n- \"Partially update a order?\" -> PATCH /v1/productions/orders/{order_id}\n- \"Create a media?\" -> POST /v1/productions/orders/{order_id}/media\n- \"Get media details?\" -> GET /v1/productions/orders/{order_id}/media/{media_id}\n- \"Create a item?\" -> POST /v1/productions/orders/{order_id}/items\n- \"Delete a item?\" -> DELETE /v1/productions/orders/{order_id}/items/{item_id}\n- \"Create a submit?\" -> POST /v1/productions/orders/{order_id}/submit\n- \"List all deliverables?\" -> GET /v1/productions/orders/{order_id}/deliverables\n- \"Get language details?\" -> GET /v1/productions/orders/languages/{order_item_kind}\n- \"Create a pvc?\" -> POST /v1/voices/pvc\n- \"Create a sample?\" -> POST /v1/voices/pvc/{voice_id}/samples\n- \"Delete a sample?\" -> DELETE /v1/voices/pvc/{voice_id}/samples/{sample_id}\n- \"List all audio?\" -> GET /v1/voices/pvc/{voice_id}/samples/{sample_id}/audio\n- \"List all waveform?\" -> GET /v1/voices/pvc/{voice_id}/samples/{sample_id}/waveform\n- \"List all speakers?\" -> GET /v1/voices/pvc/{voice_id}/samples/{sample_id}/speakers\n- \"Create a separate-speaker?\" -> POST /v1/voices/pvc/{voice_id}/samples/{sample_id}/separate-speakers\n- \"List all audio?\" -> GET /v1/voices/pvc/{voice_id}/samples/{sample_id}/speakers/{speaker_id}/audio\n- \"List all captcha?\" -> GET /v1/voices/pvc/{voice_id}/captcha\n- \"Create a captcha?\" -> POST /v1/voices/pvc/{voice_id}/captcha\n- \"Create a train?\" -> POST /v1/voices/pvc/{voice_id}/train\n- \"Create a verification?\" -> POST /v1/voices/pvc/{voice_id}/verification\n- \"Create a video?\" -> POST /v1/flows/video\n- \"List all video?\" -> GET /v1/flows/video\n- \"Get video details?\" -> GET /v1/flows/video/{generation_id}\n- \"Create a image?\" -> POST /v1/flows/image\n- \"List all image?\" -> GET /v1/flows/image\n- \"Get image details?\" -> GET /v1/flows/image/{generation_id}\n- \"Create a text-to-speech?\" -> POST /v1/flows/text-to-speech\n- \"List all text-to-speech?\" -> GET /v1/flows/text-to-speech\n- \"Get text-to-speech details?\" -> GET /v1/flows/text-to-speech/{generation_id}\n- \"Create a run?\" -> POST /v1/flows/templates/{template_id}/runs\n- \"List all runs?\" -> GET /v1/flows/templates/{template_id}/runs\n- \"Get run details?\" -> GET /v1/flows/templates/{template_id}/runs/{run_id}\n- \"Search templates?\" -> GET /v1/flows/templates\n- \"Get template details?\" -> GET /v1/flows/templates/{template_id}\n- \"Create a asset?\" -> POST /v1/assets\n- \"Search assets?\" -> GET /v1/assets\n- \"Get asset details?\" -> GET /v1/assets/{asset_id}\n- \"Delete a asset?\" -> DELETE /v1/assets/{asset_id}\n- \"Create a usage-by-product-over-time?\" -> POST /v1/workspace/analytics/query/usage-by-product-over-time\n- \"Create a usage?\" -> POST /v1/workspace/analytics/usage\n- \"Create a request?\" -> POST /v1/workspace/analytics/requests\n- \"Create a test?\" -> POST /v1/workspace/webhooks/{webhook_id}/test\n- \"Create a redeliver?\" -> POST /v1/workspace/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliver\n- \"List all services?\" -> GET /v1/reception/services\n- \"Create a service?\" -> POST /v1/reception/services\n- \"Get service details?\" -> GET /v1/reception/services/{service_id}\n- \"Update a service?\" -> PUT /v1/reception/services/{service_id}\n- \"Delete a service?\" -> DELETE /v1/reception/services/{service_id}\n- \"Create a confirm-update?\" -> POST /v1/reception/services/{service_id}/confirm-update\n- \"List all assets?\" -> GET /v1/reception/assets\n- \"Create a asset?\" -> POST /v1/reception/assets\n- \"Get asset details?\" -> GET /v1/reception/assets/{asset_id}\n- \"Update a asset?\" -> PUT /v1/reception/assets/{asset_id}\n- \"Delete a asset?\" -> DELETE /v1/reception/assets/{asset_id}\n- \"List all products?\" -> GET /v1/reception/products\n- \"Create a product?\" -> POST /v1/reception/products\n- \"Get product details?\" -> GET /v1/reception/products/{product_id}\n- \"Update a product?\" -> PUT /v1/reception/products/{product_id}\n- \"Delete a product?\" -> DELETE /v1/reception/products/{product_id}\n- \"Create a adjust?\" -> POST /v1/reception/products/{product_id}/stock/adjust\n- \"List all staff?\" -> GET /v1/reception/staff\n- \"Create a staff?\" -> POST /v1/reception/staff\n- \"Get staff details?\" -> GET /v1/reception/staff/{staff_id}\n- \"Update a staff?\" -> PUT /v1/reception/staff/{staff_id}\n- \"Delete a staff?\" -> DELETE /v1/reception/staff/{staff_id}\n- \"List all customer-facing-agents?\" -> GET /v1/reception/customer-facing-agents\n- \"Partially update a customer-facing-agent?\" -> PATCH /v1/reception/customer-facing-agents/{agent_id}\n- \"Create a activate?\" -> POST /v1/reception/customer-facing-agents/{agent_id}/activate\n- \"Create a rule?\" -> POST /v1/reception/customer-facing-agents/{agent_id}/rules\n- \"Update a rule?\" -> PUT /v1/reception/customer-facing-agents/{agent_id}/rules/{rule_id}\n- \"Delete a rule?\" -> DELETE /v1/reception/customer-facing-agents/{agent_id}/rules/{rule_id}\n- \"List all procedures?\" -> GET /v1/reception/customer-facing-agents/{agent_id}/procedures\n- \"Create a procedure?\" -> POST /v1/reception/customer-facing-agents/{agent_id}/procedures\n- \"Update a procedure?\" -> PUT /v1/reception/customer-facing-agents/{agent_id}/procedures/{procedure_id}\n- \"Delete a procedure?\" -> DELETE /v1/reception/customer-facing-agents/{agent_id}/procedures/{procedure_id}\n- \"Create a transfer-rule?\" -> POST /v1/reception/customer-facing-agents/{agent_id}/transfer-rules\n- \"Update a transfer-rule?\" -> PUT /v1/reception/customer-facing-agents/{agent_id}/transfer-rules/{rule_id}\n- \"Delete a transfer-rule?\" -> DELETE /v1/reception/customer-facing-agents/{agent_id}/transfer-rules/{rule_id}\n- \"List all assignments?\" -> GET /v1/reception/phone-numbers/assignments\n- \"Create a assignment?\" -> POST /v1/reception/phone-numbers/assignments\n- \"Delete a assignment?\" -> DELETE /v1/reception/phone-numbers/assignments/{phone_assignment_id}\n- \"Partially update a assignment?\" -> PATCH /v1/reception/phone-numbers/assignments/{phone_assignment_id}\n- \"List all holidays?\" -> GET /v1/reception/holidays\n- \"Create a holiday?\" -> POST /v1/reception/holidays\n- \"Get holiday details?\" -> GET /v1/reception/holidays/{holiday_id}\n- \"Update a holiday?\" -> PUT /v1/reception/holidays/{holiday_id}\n- \"Delete a holiday?\" -> DELETE /v1/reception/holidays/{holiday_id}\n- \"List all locations?\" -> GET /v1/reception/locations\n- \"Create a location?\" -> POST /v1/reception/locations\n- \"Get location details?\" -> GET /v1/reception/locations/{location_id}\n- \"Update a location?\" -> PUT /v1/reception/locations/{location_id}\n- \"Delete a location?\" -> DELETE /v1/reception/locations/{location_id}\n- \"List all agent-info?\" -> GET /v1/reception/agent-info\n- \"List all knowledge-sources?\" -> GET /v1/reception/knowledge-sources\n- \"Create a knowledge-source?\" -> POST /v1/reception/knowledge-sources\n- \"Get knowledge-source details?\" -> GET /v1/reception/knowledge-sources/{source_id}\n- \"Delete a knowledge-source?\" -> DELETE /v1/reception/knowledge-sources/{source_id}\n- \"Create a url?\" -> POST /v1/reception/knowledge-sources/urls\n- \"List all workspaces?\" -> GET /v1/reception/reseller/workspaces\n- \"Create a workspace?\" -> POST /v1/reception/reseller/workspaces\n- \"Create a complete-onboarding?\" -> POST /v1/reception/reseller/workspaces/{workspace_id}/complete-onboarding\n- \"Create a subscription?\" -> POST /v1/reception/reseller/workspaces/{workspace_id}/subscription\n- \"Create a restore?\" -> POST /v1/reception/reseller/workspaces/{workspace_id}/subscription/restore\n- \"Create a cancel-downgrade?\" -> POST /v1/reception/reseller/workspaces/{workspace_id}/subscription/cancel-downgrade\n- \"List all tier-ladder?\" -> GET /v1/reception/reseller/tier-ladder\n- \"List all invoices?\" -> GET /v1/reception/reseller/billing/invoices\n- \"Get invoice details?\" -> GET /v1/reception/reseller/billing/invoices/{invoice_id}\n- \"List all upcoming?\" -> GET /v1/reception/reseller/billing/upcoming\n- \"List all members?\" -> GET /v1/reception/team/members\n- \"List all invites?\" -> GET /v1/reception/team/invites\n- \"Create a invite?\" -> POST /v1/reception/team/invites\n- \"Partially update a member?\" -> PATCH /v1/reception/team/members/{user_id}\n- \"Delete a member?\" -> DELETE /v1/reception/team/members/{user_id}\n- \"List all docs?\" -> GET /docs\n- \"How to authenticate?\" -> See Auth section\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- List endpoints may support pagination; check for limit, offset, or cursor params\n- Create/update endpoints typically return the created/updated object\n\n## CLI\n\n```bash\n# Update this spec to the latest version\nnpx @lap-platform/lapsh get elevenlabs-api-documentation -o references/api-spec.lap\n\n# Search for related APIs\nnpx @lap-platform/lapsh search elevenlabs-api-documentation\n```\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api ElevenLabs API Documentation\n@version 1.0\n@auth ApiKey xi-api-key in header\n@common_fields {xi-api-key: any # Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.}\n@endpoints 547\n@hint download_for_search\n@toc history(5), sound-generation(1), audio-isolation(4), audio-effects(1), voices(35), text-to-speech(4), text-to-dialogue(4), voice-changer(2), text-to-voice(5), user(2), studio(23), dubbing(37), models(1), audio-native(4), content-provenance(1), similar-voices(1), shared-voices(1), usage(1), pronunciation-dictionaries(9), workspaces(2), service-accounts(7), workspace(27), music(13), speech-to-text(3), single-use-token(1), forced-alignment(1), convai(241), speech-engine(6), productions(11), flows(14), assets(4), reception(75), docs(1)\n\n@group history\n@endpoint GET /v1/history\n@desc List Generated Items\n@optional {page_size: int=100 # How many history items to return at maximum. Can not exceed 1000, defaults to 100., start_after_history_item_id: any # After which ID to start fetching, use this parameter to paginate across a large collection of history items. In case this parameter is not provided history items will be fetched starting from the most recently created one ordered descending by their creation date., voice_id: any # Voice ID to be filtered for, you can use GET https://api.elevenlabs.io/v1/voices to receive a list of voices and their IDs., model_id: any # Model ID to filter history items by., date_before_unix: any # Unix timestamp to filter history items before this date (exclusive)., date_after_unix: any # Unix timestamp to filter history items after this date (inclusive)., sort_direction: any=desc # Sort direction for the results., search: any # search term used for filtering, source: any # Source of the generated history item}\n@returns(200) {history: [map], last_history_item_id: any, has_more: bool, scanned_until: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/history/{history_item_id}\n@desc Get History Item\n@required {history_item_id: str # History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs.}\n@returns(200) {history_item_id: str, request_id: any, voice_id: any, model_id: any, voice_name: any, voice_category: any, text: any, date_unix: int, character_count_change_from: int, character_count_change_to: int, content_type: str, state: str, settings: any, share_link_id: any, source: any, alignments: any, dialogue: any, output_format: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/history/{history_item_id}\n@desc Delete History Item\n@required {history_item_id: str # History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/history/{history_item_id}/audio\n@desc Get Audio From History Item\n@required {history_item_id: str # History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs.}\n@returns(200) The audio file of the history item.\n@errors {422: Validation Error}\n\n@endpoint POST /v1/history/download\n@desc Download History Items\n@required {history_item_ids: [str] # A list of history items to download, you can get IDs of history items and other metadata using the GET https://api.elevenlabs.io/v1/history endpoint.}\n@optional {output_format: any # Output format to transcode the audio file, can be wav or default.}\n@returns(200) The requested audio file, or a zip file containing multiple audio files when multiple history items are requested.\n@errors {400: Invalid request, 422: Validation Error}\n\n@endgroup\n\n@group sound-generation\n@endpoint POST /v1/sound-generation\n@desc Sound Generation\n@required {text: str # The text that will get converted into a sound effect.}\n@optional {output_format: any(alaw_8000/mp3_22050_32/mp3_24000_48/mp3_44100_128/mp3_44100_192/mp3_44100_32/mp3_44100_64/mp3_44100_96/opus_48000_128/opus_48000_192/opus_48000_32/opus_48000_64/opus_48000_96/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/pcm_8000/ulaw_8000/wav_16000/wav_22050/wav_24000/wav_32000/wav_44100/wav_48000/wav_8000)=mp3_44100_128 # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM and WAV formats with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs., enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. Zero retention mode may only be used by enterprise customers., loop: bool=false # Whether to create a sound effect that loops smoothly., duration_seconds: any # The duration of the sound which will be generated in seconds. Must be at least 0.5 and at most 30. If set to None we will guess the optimal duration using the prompt. Defaults to None., prompt_influence: any=0.3 # A higher prompt influence makes your generation follow the prompt more closely while also making generations less variable. Must be a value between 0 and 1. Defaults to 0.3., model_id: str(eleven_text_to_sound_v2/eleven_text_to_sound_v3)=eleven_text_to_sound_v2}\n@returns(200) The generated sound effect audio, encoded in the specified `output_format`.\n@errors {422: Validation Error}\n\n@endgroup\n\n@group audio-isolation\n@endpoint POST /v1/audio-isolation\n@desc Audio Isolation\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/audio-isolation/history\n@desc Get Audio Isolation History\n@optional {page_size: int=100 # How many history items to return at maximum. Defaults to 100., page: int=1 # Page number for search pagination (1-based). Only used when search is provided., search: any # Optional search term used for filtering audio isolation history (title/text).}\n@returns(200) {items: [map], has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/audio-isolation/history/{history_item_id}\n@desc Delete Audio Isolation History Item\n@required {history_item_id: str # Identifier of the audio isolation history item.}\n@returns(204) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/audio-isolation/stream\n@desc Audio Isolation Stream\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group audio-effects\n@endpoint GET /v1/audio-effects/catalog\n@desc Get Audio Effects Catalog\n@returns(200) {filter_presets: [map], environments: [map], background_noises: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group voices\n@endpoint DELETE /v1/voices/{voice_id}/samples/{sample_id}\n@desc Delete Sample\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices., sample_id: str # Sample ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/{voice_id} to list all the available samples for a voice.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/voices/{voice_id}/samples/{sample_id}/audio\n@desc Get Audio From Sample\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices., sample_id: str # Sample ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/{voice_id} to list all the available samples for a voice.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group text-to-speech\n@endpoint POST /v1/text-to-speech/{voice_id}\n@desc Text To Speech\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices., text: str # The text that will get converted into speech.}\n@optional {enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers., optimize_streaming_latency: any # You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model. Possible values: 0 - default mode (no latency optimizations) 1 - normal latency optimizations (about 50% of possible latency improvement of option 3) 2 - strong latency optimizations (about 75% of possible latency improvement of option 3) 3 - max latency optimizations 4 - max latency optimizations, but also with text normalizer turned off for even more latency savings (best latency, but can mispronounce eg numbers and dates).  Defaults to None., output_format: str(alaw_8000/mp3_22050_32/mp3_24000_48/mp3_44100_128/mp3_44100_192/mp3_44100_32/mp3_44100_64/mp3_44100_96/opus_48000_128/opus_48000_192/opus_48000_32/opus_48000_64/opus_48000_96/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/pcm_8000/ulaw_8000/wav_16000/wav_22050/wav_24000/wav_32000/wav_44100/wav_48000/wav_8000)=mp3_44100_128 # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM and WAV formats with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs., model_id: str=eleven_multilingual_v2 # Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property., language_code: any # Language code (ISO 639-1) used to enforce a language for the model and text normalization. If the model does not support the provided language code, it will be ignored. This parameter is not supported for multilingual_v2 models., voice_settings: any # Voice settings overriding stored settings for the given voice. They are applied only on the given request., pronunciation_dictionary_locators: any # A list of pronunciation dictionary locators (id, version_id) to be applied to the text. They will be applied in order. You may have up to 3 locators per request, seed: any # If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed. Must be integer between 0 and 4294967295., previous_text: any # The text that came before the text of the current request. Can be used to improve the speech's continuity when concatenating together multiple generations or to influence the speech's continuity in the current generation., next_text: any # The text that comes after the text of the current request. Can be used to improve the speech's continuity when concatenating together multiple generations or to influence the speech's continuity in the current generation., previous_request_ids: any # A list of request_id of the samples that were generated before this generation. Can be used to improve the speech's continuity when splitting up a large task into multiple requests. The results will be best when the same model is used across the generations. In case both previous_text and previous_request_ids is send, previous_text will be ignored. A maximum of 3 request_ids can be sent., next_request_ids: any # A list of request_id of the samples that come after this generation. next_request_ids is especially useful for maintaining the speech's continuity when regenerating a sample that has had some audio quality issues. For example, if you have generated 3 speech clips, and you want to improve clip 2, passing the request id of clip 3 as a next_request_id (and that of clip 1 as a previous_request_id) will help maintain natural flow in the combined speech. The results will be best when the same model is used across the generations. In case both next_text and next_request_ids is send, next_text will be ignored. A maximum of 3 request_ids can be sent., use_pvc_as_ivc: any # Whether to use the IVC version of a professional voice. This may improve expressiveness and reduce latency., apply_text_normalization: str(auto/on/off)=auto # This parameter controls text normalization with three modes: 'auto', 'on', and 'off'. When set to 'auto', the system will automatically decide whether to apply text normalization (e.g., spelling out numbers). With 'on', text normalization will always be applied, while with 'off', it will be skipped., apply_language_text_normalization: bool=false # This parameter controls language text normalization. This helps with proper pronunciation of text in some supported languages. WARNING: This parameter can heavily increase the latency of the request. Currently only supported for Japanese., audio_effects: any # Audio effects applied to the generated audio. Unknown IDs return 404 with `param` naming the field. Reverb (`environment_id` with `send_level` above 0) and a non-zero `pan` produce stereo audio and are rejected with 400 for `ulaw_*`, `alaw_*`, and `pcm_*` output formats. Effects don't change the cost of the request.}\n@returns(200) The generated audio file\n@errors {422: Validation Error}\n\n@endpoint POST /v1/text-to-speech/{voice_id}/with-timestamps\n@desc Text To Speech With Timestamps\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices., text: str # The text that will get converted into speech.}\n@optional {enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers., optimize_streaming_latency: any # You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model. Possible values: 0 - default mode (no latency optimizations) 1 - normal latency optimizations (about 50% of possible latency improvement of option 3) 2 - strong latency optimizations (about 75% of possible latency improvement of option 3) 3 - max latency optimizations 4 - max latency optimizations, but also with text normalizer turned off for even more latency savings (best latency, but can mispronounce eg numbers and dates).  Defaults to None., output_format: str(alaw_8000/mp3_22050_32/mp3_24000_48/mp3_44100_128/mp3_44100_192/mp3_44100_32/mp3_44100_64/mp3_44100_96/opus_48000_128/opus_48000_192/opus_48000_32/opus_48000_64/opus_48000_96/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/pcm_8000/ulaw_8000/wav_16000/wav_22050/wav_24000/wav_32000/wav_44100/wav_48000/wav_8000)=mp3_44100_128 # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM and WAV formats with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs., model_id: str=eleven_multilingual_v2 # Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property., language_code: any # Language code (ISO 639-1) used to enforce a language for the model and text normalization. If the model does not support the provided language code, it will be ignored. This parameter is not supported for multilingual_v2 models., voice_settings: any # Voice settings overriding stored settings for the given voice. They are applied only on the given request., pronunciation_dictionary_locators: [map{pronunciation_dictionary_id!: str, version_id: any}] # A list of pronunciation dictionary locators (id, version_id) to be applied to the text. They will be applied in order. You may have up to 3 locators per request, seed: any # If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed. Must be integer between 0 and 4294967295., previous_text: any # The text that came before the text of the current request. Can be used to improve the speech's continuity when concatenating together multiple generations or to influence the speech's continuity in the current generation., next_text: any # The text that comes after the text of the current request. Can be used to improve the speech's continuity when concatenating together multiple generations or to influence the speech's continuity in the current generation., previous_request_ids: [str] # A list of request_id of the samples that were generated before this generation. Can be used to improve the speech's continuity when splitting up a large task into multiple requests. The results will be best when the same model is used across the generations. In case both previous_text and previous_request_ids is send, previous_text will be ignored. A maximum of 3 request_ids can be sent., next_request_ids: [str] # A list of request_id of the samples that come after this generation. next_request_ids is especially useful for maintaining the speech's continuity when regenerating a sample that has had some audio quality issues. For example, if you have generated 3 speech clips, and you want to improve clip 2, passing the request id of clip 3 as a next_request_id (and that of clip 1 as a previous_request_id) will help maintain natural flow in the combined speech. The results will be best when the same model is used across the generations. In case both next_text and next_request_ids is send, next_text will be ignored. A maximum of 3 request_ids can be sent., use_pvc_as_ivc: any # Whether to use the IVC version of a professional voice. This may improve expressiveness and reduce latency., apply_text_normalization: str(auto/on/off)=auto # This parameter controls text normalization with three modes: 'auto', 'on', and 'off'. When set to 'auto', the system will automatically decide whether to apply text normalization (e.g., spelling out numbers). With 'on', text normalization will always be applied, while with 'off', it will be skipped., apply_language_text_normalization: bool=false # This parameter controls language text normalization. This helps with proper pronunciation of text in some supported languages. WARNING: This parameter can heavily increase the latency of the request. Currently only supported for Japanese., audio_effects: any # Audio effects applied to the generated audio. Unknown IDs return 404 with `param` naming the field. Reverb (`environment_id` with `send_level` above 0) and a non-zero `pan` produce stereo audio and are rejected with 400 for `ulaw_*`, `alaw_*`, and `pcm_*` output formats. Effects don't change the cost of the request.}\n@returns(200) {audio_base64: str, alignment: any, normalized_alignment: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/text-to-speech/{voice_id}/stream\n@desc Text To Speech Streaming\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices., text: str # The text that will get converted into speech.}\n@optional {enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers., optimize_streaming_latency: any # You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model. Possible values: 0 - default mode (no latency optimizations) 1 - normal latency optimizations (about 50% of possible latency improvement of option 3) 2 - strong latency optimizations (about 75% of possible latency improvement of option 3) 3 - max latency optimizations 4 - max latency optimizations, but also with text normalizer turned off for even more latency savings (best latency, but can mispronounce eg numbers and dates).  Defaults to None., output_format: str(mp3_22050_32/mp3_24000_48/mp3_44100_32/mp3_44100_64/mp3_44100_96/mp3_44100_128/mp3_44100_192/pcm_8000/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/ulaw_8000/alaw_8000/opus_48000_32/opus_48000_64/opus_48000_96/opus_48000_128/opus_48000_192)=mp3_44100_128 # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs., model_id: str=eleven_multilingual_v2 # Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property., language_code: any # Language code (ISO 639-1) used to enforce a language for the model and text normalization. If the model does not support the provided language code, it will be ignored. This parameter is not supported for multilingual_v2 models., voice_settings: any # Voice settings overriding stored settings for the given voice. They are applied only on the given request., pronunciation_dictionary_locators: any # A list of pronunciation dictionary locators (id, version_id) to be applied to the text. They will be applied in order. You may have up to 3 locators per request, seed: any # If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed. Must be integer between 0 and 4294967295., previous_text: any # The text that came before the text of the current request. Can be used to improve the speech's continuity when concatenating together multiple generations or to influence the speech's continuity in the current generation., next_text: any # The text that comes after the text of the current request. Can be used to improve the speech's continuity when concatenating together multiple generations or to influence the speech's continuity in the current generation., previous_request_ids: any # A list of request_id of the samples that were generated before this generation. Can be used to improve the speech's continuity when splitting up a large task into multiple requests. The results will be best when the same model is used across the generations. In case both previous_text and previous_request_ids is send, previous_text will be ignored. A maximum of 3 request_ids can be sent., next_request_ids: any # A list of request_id of the samples that come after this generation. next_request_ids is especially useful for maintaining the speech's continuity when regenerating a sample that has had some audio quality issues. For example, if you have generated 3 speech clips, and you want to improve clip 2, passing the request id of clip 3 as a next_request_id (and that of clip 1 as a previous_request_id) will help maintain natural flow in the combined speech. The results will be best when the same model is used across the generations. In case both next_text and next_request_ids is send, next_text will be ignored. A maximum of 3 request_ids can be sent., use_pvc_as_ivc: any # Whether to use the IVC version of a professional voice. This may improve expressiveness and reduce latency., apply_text_normalization: str(auto/on/off)=auto # This parameter controls text normalization with three modes: 'auto', 'on', and 'off'. When set to 'auto', the system will automatically decide whether to apply text normalization (e.g., spelling out numbers). With 'on', text normalization will always be applied, while with 'off', it will be skipped., apply_language_text_normalization: bool=false # This parameter controls language text normalization. This helps with proper pronunciation of text in some supported languages. WARNING: This parameter can heavily increase the latency of the request. Currently only supported for Japanese., audio_effects: any # Audio effects applied to the generated audio. Unknown IDs return 404 with `param` naming the field. Reverb (`environment_id` with `send_level` above 0) and a non-zero `pan` produce stereo audio and are rejected with 400 for `ulaw_*`, `alaw_*`, and `pcm_*` output formats. Effects don't change the cost of the request.}\n@returns(200) Streaming audio data\n@errors {422: Validation Error}\n\n@endpoint POST /v1/text-to-speech/{voice_id}/stream/with-timestamps\n@desc Text To Speech Streaming With Timestamps\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices., text: str # The text that will get converted into speech.}\n@optional {enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers., optimize_streaming_latency: any # You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model. Possible values: 0 - default mode (no latency optimizations) 1 - normal latency optimizations (about 50% of possible latency improvement of option 3) 2 - strong latency optimizations (about 75% of possible latency improvement of option 3) 3 - max latency optimizations 4 - max latency optimizations, but also with text normalizer turned off for even more latency savings (best latency, but can mispronounce eg numbers and dates).  Defaults to None., output_format: str(mp3_22050_32/mp3_24000_48/mp3_44100_32/mp3_44100_64/mp3_44100_96/mp3_44100_128/mp3_44100_192/pcm_8000/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/ulaw_8000/alaw_8000/opus_48000_32/opus_48000_64/opus_48000_96/opus_48000_128/opus_48000_192)=mp3_44100_128 # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs., model_id: str=eleven_multilingual_v2 # Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property., language_code: any # Language code (ISO 639-1) used to enforce a language for the model and text normalization. If the model does not support the provided language code, it will be ignored. This parameter is not supported for multilingual_v2 models., voice_settings: any # Voice settings overriding stored settings for the given voice. They are applied only on the given request., pronunciation_dictionary_locators: any # A list of pronunciation dictionary locators (id, version_id) to be applied to the text. They will be applied in order. You may have up to 3 locators per request, seed: any # If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed. Must be integer between 0 and 4294967295., previous_text: any # The text that came before the text of the current request. Can be used to improve the speech's continuity when concatenating together multiple generations or to influence the speech's continuity in the current generation., next_text: any # The text that comes after the text of the current request. Can be used to improve the speech's continuity when concatenating together multiple generations or to influence the speech's continuity in the current generation., previous_request_ids: any # A list of request_id of the samples that were generated before this generation. Can be used to improve the speech's continuity when splitting up a large task into multiple requests. The results will be best when the same model is used across the generations. In case both previous_text and previous_request_ids is send, previous_text will be ignored. A maximum of 3 request_ids can be sent., next_request_ids: any # A list of request_id of the samples that come after this generation. next_request_ids is especially useful for maintaining the speech's continuity when regenerating a sample that has had some audio quality issues. For example, if you have generated 3 speech clips, and you want to improve clip 2, passing the request id of clip 3 as a next_request_id (and that of clip 1 as a previous_request_id) will help maintain natural flow in the combined speech. The results will be best when the same model is used across the generations. In case both next_text and next_request_ids is send, next_text will be ignored. A maximum of 3 request_ids can be sent., use_pvc_as_ivc: any # Whether to use the IVC version of a professional voice. This may improve expressiveness and reduce latency., apply_text_normalization: str(auto/on/off)=auto # This parameter controls text normalization with three modes: 'auto', 'on', and 'off'. When set to 'auto', the system will automatically decide whether to apply text normalization (e.g., spelling out numbers). With 'on', text normalization will always be applied, while with 'off', it will be skipped., apply_language_text_normalization: bool=false # This parameter controls language text normalization. This helps with proper pronunciation of text in some supported languages. WARNING: This parameter can heavily increase the latency of the request. Currently only supported for Japanese., audio_effects: any # Audio effects applied to the generated audio. Unknown IDs return 404 with `param` naming the field. Reverb (`environment_id` with `send_level` above 0) and a non-zero `pan` produce stereo audio and are rejected with 400 for `ulaw_*`, `alaw_*`, and `pcm_*` output formats. Effects don't change the cost of the request.}\n@returns(200) {audio_base64: str, alignment: any, normalized_alignment: any} # Stream of transcription chunks\n@errors {422: Validation Error}\n\n@endgroup\n\n@group text-to-dialogue\n@endpoint POST /v1/text-to-dialogue\n@desc Text To Dialogue (Multi-Voice)\n@required {inputs: [map{text!: str, voice_id!: str}] # A list of dialogue inputs, each containing text and a voice ID which will be converted into speech. The maximum number of unique voice IDs is 10. For reliable generation, keep the total character count across all `inputs[].text` values at or below 2,000 characters per request. Longer requests can terminate early in streaming responses or return a validation error.}\n@optional {output_format: any(alaw_8000/mp3_22050_32/mp3_24000_48/mp3_44100_128/mp3_44100_192/mp3_44100_32/mp3_44100_64/mp3_44100_96/opus_48000_128/opus_48000_192/opus_48000_32/opus_48000_64/opus_48000_96/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/pcm_8000/ulaw_8000/wav_16000/wav_22050/wav_24000/wav_32000/wav_44100/wav_48000/wav_8000)=mp3_44100_128 # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM and WAV formats with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs., enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers., model_id: str=eleven_v3 # Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property., language_code: any # Language code (ISO 639-1) used to enforce a language for the model and text normalization. If the model does not support the provided language code, it will be ignored. This parameter is not supported for multilingual_v2 models., settings: any # Settings controlling the dialogue generation., previous_text: any # The text that comes immediately before this generation, used to condition the model for prosodic continuity. A maximum of 100 characters can be sent. Not supported by every model., future_text: any # The text that comes immediately after this generation, used to condition the model for prosodic continuity. A maximum of 100 characters can be sent. Not supported by every model., pronunciation_dictionary_locators: any # A list of pronunciation dictionary locators (id, version_id) to be applied to the text. They will be applied in order. You may have up to 3 locators per request, seed: any # If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed. Must be integer between 0 and 4294967295., apply_text_normalization: str(auto/on/off)=auto # This parameter controls text normalization with three modes: 'auto', 'on', and 'off'. When set to 'auto', the system will automatically decide whether to apply text normalization (e.g., spelling out numbers). With 'on', text normalization will always be applied, while with 'off', it will be skipped., use_pvc_as_ivc: any # Whether to use the IVC version of a professional voice. This may improve expressiveness and reduce latency., previous_request_ids: any # A list of request_ids of dialogue generations that came before this one. Used to condition the model for continuity when splitting a large task into multiple requests. A maximum of 3 request_ids can be sent. The last request_id is the audio which is closest to the current request. Not supported by every model., next_request_ids: any # A list of request_ids of dialogue generations that come after this one. Useful for maintaining continuity when regenerating a clip in the middle of a sequence. A maximum of 3 request_ids can be sent. The first request_id is the audio which is closest to the current request. Not supported by every model., audio_effects: any # Audio effects applied to the generated audio. Unknown IDs return 404 with `param` naming the field. Reverb (`environment_id` with `send_level` above 0) and a non-zero `pan` produce stereo audio and are rejected with 400 for `ulaw_*`, `alaw_*`, and `pcm_*` output formats. Effects don't change the cost of the request.}\n@returns(200) The generated audio file\n@errors {422: Validation Error}\n\n@endpoint POST /v1/text-to-dialogue/stream\n@desc Text To Dialogue (Multi-Voice) Streaming\n@required {inputs: [map{text!: str, voice_id!: str}] # A list of dialogue inputs, each containing text and a voice ID which will be converted into speech. The maximum number of unique voice IDs is 10. For reliable generation, keep the total character count across all `inputs[].text` values at or below 2,000 characters per request. Longer requests can terminate early in streaming responses or return a validation error.}\n@optional {output_format: str(mp3_22050_32/mp3_24000_48/mp3_44100_32/mp3_44100_64/mp3_44100_96/mp3_44100_128/mp3_44100_192/pcm_8000/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/ulaw_8000/alaw_8000/opus_48000_32/opus_48000_64/opus_48000_96/opus_48000_128/opus_48000_192)=mp3_44100_128 # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs., enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers., model_id: str=eleven_v3 # Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property., language_code: any # Language code (ISO 639-1) used to enforce a language for the model and text normalization. If the model does not support the provided language code, it will be ignored. This parameter is not supported for multilingual_v2 models., settings: any # Settings controlling the dialogue generation., previous_text: any # The text that comes immediately before this generation, used to condition the model for prosodic continuity. A maximum of 100 characters can be sent. Not supported by every model., future_text: any # The text that comes immediately after this generation, used to condition the model for prosodic continuity. A maximum of 100 characters can be sent. Not supported by every model., pronunciation_dictionary_locators: any # A list of pronunciation dictionary locators (id, version_id) to be applied to the text. They will be applied in order. You may have up to 3 locators per request, seed: any # If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed. Must be integer between 0 and 4294967295., apply_text_normalization: str(auto/on/off)=auto # This parameter controls text normalization with three modes: 'auto', 'on', and 'off'. When set to 'auto', the system will automatically decide whether to apply text normalization (e.g., spelling out numbers). With 'on', text normalization will always be applied, while with 'off', it will be skipped., use_pvc_as_ivc: any # Whether to use the IVC version of a professional voice. This may improve expressiveness and reduce latency., previous_request_ids: any # A list of request_ids of dialogue generations that came before this one. Used to condition the model for continuity when splitting a large task into multiple requests. A maximum of 3 request_ids can be sent. The last request_id is the audio which is closest to the current request. Not supported by every model., next_request_ids: any # A list of request_ids of dialogue generations that come after this one. Useful for maintaining continuity when regenerating a clip in the middle of a sequence. A maximum of 3 request_ids can be sent. The first request_id is the audio which is closest to the current request. Not supported by every model., audio_effects: any # Audio effects applied to the generated audio. Unknown IDs return 404 with `param` naming the field. Reverb (`environment_id` with `send_level` above 0) and a non-zero `pan` produce stereo audio and are rejected with 400 for `ulaw_*`, `alaw_*`, and `pcm_*` output formats. Effects don't change the cost of the request.}\n@returns(200) Streaming audio data\n@errors {422: Validation Error}\n\n@endpoint POST /v1/text-to-dialogue/stream/with-timestamps\n@desc Text To Dialogue Streaming With Timestamps\n@required {inputs: [map{text!: str, voice_id!: str}] # A list of dialogue inputs, each containing text and a voice ID which will be converted into speech. The maximum number of unique voice IDs is 10. For reliable generation, keep the total character count across all `inputs[].text` values at or below 2,000 characters per request. Longer requests can terminate early in streaming responses or return a validation error.}\n@optional {output_format: str(mp3_22050_32/mp3_24000_48/mp3_44100_32/mp3_44100_64/mp3_44100_96/mp3_44100_128/mp3_44100_192/pcm_8000/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/ulaw_8000/alaw_8000/opus_48000_32/opus_48000_64/opus_48000_96/opus_48000_128/opus_48000_192)=mp3_44100_128 # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs., enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers., model_id: str=eleven_v3 # Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property., language_code: any # Language code (ISO 639-1) used to enforce a language for the model and text normalization. If the model does not support the provided language code, it will be ignored. This parameter is not supported for multilingual_v2 models., settings: any # Settings controlling the dialogue generation., pronunciation_dictionary_locators: any # A list of pronunciation dictionary locators (id, version_id) to be applied to the text. They will be applied in order. You may have up to 3 locators per request, seed: any # If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed. Must be integer between 0 and 4294967295., apply_text_normalization: str(auto/on/off)=auto # This parameter controls text normalization with three modes: 'auto', 'on', and 'off'. When set to 'auto', the system will automatically decide whether to apply text normalization (e.g., spelling out numbers). With 'on', text normalization will always be applied, while with 'off', it will be skipped., use_pvc_as_ivc: any # Whether to use the IVC version of a professional voice. This may improve expressiveness and reduce latency., previous_request_ids: any # A list of request_ids of dialogue generations that came before this one. Used to condition the model for continuity when splitting a large task into multiple requests. A maximum of 3 request_ids can be sent. The last request_id is the audio which is closest to the current request. Not supported by every model., next_request_ids: any # A list of request_ids of dialogue generations that come after this one. Useful for maintaining continuity when regenerating a clip in the middle of a sequence. A maximum of 3 request_ids can be sent. The first request_id is the audio which is closest to the current request. Not supported by every model., previous_text: any # The text that comes immediately before this generation, used to condition the model for prosodic continuity. A maximum of 100 characters can be sent. Not supported by every model., future_text: any # The text that comes immediately after this generation, used to condition the model for prosodic continuity. A maximum of 100 characters can be sent. Not supported by every model., audio_effects: any # Audio effects applied to the generated audio. Unknown IDs return 404 with `param` naming the field. Reverb (`environment_id` with `send_level` above 0) and a non-zero `pan` produce stereo audio and are rejected with 400 for `ulaw_*`, `alaw_*`, and `pcm_*` output formats. Effects don't change the cost of the request.}\n@returns(200) {audio_base64: str, alignment: any, normalized_alignment: any, voice_segments: [map]} # Stream of transcription chunks\n@errors {422: Validation Error}\n\n@endpoint POST /v1/text-to-dialogue/with-timestamps\n@desc Text To Dialogue With Timestamps\n@required {inputs: [map{text!: str, voice_id!: str}] # A list of dialogue inputs, each containing text and a voice ID which will be converted into speech. The maximum number of unique voice IDs is 10. For reliable generation, keep the total character count across all `inputs[].text` values at or below 2,000 characters per request. Longer requests can terminate early in streaming responses or return a validation error.}\n@optional {output_format: any(alaw_8000/mp3_22050_32/mp3_24000_48/mp3_44100_128/mp3_44100_192/mp3_44100_32/mp3_44100_64/mp3_44100_96/opus_48000_128/opus_48000_192/opus_48000_32/opus_48000_64/opus_48000_96/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/pcm_8000/ulaw_8000/wav_16000/wav_22050/wav_24000/wav_32000/wav_44100/wav_48000/wav_8000)=mp3_44100_128 # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM and WAV formats with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs., enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers., model_id: str=eleven_v3 # Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property., language_code: any # Language code (ISO 639-1) used to enforce a language for the model and text normalization. If the model does not support the provided language code, it will be ignored. This parameter is not supported for multilingual_v2 models., settings: any # Settings controlling the dialogue generation., pronunciation_dictionary_locators: any # A list of pronunciation dictionary locators (id, version_id) to be applied to the text. They will be applied in order. You may have up to 3 locators per request, seed: any # If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed. Must be integer between 0 and 4294967295., apply_text_normalization: str(auto/on/off)=auto # This parameter controls text normalization with three modes: 'auto', 'on', and 'off'. When set to 'auto', the system will automatically decide whether to apply text normalization (e.g., spelling out numbers). With 'on', text normalization will always be applied, while with 'off', it will be skipped., use_pvc_as_ivc: any # Whether to use the IVC version of a professional voice. This may improve expressiveness and reduce latency., previous_request_ids: any # A list of request_ids of dialogue generations that came before this one. Used to condition the model for continuity when splitting a large task into multiple requests. A maximum of 3 request_ids can be sent. The last request_id is the audio which is closest to the current request. Not supported by every model., next_request_ids: any # A list of request_ids of dialogue generations that come after this one. Useful for maintaining continuity when regenerating a clip in the middle of a sequence. A maximum of 3 request_ids can be sent. The first request_id is the audio which is closest to the current request. Not supported by every model., previous_text: any # The text that comes immediately before this generation, used to condition the model for prosodic continuity. A maximum of 100 characters can be sent. Not supported by every model., future_text: any # The text that comes immediately after this generation, used to condition the model for prosodic continuity. A maximum of 100 characters can be sent. Not supported by every model., audio_effects: any # Audio effects applied to the generated audio. Unknown IDs return 404 with `param` naming the field. Reverb (`environment_id` with `send_level` above 0) and a non-zero `pan` produce stereo audio and are rejected with 400 for `ulaw_*`, `alaw_*`, and `pcm_*` output formats. Effects don't change the cost of the request.}\n@returns(200) {audio_base64: str, alignment: any, normalized_alignment: any, voice_segments: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group voice-changer\n@endpoint POST /v1/voice-changer/{voice_id}\n@desc Voice Changer\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.}\n@optional {enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers., optimize_streaming_latency: any # You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model. Possible values: 0 - default mode (no latency optimizations) 1 - normal latency optimizations (about 50% of possible latency improvement of option 3) 2 - strong latency optimizations (about 75% of possible latency improvement of option 3) 3 - max latency optimizations 4 - max latency optimizations, but also with text normalizer turned off for even more latency savings (best latency, but can mispronounce eg numbers and dates).  Defaults to None., output_format: str(alaw_8000/mp3_22050_32/mp3_24000_48/mp3_44100_128/mp3_44100_192/mp3_44100_32/mp3_44100_64/mp3_44100_96/opus_48000_128/opus_48000_192/opus_48000_32/opus_48000_64/opus_48000_96/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/pcm_8000/ulaw_8000/wav_16000/wav_22050/wav_24000/wav_32000/wav_44100/wav_48000/wav_8000)=mp3_44100_128 # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM and WAV formats with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.}\n@returns(200) The generated audio file\n@errors {422: Validation Error}\n\n@endpoint POST /v1/voice-changer/{voice_id}/stream\n@desc Voice Changer Streaming\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.}\n@optional {enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers., optimize_streaming_latency: any # You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model. Possible values: 0 - default mode (no latency optimizations) 1 - normal latency optimizations (about 50% of possible latency improvement of option 3) 2 - strong latency optimizations (about 75% of possible latency improvement of option 3) 3 - max latency optimizations 4 - max latency optimizations, but also with text normalizer turned off for even more latency savings (best latency, but can mispronounce eg numbers and dates).  Defaults to None., output_format: str(mp3_22050_32/mp3_24000_48/mp3_44100_32/mp3_44100_64/mp3_44100_96/mp3_44100_128/mp3_44100_192/pcm_8000/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/ulaw_8000/alaw_8000/opus_48000_32/opus_48000_64/opus_48000_96/opus_48000_128/opus_48000_192)=mp3_44100_128 # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.}\n@returns(200) Streaming audio data\n@errors {422: Validation Error}\n\n@endgroup\n\n@group text-to-voice\n@endpoint POST /v1/text-to-voice/create-previews\n@desc [Deprecated] Generate A Voice Preview From Description\n@required {voice_description: str # Description to use for the created voice.}\n@optional {output_format: str(mp3_22050_32/mp3_24000_48/mp3_44100_32/mp3_44100_64/mp3_44100_96/mp3_44100_128/mp3_44100_192/pcm_8000/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/ulaw_8000/alaw_8000/opus_48000_32/opus_48000_64/opus_48000_96/opus_48000_128/opus_48000_192)=mp3_44100_192 # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs., text: any # Text to generate, text length has to be between 100 and 1000., auto_generate_text: bool=false # Whether to automatically generate a text suitable for the voice description., loudness: num=0.5 # Controls the volume level of the generated voice. -1 is quietest, 1 is loudest, 0 corresponds to roughly -24 LUFS., quality: num=0.9 # Higher quality results in better voice output but less variety., seed: any # Random number that controls the voice generation. Same seed with same inputs produces same voice., guidance_scale: num=5 # 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. We recommend to use longer, more detailed prompts at lower Guidance Scale., should_enhance: bool=false # Whether to enhance the voice description using AI to add more detail and improve voice generation quality. When enabled, the system will automatically expand simple prompts into more detailed voice descriptions. Defaults to False}\n@returns(200) {previews: [map], text: str} # Successful Response\n@errors {409: A generation for this preview is already in progress. Retry the request., 422: Validation Error}\n\n@endpoint POST /v1/text-to-voice\n@desc Create A New Voice From Voice Preview\n@required {voice_name: str # Name to use for the created voice., voice_description: str # Description to use for the created voice., generated_voice_id: str # The generated_voice_id to create; obtain it from POST /v1/text-to-voice/design, POST /v1/text-to-voice/:voice_id/remix, or the response headers when generating previews.}\n@optional {labels: any # Optional, metadata to add to the created voice. Defaults to None., played_not_selected_voice_ids: any # List of voice ids that the user has played but not selected. Used for RLHF.}\n@returns(200) {voice_id: str, name: str, samples: any, category: str, fine_tuning: any, labels: map, description: any, preview_url: any, available_for_tiers: [str], settings: any, sharing: any, high_quality_base_model_ids: [str], verified_languages: any, collection_ids: any, safety_control: any, voice_verification: any, permission_on_resource: any, is_owner: any, is_legacy: bool, is_mixed: bool, favorited_at_unix: any, created_at_unix: any, is_bookmarked: any, recording_quality: any, labelling_status: any, recording_quality_reason: any} # Successful Response\n@errors {409: A generation for this preview is already in progress. Retry the request., 422: Validation Error}\n\n@endpoint POST /v1/text-to-voice/design\n@desc Design A Voice.\n@required {voice_description: str # Description to use for the created voice.}\n@optional {output_format: str(mp3_22050_32/mp3_24000_48/mp3_44100_32/mp3_44100_64/mp3_44100_96/mp3_44100_128/mp3_44100_192/pcm_8000/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/ulaw_8000/alaw_8000/opus_48000_32/opus_48000_64/opus_48000_96/opus_48000_128/opus_48000_192)=mp3_44100_192 # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs., model_id: str(eleven_multilingual_ttv_v2/eleven_ttv_v3)=eleven_multilingual_ttv_v2 # Model to use for the voice generation. Possible values: eleven_multilingual_ttv_v2, eleven_ttv_v3., text: any # Text to generate, text length has to be between 100 and 1000., auto_generate_text: bool=false # Whether to automatically generate a text suitable for the voice description., loudness: num=0.5 # Controls the volume level of the generated voice. -1 is quietest, 1 is loudest, 0 corresponds to roughly -24 LUFS., seed: any # Random number that controls the voice generation. Same seed with same inputs produces same voice., guidance_scale: num=5 # 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. We recommend to use longer, more detailed prompts at lower Guidance Scale., stream_previews: bool=false # Determines whether the Text to Voice previews should be included in the response. If true, only the generated IDs will be returned which can then be streamed via the /v1/text-to-voice/:generated_voice_id/stream endpoint., should_enhance: bool=false # Whether to enhance the voice description using AI to add more detail and improve voice generation quality. When enabled, the system will automatically expand simple prompts into more detailed voice descriptions. Defaults to False, remixing_session_id: any # The remixing session id., remixing_session_iteration_id: any # The id of the remixing session iteration where these generations should be attached to. If not provided, a new iteration will be created., quality: any # Higher quality results in better voice output but less variety., reference_audio_base64: any # Reference audio to use for the voice generation. The audio should be base64 encoded. Only supported when using the  eleven_ttv_v3 model., prompt_strength: any # Controls the balance of prompt versus reference audio when generating voice samples. 0 means almost no prompt influence, 1 means almost no reference audio influence. Only supported when using the eleven_ttv_v3 model.}\n@returns(200) {previews: [map], text: str} # Successful Response\n@errors {409: A generation for this preview is already in progress. Retry the request., 422: Validation Error}\n\n@endpoint POST /v1/text-to-voice/{voice_id}/remix\n@desc Remix A Voice.\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices., voice_description: str # Description of the changes to make to the voice.}\n@optional {output_format: str(mp3_22050_32/mp3_24000_48/mp3_44100_32/mp3_44100_64/mp3_44100_96/mp3_44100_128/mp3_44100_192/pcm_8000/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/ulaw_8000/alaw_8000/opus_48000_32/opus_48000_64/opus_48000_96/opus_48000_128/opus_48000_192)=mp3_44100_192 # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs., text: any # Text to generate, text length has to be between 100 and 1000., auto_generate_text: bool=false # Whether to automatically generate a text suitable for the voice description., loudness: num=0.5 # Controls the volume level of the generated voice. -1 is quietest, 1 is loudest, 0 corresponds to roughly -24 LUFS., seed: any # Random number that controls the voice generation. Same seed with same inputs produces same voice., guidance_scale: num=2 # 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. We recommend to use longer, more detailed prompts at lower Guidance Scale., stream_previews: bool=false # Determines whether the Text to Voice previews should be included in the response. If true, only the generated IDs will be returned which can then be streamed via the /v1/text-to-voice/:generated_voice_id/stream endpoint., remixing_session_id: any # The remixing session id., remixing_session_iteration_id: any # The id of the remixing session iteration where these generations should be attached to. If not provided, a new iteration will be created., prompt_strength: any # Controls the balance of prompt versus reference audio when generating voice samples. 0 means almost no prompt influence, 1 means almost no reference audio influence. Only supported when using the eleven_ttv_v3 model.}\n@returns(200) {previews: [map], text: str} # Successful Response\n@errors {409: A generation for this preview is already in progress. Retry the request., 422: Validation Error}\n\n@endpoint GET /v1/text-to-voice/{generated_voice_id}/stream\n@desc Text To Voice Preview Streaming\n@required {generated_voice_id: str # The generated_voice_id to stream.}\n@returns(200) Streaming audio data\n@errors {422: Validation Error}\n\n@endgroup\n\n@group user\n@endpoint GET /v1/user\n@desc Get User Info\n@returns(200) {user_id: str, workspace_id: str, subscription: map{tier: str, character_count: int, character_limit: int, max_character_limit_extension: any, max_credit_limit_extension: any, can_extend_character_limit: bool, allowed_to_extend_character_limit: bool, next_character_count_reset_unix: any, voice_slots_used: int, professional_voice_slots_used: int, professional_voice_slots_used_in_workspace: int, voice_limit: int, max_voice_add_edits: any, voice_add_edit_counter: int, professional_voice_limit: int, can_extend_voice_limit: bool, can_use_instant_voice_cloning: bool, can_use_professional_voice_cloning: bool, currency: any, current_overage: map{amount: str, currency: str}, status: str, billing_period: any, character_refresh_period: any}, is_new_user: bool, can_use_delayed_payment_methods: bool, is_onboarding_completed: bool, is_onboarding_checklist_completed: bool, show_compliance_terms: bool, first_name: any, is_api_key_hashed: bool, xi_api_key_preview: any, referral_link_code: any, partnerstack_partner_default_link: any, created_at: int, seat_type: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/user/subscription\n@desc Get User Subscription Info\n@returns(200) {tier: str, character_count: int, character_limit: int, max_character_limit_extension: any, max_credit_limit_extension: any, can_extend_character_limit: bool, allowed_to_extend_character_limit: bool, next_character_count_reset_unix: any, voice_slots_used: int, professional_voice_slots_used: int, professional_voice_slots_used_in_workspace: int, voice_limit: int, max_voice_add_edits: any, voice_add_edit_counter: int, professional_voice_limit: int, can_extend_voice_limit: bool, can_use_instant_voice_cloning: bool, can_use_professional_voice_cloning: bool, currency: any, current_overage: map{amount: str, currency: str}, status: str, billing_period: any, character_refresh_period: any, next_invoice: any, open_invoices: [map], has_open_invoices: bool, cancels_immediately: bool, pending_change: any, has_used_starter_coupon_on_account: bool, has_used_creator_coupon_on_account: bool, is_eligible_for_starter_promo: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group voices\n@endpoint GET /v1/voices/collections\n@desc List Voice Collections\n@returns(200) {collections: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/voices/collections\n@desc Create Voice Collection\n@required {title: str # Title of the collection to create/update., icon: str # Icon of the collection to create/update.}\n@returns(200) {collection_id: str, title: str, icon: str, permission_on_resource: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/voices/collections/{collection_id}\n@desc Get Voice Collection\n@required {collection_id: str # Collection ID.}\n@returns(200) {collection_id: str, title: str, icon: str, permission_on_resource: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/voices/collections/{collection_id}\n@desc Update Voice Collection\n@required {collection_id: str # Collection ID.}\n@optional {title: any # Title of the collection to create/update., icon: any # Icon of the collection to create/update.}\n@returns(200) {collection_id: str, title: str, icon: str, permission_on_resource: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/voices/collections/{collection_id}\n@desc Delete Voice Collection\n@required {collection_id: str # Collection ID.}\n@returns(200) {collection_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/voices/collections/{collection_id}/voice/{voice_id}\n@desc Add Voice To Collection\n@required {collection_id: str # Collection ID., voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.}\n@returns(200) {collection_id: str, voice_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/voices/collections/{collection_id}/voice/{voice_id}\n@desc Remove Voice From Collection\n@required {collection_id: str # Collection ID., voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.}\n@returns(200) {collection_id: str, voice_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/voices/settings/default\n@desc Get Default Voice Settings.\n@returns(200) {stability: any, use_speaker_boost: any, similarity_boost: any, style: any, speed: any, clone_strength: any} # Successful Response\n\n@endpoint GET /v1/voices/{voice_id}/settings\n@desc Get Voice Settings\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.}\n@returns(200) {stability: any, use_speaker_boost: any, similarity_boost: any, style: any, speed: any, clone_strength: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/voices/{voice_id}/settings/edit\n@desc Edit Voice Settings\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.}\n@optional {stability: any=0.5 # Determines how stable the voice is and the randomness between each generation. Lower values introduce broader emotional range for the voice. Higher values can result in a monotonous voice with limited emotion., use_speaker_boost: any=true # This setting boosts the similarity to the original speaker. Using this setting requires a slightly higher computational load, which in turn increases latency., similarity_boost: any=0.75 # Determines how closely the AI should adhere to the original voice when attempting to replicate it., style: any=0 # Determines the style exaggeration of the voice. This setting attempts to amplify the style of the original speaker. It does consume additional computational resources and might increase latency if set to anything other than 0., speed: any=1 # Adjusts the speed of the voice. A value of 1.0 is the default speed, while values less than 1.0 slow down the speech, and values greater than 1.0 speed it up., clone_strength: any # Controls how closely the output matches your professional voice clone samples (0–1). Lower values sound more versatile, while higher values preserve more of the original voice characteristics. We recommend 0 for most use cases, but if you do run into issues 0.5 could be a good fallback. Applies only to professional voice clones fine-tuned for the selected v4 model.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/voices/accents\n@desc Get Voice Accents\n@optional {language: any # If provided, only accents for this language code are returned., model_id: any # If provided, returns the accents available for this model. Defaults to the most complete accent list when omitted.}\n@returns(200) {accents: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/voices\n@desc List Voices\n@optional {show_legacy: any=false # If set to true, legacy premade voices will be included in responses from /v1/voices}\n@returns(200) {voices: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/voices/{voice_id}\n@desc Get Voice\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.}\n@optional {with_settings: bool=true # This parameter is now deprecated. It is ignored and will be removed in a future version.}\n@returns(200) {voice_id: str, name: str, samples: any, category: str, fine_tuning: any, labels: map, description: any, preview_url: any, available_for_tiers: [str], settings: any, sharing: any, high_quality_base_model_ids: [str], verified_languages: any, collection_ids: any, safety_control: any, voice_verification: any, permission_on_resource: any, is_owner: any, is_legacy: bool, is_mixed: bool, favorited_at_unix: any, created_at_unix: any, is_bookmarked: any, recording_quality: any, labelling_status: any, recording_quality_reason: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/voices/{voice_id}\n@desc Delete Voice\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/voices/{voice_id}/edit\n@desc Edit Voice\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v2/voices\n@desc Get Voices V2\n@optional {next_page_token: any # The next page token to use for pagination. Returned from the previous request. Use this in combination with the has_more flag for reliable pagination., page_size: int=10 # How many voices to return at maximum. Can not exceed 100, defaults to 10. Page 0 may include more voices due to default voices being included., search: any # Search term to filter voices by. Searches in name, description, labels, category., sort: any # Which field to sort by, one of 'created_at_unix' or 'name'. 'created_at_unix' may not be available for older voices., sort_direction: any # Which direction to sort the voices in. 'asc' or 'desc'., voice_type: any # Type of the voice to filter by. One of 'personal', 'community', 'default', 'workspace', 'non-default', 'non-community', 'saved'. 'non-default' is equal to all but 'default'. 'non-community' is equal to 'personal' and 'workspace' combined (excludes library copies). 'saved' is equal to non-default, but includes default voices if they have been added to a collection., category: any # Category of the voice to filter by. One of 'premade', 'cloned', 'generated', 'professional', fine_tuning_state: any # State of the voice's fine tuning to filter by. Applicable only to professional voices clones. One of 'draft', 'not_verified', 'not_started', 'queued', 'fine_tuning', 'fine_tuned', 'failed', 'delayed', collection_id: any # Collection ID to filter voices by., gender: any # Gender used for filtering, based on the voice's 'gender' label., age: any # Age used for filtering, based on the voice's 'age' label., language: any # Languages used for filtering, based on the voice's 'language' label. Voices matching any of the given languages are returned., accent: any # Accent used for filtering, based on the voice's 'accent' label., use_cases: any # Use cases used for filtering, based on the voice's 'use_case' label. Voices matching any of the given use cases are returned., min_notice_period_days: any # Filter to voices whose sharing notice period is at least the given number of days., include_custom_rates: any # Whether to include voices that have a custom sharing rate. Defaults to including them., include_live_moderated: any # Whether to include voices that have live moderation enabled. Defaults to including them., high_quality: any # When true, only return studio-quality voices (those whose category is 'high_quality')., include_total_count: bool=true # Whether to include the total count of voices found in the response. NOTE: The total_count value is a live snapshot and may change between requests as users create, modify, or delete voices. For pagination, rely on the has_more flag instead. Only enable this when you actually need the total count (e.g., for display purposes), as it incurs a performance cost., voice_ids: any # Voice IDs to lookup by. Maximum 100 voice IDs.}\n@returns(200) {voices: [map], has_more: bool, total_count: int, next_page_token: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/voices/{voice_id}/replicate-to-isolated-environment\n@desc Replicate Voice To Isolated Environment\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices., target_workspace_id: str # ID of the workspace to replicate the voice into. It must belong to the same consolidated billing group as the calling workspace; the target's data residency is derived from that link.}\n@optional {preserve_voice_id: bool=true # When true (default) the replicated voice keeps the same voice ID in the target residency; set to false to assign a new voice ID.}\n@returns(200) {voice_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/voices/add\n@desc Add Voice\n@returns(200) {voice_id: str, requires_verification: bool, library_voice_match: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/voices/add/{public_user_id}/{voice_id}\n@desc Add Shared Voice\n@required {public_user_id: str # Public user ID used to publicly identify ElevenLabs users., voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices., new_name: str # The name that identifies this voice. This will be displayed in the dropdown of the website.}\n@optional {bookmarked: bool=true}\n@returns(200) {voice_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group studio\n@endpoint POST /v1/studio/podcasts\n@desc Create Podcast\n@required {model_id: str # The ID of the model to be used for this Studio project, you can query GET /v1/models to list all available models., mode: any # The type of podcast to generate. Can be 'conversation', an interaction between two voices, or 'bulletin', a monologue., source: any # The source content for the Podcast.}\n@optional {safety-identifier: any # Used for moderation. Your workspace must be allowlisted to use this feature., quality_preset: any # Output quality of the generated audio. Must be one of: 'standard' - standard output format, 128kbps with 44.1kHz sample rate. 'high' - high quality output format, 192kbps with 44.1kHz sample rate and major improvements on our side. 'ultra' - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side. 'ultra_lossless' - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format. If not provided, defaults to the highest quality preset available on your subscription tier., duration_scale: str(short/default/long)=default # Duration of the generated podcast. Must be one of: short - produces podcasts shorter than 3 minutes. default - produces podcasts roughly between 3-7 minutes. long - produces podcasts longer than 7 minutes., language: any # An optional language of the Studio project. Two-letter language code (ISO 639-1)., intro: any # The intro text that will always be added to the beginning of the podcast., outro: any # The outro text that will always be added to the end of the podcast., instructions_prompt: any # Additional instructions prompt for the podcast generation used to adjust the podcast's style and tone., highlights: any # A brief summary or highlights of the Studio project's content, providing key points or themes. This should be between 10 and 70 characters., callback_url: any # A url that will be called by our service when the Studio project is converted. Request will contain a json blob containing the status of the conversion     Messages:     1. When project was converted successfully:     {       type: \"project_conversion_status\",       event_timestamp: 1234567890,       data: {         request_id: \"1234567890\",         project_id: \"21m00Tcm4TlvDq8ikWAM\",         conversion_status: \"success\",         project_snapshot_id: \"22m00Tcm4TlvDq8ikMAT\", error_details: None,       }     }     2. When project conversion failed:     {       type: \"project_conversion_status\",       event_timestamp: 1234567890,       data: {         request_id: \"1234567890\",         project_id: \"21m00Tcm4TlvDq8ikWAM\",         conversion_status: \"error\", project_snapshot_id: None,         error_details: \"Error details if conversion failed\"       }     }      3. When chapter was converted successfully:     {       type: \"chapter_conversion_status\",       event_timestamp: 1234567890,       data: {         request_id: \"1234567890\",         project_id: \"21m00Tcm4TlvDq8ikWAM\",         chapter_id: \"22m00Tcm4TlvDq8ikMAT\",         conversion_status: \"success\",         chapter_snapshot_id: \"23m00Tcm4TlvDq8ikMAV\", error_details: None,       }     }     4. When chapter conversion failed:     {       type: \"chapter_conversion_status\",       event_timestamp: 1234567890,       data: {         request_id: \"1234567890\",         project_id: \"21m00Tcm4TlvDq8ikWAM\",         chapter_id: \"22m00Tcm4TlvDq8ikMAT\",         conversion_status: \"error\", chapter_snapshot_id: None,         error_details: \"Error details if conversion failed\"       }     }, apply_text_normalization: any # This parameter controls text normalization with four modes: 'auto', 'on', 'apply_english' and 'off'.     When set to 'auto', the system will automatically decide whether to apply text normalization     (e.g., spelling out numbers). With 'on', text normalization will always be applied, while     with 'off', it will be skipped. 'apply_english' is the same as 'on' but will assume that text is in English.}\n@returns(200) {project: map{project_id: str, name: str, create_date_unix: int, created_by_user_id: any, default_title_voice_ref_id: str, default_paragraph_voice_ref_id: str, default_model_id: str, last_conversion_date_unix: any, can_be_downloaded: bool, title: any, author: any, description: any, genres: any, cover_image_url: any, target_audience: any, language: any, content_type: any, original_publication_date: any, mature_content: any, isbn_number: any, volume_normalization: bool, state: str, access_level: str, fiction: any, quality_check_on: bool, quality_check_on_when_bulk_convert: bool, creation_meta: any, source_type: any, chapters_enabled: any, captions_enabled: any, caption_style: any, caption_style_template_overrides: any, public_share_id: any, aspect_ratio: any, agent_settings: any, default_title_voice_id: str, default_paragraph_voice_id: str}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/studio/projects/{project_id}/pronunciation-dictionaries\n@desc Create Pronunciation Dictionaries\n@required {project_id: str # The ID of the Studio project., pronunciation_dictionary_locators: [map{pronunciation_dictionary_id!: str, version_id!: any}] # A list of pronunciation dictionary locators (pronunciation_dictionary_id, version_id) encoded as a list of JSON strings for pronunciation dictionaries to be applied to the text. A list of json encoded strings is required as adding projects may occur through formData as opposed to jsonBody. To specify multiple dictionaries use multiple --form lines in your curl, such as --form 'pronunciation_dictionary_locators=\"{\\\"pronunciation_dictionary_id\\\":\\\"Vmd4Zor6fplcA7WrINey\\\",\\\"version_id\\\":\\\"hRPaxjlTdR7wFMhV4w0b\\\"}\"' --form 'pronunciation_dictionary_locators=\"{\\\"pronunciation_dictionary_id\\\":\\\"JzWtcGQMJ6bnlWwyMo7e\\\",\\\"version_id\\\":\\\"lbmwxiLu4q6txYxgdZqn\\\"}\"'.}\n@optional {invalidate_affected_text: bool=true # This will automatically mark text in this project for reconversion when the new dictionary applies or the old one no longer does.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/studio/projects\n@desc List Studio Projects\n@returns(200) {projects: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/studio/projects\n@desc Create Studio Project\n@returns(200) {project: map{project_id: str, name: str, create_date_unix: int, created_by_user_id: any, default_title_voice_ref_id: str, default_paragraph_voice_ref_id: str, default_model_id: str, last_conversion_date_unix: any, can_be_downloaded: bool, title: any, author: any, description: any, genres: any, cover_image_url: any, target_audience: any, language: any, content_type: any, original_publication_date: any, mature_content: any, isbn_number: any, volume_normalization: bool, state: str, access_level: str, fiction: any, quality_check_on: bool, quality_check_on_when_bulk_convert: bool, creation_meta: any, source_type: any, chapters_enabled: any, captions_enabled: any, caption_style: any, caption_style_template_overrides: any, public_share_id: any, aspect_ratio: any, agent_settings: any, default_title_voice_id: str, default_paragraph_voice_id: str}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/studio/projects/{project_id}\n@desc Update Studio Project\n@required {project_id: str # The ID of the Studio project., name: str # The name of the Studio project, used for identification only., default_title_voice_id: str # The voice_id that corresponds to the default voice used for new titles., default_paragraph_voice_id: str # The voice_id that corresponds to the default voice used for new paragraphs.}\n@optional {title: any # An optional name of the author of the Studio project, this will be added as metadata to the mp3 file on Studio project or chapter download., author: any # An optional name of the author of the Studio project, this will be added as metadata to the mp3 file on Studio project or chapter download., isbn_number: any # An optional ISBN number of the Studio project you want to create, this will be added as metadata to the mp3 file on Studio project or chapter download., volume_normalization: bool=false # When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements}\n@returns(200) {project: map{project_id: str, name: str, create_date_unix: int, created_by_user_id: any, default_title_voice_ref_id: str, default_paragraph_voice_ref_id: str, default_model_id: str, last_conversion_date_unix: any, can_be_downloaded: bool, title: any, author: any, description: any, genres: any, cover_image_url: any, target_audience: any, language: any, content_type: any, original_publication_date: any, mature_content: any, isbn_number: any, volume_normalization: bool, state: str, access_level: str, fiction: any, quality_check_on: bool, quality_check_on_when_bulk_convert: bool, creation_meta: any, source_type: any, chapters_enabled: any, captions_enabled: any, caption_style: any, caption_style_template_overrides: any, public_share_id: any, aspect_ratio: any, agent_settings: any, default_title_voice_id: str, default_paragraph_voice_id: str}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/studio/projects/{project_id}\n@desc Get Studio Project\n@required {project_id: str # The ID of the Studio project.}\n@optional {share_id: any # The share ID of the project}\n@returns(200) {project_id: str, name: str, create_date_unix: int, created_by_user_id: any, default_title_voice_ref_id: str, default_paragraph_voice_ref_id: str, default_model_id: str, last_conversion_date_unix: any, can_be_downloaded: bool, title: any, author: any, description: any, genres: any, cover_image_url: any, target_audience: any, language: any, content_type: any, original_publication_date: any, mature_content: any, isbn_number: any, volume_normalization: bool, state: str, access_level: str, fiction: any, quality_check_on: bool, quality_check_on_when_bulk_convert: bool, creation_meta: any, source_type: any, chapters_enabled: any, captions_enabled: any, caption_style: any, caption_style_template_overrides: any, public_share_id: any, aspect_ratio: any, agent_settings: any, quality_preset: str, chapters: [map], pronunciation_dictionary_versions: [map], pronunciation_dictionary_locators: [map], apply_text_normalization: str, experimental: map, assets: [any], voices: [map], base_voices: any, publishing_read: any, default_title_voice_id: str, default_paragraph_voice_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/studio/projects/{project_id}\n@desc Delete Studio Project\n@required {project_id: str # The ID of the Studio project.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/studio/projects/{project_id}/content\n@desc Update Studio Project Content\n@required {project_id: str # The ID of the Studio project.}\n@returns(200) {project: map{project_id: str, name: str, create_date_unix: int, created_by_user_id: any, default_title_voice_ref_id: str, default_paragraph_voice_ref_id: str, default_model_id: str, last_conversion_date_unix: any, can_be_downloaded: bool, title: any, author: any, description: any, genres: any, cover_image_url: any, target_audience: any, language: any, content_type: any, original_publication_date: any, mature_content: any, isbn_number: any, volume_normalization: bool, state: str, access_level: str, fiction: any, quality_check_on: bool, quality_check_on_when_bulk_convert: bool, creation_meta: any, source_type: any, chapters_enabled: any, captions_enabled: any, caption_style: any, caption_style_template_overrides: any, public_share_id: any, aspect_ratio: any, agent_settings: any, default_title_voice_id: str, default_paragraph_voice_id: str}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/studio/projects/{project_id}/convert\n@desc Convert Studio Project\n@required {project_id: str # The ID of the Studio project.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/studio/projects/{project_id}/snapshots\n@desc List Studio Project Snapshots\n@required {project_id: str # The ID of the Studio project.}\n@returns(200) {snapshots: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/studio/projects/{project_id}/snapshots/{project_snapshot_id}\n@desc Get Project Snapshot\n@required {project_id: str # The ID of the Studio project., project_snapshot_id: str # The ID of the Studio project snapshot.}\n@returns(200) {project_snapshot_id: str, project_id: str, created_at_unix: int, name: str, audio_upload: any, zip_upload: any, character_alignments: [map], audio_duration_secs: num} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/studio/projects/{project_id}/snapshots/{project_snapshot_id}/stream\n@desc Stream Studio Project Audio\n@required {project_id: str # The ID of the Studio project., project_snapshot_id: str # The ID of the Studio project snapshot.}\n@optional {convert_to_mpeg: bool=false # Whether to convert the audio to mpeg format.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/studio/projects/{project_id}/snapshots/{project_snapshot_id}/archive\n@desc Stream Archive With Studio Project Audio\n@required {project_id: str # The ID of the Studio project., project_snapshot_id: str # The ID of the Studio project snapshot.}\n@returns(200) Streaming archive data\n@errors {422: Validation Error}\n\n@endpoint GET /v1/studio/projects/{project_id}/chapters\n@desc List Chapters\n@required {project_id: str # The ID of the Studio project.}\n@returns(200) {chapters: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/studio/projects/{project_id}/chapters\n@desc Create Chapter\n@required {project_id: str # The ID of the Studio project., name: str # The name of the chapter, used for identification only.}\n@optional {from_url: any # An optional URL from which we will extract content to initialize the Studio project. If this is set, 'from_url' and 'from_content' must be null. If neither 'from_url', 'from_document', 'from_content' are provided we will initialize the Studio project as blank.}\n@returns(200) {chapter: map{chapter_id: str, name: str, last_conversion_date_unix: any, conversion_progress: any, can_be_downloaded: bool, state: str, has_video: any, has_visual_content: any, voice_ids: any, statistics: any, last_conversion_error: any, content: map{blocks: [map]}}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/studio/projects/{project_id}/chapters/{chapter_id}\n@desc Get Chapter\n@required {project_id: str # The ID of the Studio project., chapter_id: str # The ID of the chapter.}\n@returns(200) {chapter_id: str, name: str, last_conversion_date_unix: any, conversion_progress: any, can_be_downloaded: bool, state: str, has_video: any, has_visual_content: any, voice_ids: any, statistics: any, last_conversion_error: any, content: map{blocks: [map]}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/studio/projects/{project_id}/chapters/{chapter_id}\n@desc Update Chapter\n@required {project_id: str # The ID of the Studio project., chapter_id: str # The ID of the chapter.}\n@optional {name: any # The name of the chapter, used for identification only., content: any # The chapter content to use.}\n@returns(200) {chapter: map{chapter_id: str, name: str, last_conversion_date_unix: any, conversion_progress: any, can_be_downloaded: bool, state: str, has_video: any, has_visual_content: any, voice_ids: any, statistics: any, last_conversion_error: any, content: map{blocks: [map]}}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/studio/projects/{project_id}/chapters/{chapter_id}\n@desc Delete Chapter\n@required {project_id: str # The ID of the Studio project., chapter_id: str # The ID of the chapter.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/studio/projects/{project_id}/chapters/{chapter_id}/convert\n@desc Convert Chapter\n@required {project_id: str # The ID of the Studio project., chapter_id: str # The ID of the chapter.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots\n@desc List Chapter Snapshots\n@required {project_id: str # The ID of the Studio project., chapter_id: str # The ID of the chapter.}\n@returns(200) {snapshots: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots/{chapter_snapshot_id}\n@desc Get Chapter Snapshot\n@required {project_id: str # The ID of the Studio project., chapter_id: str # The ID of the chapter., chapter_snapshot_id: str # The ID of the chapter snapshot.}\n@returns(200) {chapter_snapshot_id: str, project_id: str, chapter_id: str, created_at_unix: int, name: str, character_alignments: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots/{chapter_snapshot_id}/stream\n@desc Stream Chapter Audio\n@required {project_id: str # The ID of the Studio project., chapter_id: str # The ID of the chapter., chapter_snapshot_id: str # The ID of the chapter snapshot.}\n@optional {convert_to_mpeg: bool=false # Whether to convert the audio to mpeg format.}\n@returns(200) Streaming audio data\n@errors {422: Validation Error}\n\n@endpoint GET /v1/studio/projects/{project_id}/muted-tracks\n@desc Get Project Muted Tracks\n@required {project_id: str # The ID of the Studio project.}\n@returns(200) {chapter_ids: [str]} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group dubbing\n@endpoint POST /v1/dubbing/project\n@desc Create Dubbing Project\n@returns(201) {project_id: str, status: str, reference: any, source_language: any, model_id: any, media: any, language_ids: [str], webhook_ids: [str], revision: int, error: any, warnings: [map], created_at: str(date-time), updated_at: str(date-time)} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/dubbing/project\n@desc List Dubbing Projects\n@optional {cursor: any # Pass the `next_cursor` from a previous response to fetch the page after it. Omit for the first page., page_size: int=20 # Number of projects per page. Clamped to between 1 and 100 rather than rejected, so a larger value returns a full page., status: any # Filter to projects in this status: `queued`, `preparing`, `ready`, or `failed`. Omit to return every status., sort_direction: str(ASCENDING/DESCENDING)=DESCENDING # Sort by creation time; newest first by default.}\n@returns(200) {projects: [map], next_cursor: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/dubbing/project/{project_id}\n@desc Get Dubbing Project\n@required {project_id: str # Identifier of the dubbing project to fetch.}\n@returns(200) {project_id: str, status: str, reference: any, source_language: any, model_id: any, media: any, language_ids: [str], webhook_ids: [str], revision: int, error: any, warnings: [map], created_at: str(date-time), updated_at: str(date-time)} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/dubbing/project/{project_id}\n@desc Delete Dubbing Project\n@required {project_id: str # Identifier of the dubbing project to delete.}\n@returns(204) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/dubbing/project/{project_id}/language\n@desc Create Dubbing Language Target\n@required {project_id: str # Identifier of the parent dubbing project., target_language: str # BCP-47 language tag to dub the project into (for example, `fr` or `es-MX`). Must be one of the [languages the project's dubbing model supports](https://elevenlabs.io/docs/help-center/product/dubbing/which-languages-are-supported-in-dubbing), and a region-qualified tag must be one of the supported dialects.}\n@optional {voice_settings: any # Voice settings applied to every speaker in this language. Omit to use the defaults., translations: any # Enterprise only. Optional translations to use instead of machine translation. A map from each source segment's `external_id` (or its `id`, if you supplied none) to the translated text; every source segment must be covered exactly once. At most 20,000 entries, totaling at most 4 MiB of text. See [Bring your own transcript](https://elevenlabs.io/docs/eleven-api/guides/how-to/dubbing/bring-your-own-transcript).}\n@returns(201) {language_id: str, project_id: str, target_language: str, status: str, model_id: any, voice_settings: any, outputs: any, revision: int, output_revision: any, error: any, warnings: [map], created_at: str(date-time), updated_at: str(date-time)} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/dubbing/project/{project_id}/language\n@desc List Dubbing Language Targets\n@required {project_id: str # Identifier of the parent dubbing project.}\n@optional {cursor: any # Pass the `next_cursor` from a previous response to fetch the page after it. Omit for the first page., page_size: int=20 # Number of language targets per page. Clamped to between 1 and 100 rather than rejected, so a larger value returns a full page., status: any # Filter to targets in this status: `queued`, `processing`, `completed`, `stale`, or `failed`. Omit to return every status.}\n@returns(200) {languages: [map], next_cursor: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/dubbing/project/{project_id}/language/{language_id}\n@desc Get Dubbing Language Target\n@required {project_id: str # Identifier of the parent dubbing project., language_id: str # Identifier of the language target to fetch.}\n@returns(200) {language_id: str, project_id: str, target_language: str, status: str, model_id: any, voice_settings: any, outputs: any, revision: int, output_revision: any, error: any, warnings: [map], created_at: str(date-time), updated_at: str(date-time)} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/dubbing/project/{project_id}/language/{language_id}\n@desc Delete Dubbing Language Target\n@required {project_id: str # Identifier of the parent dubbing project., language_id: str # Identifier of the language target to delete.}\n@returns(204) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/dubbing/project/{project_id}/transcript\n@desc Get Dubbing Transcript\n@required {project_id: str # Identifier of the dubbing project.}\n@returns(200) {language: any, segments: [map], revision: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/dubbing/project/{project_id}/transcript/segment/{segment_id}\n@desc Update Dubbing Transcript Segment\n@required {project_id: str # Identifier of the dubbing project., segment_id: str # Identifier of the segment to edit.}\n@optional {text: any # New text for the segment., speaker_id: any # New speaker ID for the segment., start_s: any # New start time, in seconds., end_s: any # New end time, in seconds.}\n@returns(200) {segment: map{id: str, text: str, speaker_id: str, start_s: num, end_s: num, external_id: any}, revision: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/dubbing/project/{project_id}/transcript/segment/{segment_id}\n@desc Delete Dubbing Transcript Segment\n@required {project_id: str # Identifier of the dubbing project., segment_id: str # Identifier of the segment to remove.}\n@returns(200) {revision: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/dubbing/project/{project_id}/transcript/segments\n@desc Update Dubbing Transcript Segments\n@required {project_id: str # Identifier of the dubbing project., segments: map # Map of segment ID to the partial update to apply to that segment. At least one entry and at most 500.}\n@returns(200) {segments: [map], revision: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/dubbing/project/{project_id}/transcript/segment\n@desc Add Dubbing Transcript Segment\n@required {project_id: str # Identifier of the dubbing project., text: str # The text of the new segment., speaker_id: str # Identifier of the segment's speaker., start_s: num # Start time of the segment, in seconds., end_s: num # End time of the segment, in seconds.}\n@returns(201) {segment: map{id: str, text: str, speaker_id: str, start_s: num, end_s: num, external_id: any}, revision: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/dubbing/project/{project_id}/language/{language_id}/transcript\n@desc Get Dubbing Target Transcript\n@required {project_id: str # Identifier of the dubbing project., language_id: str # Identifier of the language target.}\n@returns(200) {source_language: any, target_language: str, segments: [map], revision: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/dubbing/project/{project_id}/language/{language_id}/transcript/segment/{segment_id}\n@desc Update Dubbing Target Transcript Segment\n@required {project_id: str # Identifier of the dubbing project., language_id: str # Identifier of the language target., segment_id: str # Identifier of the segment to edit.}\n@optional {translation: any # New translated text, or null to mark the segment for re-translation.}\n@returns(200) {segment: map{id: str, speaker_id: str, start_s: num, end_s: num, source_text: str, translation: any}, revision: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/dubbing/project/{project_id}/language/{language_id}/transcript/segments\n@desc Update Dubbing Target Transcript Segments\n@required {project_id: str # Identifier of the dubbing project., language_id: str # Identifier of the language target., segments: map # Map of segment ID to the translation edit to apply to that segment. At least one entry and at most 500.}\n@returns(200) {segments: [map], revision: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/dubbing/project/{project_id}/language/{language_id}/transcript/regenerate\n@desc Regenerate Dubbing Target\n@required {project_id: str # Identifier of the dubbing project., language_id: str # Identifier of the language target.}\n@returns(202) {regenerated_segment_ids: [str], regenerated_seconds: num, charged_seconds: num, free_regeneration_seconds_remaining: num} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/dubbing/resource/{dubbing_id}\n@desc Get The Dubbing Resource For An Id.\n@required {dubbing_id: str # ID of the dubbing project.}\n@returns(200) {id: str, version: int, source_language: str, target_languages: [str], input: map{src: str, content_type: str, bucket_name: str, random_path_slug: str, duration_secs: num, is_audio: bool, url: str}, background: any, foreground: any, speaker_tracks: map, speaker_segments: map, renders: map} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/dubbing/resource/{dubbing_id}/language\n@desc Add A Language To The Resource\n@required {dubbing_id: str # ID of the dubbing project., language: any # The Target language.}\n@returns(201) {version: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/dubbing/resource/{dubbing_id}/speaker/{speaker_id}/segment\n@desc Create A Segment For The Speaker\n@required {dubbing_id: str # ID of the dubbing project., speaker_id: str # ID of the speaker., start_time: num, end_time: num}\n@optional {text: any, translations: any}\n@returns(201) {version: int, new_segment: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/dubbing/resource/{dubbing_id}/segment/{segment_id}/{language}\n@desc Modify A Single Segment\n@required {dubbing_id: str # ID of the dubbing project., segment_id: str # ID of the segment, language: str # ID of the language.}\n@optional {start_time: any, end_time: any, text: any}\n@returns(200) {version: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/dubbing/resource/{dubbing_id}/migrate-segments\n@desc Move Segments Between Speakers\n@required {dubbing_id: str # ID of the dubbing project., segment_ids: [str], speaker_id: str}\n@returns(200) {version: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/dubbing/resource/{dubbing_id}/segment/{segment_id}\n@desc Deletes A Single Segment\n@required {dubbing_id: str # ID of the dubbing project., segment_id: str # ID of the segment}\n@returns(200) {version: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/dubbing/resource/{dubbing_id}/transcribe\n@desc Transcribes Segments\n@required {dubbing_id: str # ID of the dubbing project., segments: [str] # Transcribe this specific list of segments.}\n@returns(200) {version: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/dubbing/resource/{dubbing_id}/translate\n@desc Translates All Or Some Segments And Languages\n@required {dubbing_id: str # ID of the dubbing project., segments: [str] # Translate only this list of segments., languages: any # Translate only these languages for each segment.}\n@returns(200) {version: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/dubbing/resource/{dubbing_id}/dub\n@desc Dubs All Or Some Segments And Languages\n@required {dubbing_id: str # ID of the dubbing project., segments: [str] # Dub only this list of segments., languages: any # Dub only these languages for each segment.}\n@returns(200) {version: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/dubbing/resource/{dubbing_id}/speaker/{speaker_id}\n@desc Update Metadata For A Speaker\n@required {dubbing_id: str # ID of the dubbing project., speaker_id: str # ID of the speaker.}\n@optional {speaker_name: any # Name to attribute to this speaker., voice_id: any # Either the identifier of a voice from the ElevenLabs voice library, or one of ['track-clone', 'clip-clone']., voice_stability: any # For models that support it, the voice similarity value to use. This will default to 0.65, with a valid range of [0.0, 1.0]., voice_similarity: any # For models that support it, the voice similarity value to use. This will default to 1.0, with a valid range of [0.0, 1.0]., voice_style: any # For models that support it, the voice style value to use. This will default to 1.0, with a valid range of [0.0, 1.0]., languages: any # Languages to apply these changes to. If empty, will apply to all languages.}\n@returns(200) {version: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/dubbing/resource/{dubbing_id}/speaker\n@desc Create A New Speaker\n@required {dubbing_id: str # ID of the dubbing project.}\n@optional {speaker_name: any # Name to attribute to this speaker., voice_id: any # Either the identifier of a voice from the ElevenLabs voice library, or one of ['track-clone', 'clip-clone']., voice_stability: any # For models that support it, the voice similarity value to use. This will default to 0.65, with a valid range of [0.0, 1.0]., voice_similarity: any # For models that support it, the voice similarity value to use. This will default to 1.0, with a valid range of [0.0, 1.0]., voice_style: any # For models that support it, the voice style value to use. This will default to 1.0, with a valid range of [0.0, 1.0].}\n@returns(200) {version: int, speaker_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/dubbing/resource/{dubbing_id}/speaker/{speaker_id}/similar-voices\n@desc Search The Elevenlabs Library For Voices Similar To A Speaker.\n@required {dubbing_id: str # ID of the dubbing project., speaker_id: str # ID of the speaker.}\n@returns(200) {voices: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/dubbing/resource/{dubbing_id}/render/{language}\n@desc Render Audio Or Video For The Given Language\n@required {dubbing_id: str # ID of the dubbing project., language: str # The target language code to render, eg. 'es'. To render the source track use 'original'., render_type: str(mp4/aac/mp3/wav/aaf/tracks_zip/clips_zip/zip)}\n@optional {normalize_volume: any=false # Whether to normalize the volume of the rendered audio.}\n@returns(200) {version: int, render_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/dubbing\n@desc List Dubs\n@optional {cursor: any # Used for fetching next page. Cursor is returned in the response., page_size: int=100 # How many dubs to return at maximum. Can not exceed 200, defaults to 100., dubbing_status: str(dubbing/dubbed/failed) # What state the dub is currently in., dubbing_statuses: any # Filter by dubbing status., dubbing_models: any # Filter by dubbing model generation., target_language_codes: any # Filter by target language code., creation_sources: any # Filter by dubbing creation source., filter_by_creator: str(personal/others/all)=all # Filters who created the resources being listed, whether it was the user running the request or someone else that shared the resource with them., order_by: str(created_at/name)=created_at # The field to use for ordering results from this query., order_direction: str(DESCENDING/ASCENDING)=DESCENDING # The order direction to use for results from this query.}\n@returns(200) {dubs: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/dubbing\n@desc Dub A Video Or An Audio File\n@returns(200) {dubbing_id: str, expected_duration_sec: num} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/dubbing/{dubbing_id}\n@desc Get Dubbing\n@required {dubbing_id: str # ID of the dubbing project.}\n@returns(200) {dubbing_id: str, name: str, status: str, source_language: any, target_languages: [str], editable: bool, created_at: str(date-time), media_metadata: any, error: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/dubbing/{dubbing_id}\n@desc Delete Dubbing\n@required {dubbing_id: str # ID of the dubbing project.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/dubbing/{dubbing_id}/audio/{language_code}\n@desc Get Dubbed File\n@required {dubbing_id: str # ID of the dubbing project., language_code: str # ID of the language.}\n@returns(200) The dubbed audio or video file\n@errors {403: Permission denied, 404: Dubbing not found, 422: Validation Error, 425: Dubbing not ready}\n\n@endpoint GET /v1/dubbing/{dubbing_id}/transcript/{language_code}\n@desc Get Dubbed Transcript\n@required {dubbing_id: str # ID of the dubbing project., language_code: str # ISO-693 language code to retrieve the transcript for. Use 'source' to fetch the transcript of the original media.}\n@optional {format_type: str(srt/webvtt/json)=srt # Format to return transcript in. For subtitles use either 'srt' or 'webvtt', and for a full transcript use 'json'. The 'json' format is not yet supported for Dubbing Studio.}\n@returns(200) Successful Response\n@errors {403: Anonymous users cannot use this function, 404: Dubbing or transcript not found, 422: Validation Error, 425: Dubbing not ready}\n\n@endpoint GET /v1/dubbing/{dubbing_id}/transcripts/{language_code}/format/{format_type}\n@desc Retrieve A Transcript\n@required {dubbing_id: str # ID of the dubbing project., language_code: str # ISO-693 language code to retrieve the transcript for. Use 'source' to fetch the transcript of the original media., format_type: str(srt/webvtt/json) # Format to return transcript in. For subtitles use either 'srt' or 'webvtt', and for a full transcript use 'json'. The 'json' format is not yet supported for Dubbing Studio.}\n@returns(200) {transcript_format: str, srt: any, webvtt: any, json: any} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group models\n@endpoint GET /v1/models\n@desc Get Models\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group audio-native\n@endpoint POST /v1/audio-native\n@desc Creates Audio Native Enabled Project.\n@returns(200) {project_id: str, converting: bool, html_snippet: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/audio-native/{project_id}/settings\n@desc Get Audio Native Project Settings\n@required {project_id: str # The ID of the Studio project.}\n@returns(200) {enabled: bool, snapshot_id: any, settings: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/audio-native/{project_id}/content\n@desc Update Audio-Native Project Content\n@required {project_id: str # The ID of the Studio project.}\n@returns(200) {project_id: str, converting: bool, publishing: bool, html_snippet: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/audio-native/content\n@desc Update Audio-Native Content From Url\n@required {url: str # URL of the page to extract content from.}\n@optional {author: any # Author used in the player and inserted at the start of the uploaded article. If not provided, the default author set in the Player settings is used., title: any # Title used in the player and inserted at the top of the uploaded article. If not provided, the default title set in the Player settings is used.}\n@returns(200) {project_id: str, converting: bool, publishing: bool, html_snippet: str} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group content-provenance\n@endpoint POST /v1/content-provenance/watermark\n@desc Check Watermark\n@returns(200) {is_detected: bool, details: any} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group similar-voices\n@endpoint POST /v1/similar-voices\n@desc Get Similar Library Voices\n@returns(200) {voices: [map], has_more: bool, total_count: int, last_sort_id: any} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group shared-voices\n@endpoint GET /v1/shared-voices\n@desc Get Voices\n@optional {page_size: int=30 # How many shared voices to return at maximum. Can not exceed 100, defaults to 30., category: any(professional/famous/high_quality) # Voice category used for filtering, gender: any # Gender used for filtering, age: any # Age used for filtering, accent: any # Accent used for filtering, language: any # Language used for filtering, locale: any # Locale used for filtering, search: any # Search term used for filtering, use_cases: any # Use-case used for filtering, descriptives: any # Search term used for filtering, featured: bool=false # Filter featured voices, min_notice_period_days: any # Filter voices with a minimum notice period of the given number of days., include_custom_rates: any # Include/exclude voices with custom rates, include_live_moderated: any # Include/exclude voices that are live moderated, reader_app_enabled: bool=false # Filter voices that are enabled for the reader app, owner_id: any # Filter voices by public owner ID, sort: any(created_date/usage_character_count_1y/trending/cloned_by_count)=created_date # Sort criteria. Must be one of: created_date, usage_character_count_1y, trending, cloned_by_count., page: int=0}\n@returns(200) {voices: [map], has_more: bool, total_count: int, last_sort_id: any} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group usage\n@endpoint GET /v1/usage/character-stats\n@desc Get Characters Usage Metrics (Deprecated)\n@required {start_unix: int # UTC Unix timestamp for the start of the usage window, in milliseconds. To include the first day of the window, the timestamp should be at 00:00:00 of that day., end_unix: int # UTC Unix timestamp for the end of the usage window, in milliseconds. To include the last day of the window, the timestamp should be at 23:59:59 of that day.}\n@optional {include_workspace_metrics: bool=false # Whether or not to include the statistics of the entire workspace., breakdown_type: str=none # How to break down the information. Cannot be \"user\" if include_workspace_metrics is False., aggregation_interval: str=day # How to aggregate usage data over time. Can be \"hour\", \"day\", \"week\", \"month\", or \"cumulative\"., aggregation_bucket_size: any # Aggregation bucket size in seconds. Overrides the aggregation interval., metric: str=credits # Which metric to aggregate.}\n@returns(200) {time: [int], usage: map} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group pronunciation-dictionaries\n@endpoint POST /v1/pronunciation-dictionaries/add-from-file\n@desc Add A Pronunciation Dictionary\n@returns(200) {id: str, name: str, created_by: str, creation_time_unix: int, version_id: str, version_rules_num: int, description: any, permission_on_resource: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/pronunciation-dictionaries/add-from-rules\n@desc Add A Pronunciation Dictionary\n@required {rules: [any] # List of pronunciation rules. Rule can be either:     an alias rule: {'string_to_replace': 'a', 'type': 'alias', 'alias': 'b', }     or a phoneme rule: {'string_to_replace': 'a', 'type': 'phoneme', 'phoneme': 'b', 'alphabet': 'ipa' }, name: str # The name of the pronunciation dictionary, used for identification only.}\n@optional {description: any # A description of the pronunciation dictionary, used for identification only., workspace_access: any # Should be one of 'admin', 'editor' or 'viewer'. If not provided, defaults to no access.}\n@returns(200) {id: str, name: str, created_by: str, creation_time_unix: int, version_id: str, version_rules_num: int, description: any, permission_on_resource: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}\n@desc Update Pronunciation Dictionary\n@required {pronunciation_dictionary_id: str # The id of the pronunciation dictionary}\n@optional {archived: bool # Whether to archive the pronunciation dictionary., name: str # The name of the pronunciation dictionary, used for identification only.}\n@returns(200) {id: str, latest_version_id: str, latest_version_rules_num: int, name: str, permission_on_resource: any, created_by: str, creation_time_unix: int, archived_time_unix: any, description: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}\n@desc Get Metadata For A Pronunciation Dictionary\n@required {pronunciation_dictionary_id: str # The id of the pronunciation dictionary}\n@returns(200) {id: str, latest_version_id: str, latest_version_rules_num: int, name: str, permission_on_resource: any, created_by: str, creation_time_unix: int, archived_time_unix: any, description: any, rules: [any]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/set-rules\n@desc Set Rules On The Pronunciation Dictionary\n@required {pronunciation_dictionary_id: str # The id of the pronunciation dictionary, rules: [any] # List of pronunciation rules. Rule can be either:     an alias rule: {'string_to_replace': 'a', 'type': 'alias', 'alias': 'b', }     or a phoneme rule: {'string_to_replace': 'a', 'type': 'phoneme', 'phoneme': 'b', 'alphabet': 'ipa' }}\n@returns(200) {id: str, version_id: str, version_rules_num: int} # Successfully set rules on the pronunciation dictionary\n@errors {422: Validation Error}\n\n@endpoint POST /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/add-rules\n@desc Add Rules To The Pronunciation Dictionary\n@required {pronunciation_dictionary_id: str # The id of the pronunciation dictionary, rules: [any] # List of pronunciation rules. Rule can be either:     an alias rule: {'string_to_replace': 'a', 'type': 'alias', 'alias': 'b', }     or a phoneme rule: {'string_to_replace': 'a', 'type': 'phoneme', 'phoneme': 'b', 'alphabet': 'ipa' }}\n@returns(200) {id: str, version_id: str, version_rules_num: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/remove-rules\n@desc Remove Rules From The Pronunciation Dictionary\n@required {pronunciation_dictionary_id: str # The id of the pronunciation dictionary, rule_strings: [str] # List of strings to remove from the pronunciation dictionary.}\n@returns(200) {id: str, version_id: str, version_rules_num: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/pronunciation-dictionaries/{dictionary_id}/{version_id}/download\n@desc Get A Pls File With A Pronunciation Dictionary Version Rules\n@required {dictionary_id: str # The id of the pronunciation dictionary, version_id: str # The id of the pronunciation dictionary version}\n@returns(200) The PLS file containing pronunciation dictionary rules\n@errors {422: Validation Error}\n\n@endpoint GET /v1/pronunciation-dictionaries\n@desc Get Pronunciation Dictionaries\n@optional {cursor: any # Used for fetching next page. Cursor is returned in the response., page_size: int=30 # How many pronunciation dictionaries to return at maximum. Can not exceed 100, defaults to 30., sort: any=creation_time_unix # Which field to sort by, one of 'created_at_unix' or 'name'., sort_direction: any=DESCENDING # Which direction to sort the voices in. 'ascending' or 'descending'., include_archived: bool=true # Whether to include archived pronunciation dictionaries in the response.}\n@returns(200) {pronunciation_dictionaries: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group workspaces\n@endpoint POST /v1/workspaces/api-keys/disable\n@desc Disable Api Key\n@required {api_key_name: str # Must be set to `self` to disable the API key used to authenticate this request. Required as an explicit confirmation to avoid accidentally disabling the wrong key.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/workspaces/api-keys/third-party-disabling\n@desc Set Workspace Third-Party Disabling Policy\n@optional {third_party_disable_allowed: any # `true` forces every key in the workspace to be disable-able by its holder; `false` forbids it for every key; `null` clears the override (per-key values and the plan default apply).}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group service-accounts\n@endpoint GET /v1/service-accounts/{service_account_user_id}/api-keys\n@desc Get Service Account Api Keys Route\n@required {service_account_user_id: str}\n@returns(200) {api-keys: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/service-accounts/{service_account_user_id}/api-keys\n@desc Create Service Account Api Key\n@required {service_account_user_id: str, name: str, permissions: any # The permissions of the XI API.}\n@optional {character_limit: any # The character limit of the XI API key. If provided this will limit the usage of this api key to n characters per month where n is the chosen value. Requests that incur charges will fail after reaching this monthly limit., allowed_ips: any # List of IP addresses or CIDR ranges allowed to use this API key. Each entry may be a CIDR range (e.g. '10.0.0.0/24') or a bare IP address (normalized to /32 or /128). On create, omit or pass null to allow all IPs. On update, omit to leave the allowlist unchanged, or pass \"clear\" to remove it., third_party_disable_allowed: any # Whether the holder of this key may disable it via the self-disable endpoint. On create, omit or pass null to use the workspace's default (enabled for non-Enterprise plans, disabled for Enterprise plans). On update, omit to leave it unchanged, or pass \"clear\" to reset it to the workspace default. Only honored for workspaces with self-disable access enabled., tts_concurrency_limit: any # Maximum concurrent text-to-speech/speech-to-speech requests for this API key. Only available for enterprise customers., dubbing_concurrency_limit: any # Maximum concurrent dubbing requests for this API key. Only available for enterprise customers., music_concurrency_limit: any # Maximum concurrent music generation requests for this API key. Only available for enterprise customers., expires_at_unix: any # Unix timestamp (in seconds) after which this API key stops working. When set, it must be at least 15 minutes and at most 90 days in the future. On create, omit or pass null for a key that never expires. On update, omit to leave it unchanged, or pass \"clear\" to remove the expiry (never expires). A workspace may disallow never-expiring keys, or allow them only on service account API keys; creating one or clearing an expiry then fails.}\n@returns(200) {xi-api-key: str, key_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}\n@desc Edit Service Account Api Key\n@required {service_account_user_id: str, api_key_id: str}\n@optional {is_enabled: any=no_update # Whether to enable or disable the API key., name: any # The name of the XI API key to use (used for identification purposes only)., permissions: any=no_update # The permissions of the XI API., character_limit: any=no_update # The character limit of the XI API key. If provided this will limit the usage of this api key to n characters per month where n is the chosen value. Requests that incur charges will fail after reaching this monthly limit., allowed_ips: any=no_update # List of IP addresses or CIDR ranges allowed to use this API key. Each entry may be a CIDR range (e.g. '10.0.0.0/24') or a bare IP address (normalized to /32 or /128). On create, omit or pass null to allow all IPs. On update, omit to leave the allowlist unchanged, or pass \"clear\" to remove it., third_party_disable_allowed: any=no_update # Whether the holder of this key may disable it via the self-disable endpoint. On create, omit or pass null to use the workspace's default (enabled for non-Enterprise plans, disabled for Enterprise plans). On update, omit to leave it unchanged, or pass \"clear\" to reset it to the workspace default. Only honored for workspaces with self-disable access enabled., tts_concurrency_limit: any=no_update # Maximum concurrent text-to-speech/speech-to-speech requests for this API key. Only available for enterprise customers., dubbing_concurrency_limit: any=no_update # Maximum concurrent dubbing requests for this API key. Only available for enterprise customers., music_concurrency_limit: any=no_update # Maximum concurrent music generation requests for this API key. Only available for enterprise customers., expires_at_unix: any=no_update # Unix timestamp (in seconds) after which this API key stops working. When set, it must be at least 15 minutes and at most 90 days in the future. On create, omit or pass null for a key that never expires. On update, omit to leave it unchanged, or pass \"clear\" to remove the expiry (never expires). A workspace may disallow never-expiring keys, or allow them only on service account API keys; creating one or clearing an expiry then fails.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}\n@desc Delete Service Account Api Key\n@required {service_account_user_id: str, api_key_id: str}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}/disable\n@desc Disable Service Account Api Key\n@required {service_account_user_id: str, api_key_id: str}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group workspace\n@endpoint GET /v1/workspace/audit-logs\n@desc Get Workspace Audit Logs\n@optional {limit: int=50 # Maximum number of entries per page, cursor: any # Cursor for the next page (from previous response), time_from_unix_ms: any # Only include entries at or after this time (ms since epoch), time_to_unix_ms: any # Only include entries at or before this time (ms since epoch), actor_uid: any # Filter by actor user ID, class_name: any # Filter by OCSF event class name, activity_name: any # Filter by audit activity name}\n@returns(200) {entries: [map], has_more: bool, next_cursor: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/workspace/auth-connections\n@desc Create Workspace Auth Connection\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/workspace/auth-connections\n@desc Get Workspace Auth Connections\n@returns(200) {auth_connections: [any]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/workspace/auth-connections/{auth_connection_id}\n@desc Update Workspace Auth Connection\n@required {auth_connection_id: str}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/workspace/auth-connections/{auth_connection_id}\n@desc Delete Workspace Auth Connection\n@required {auth_connection_id: str}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group service-accounts\n@endpoint GET /v1/service-accounts\n@desc Get Workspace Service Accounts\n@returns(200) {service-accounts: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/service-accounts\n@desc Create Service Account\n@required {name: str}\n@optional {default_sharing_groups: any # List of groups with their permission levels to share with by default. Each entry should specify a group_id and a permission_level (admin, editor, or viewer).}\n@returns(200) {service-account-user-id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group workspace\n@endpoint GET /v1/workspace/groups\n@desc Get All Groups\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/workspace/groups/search\n@desc Search User Groups\n@required {name: str # Name of the target group.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/workspace/groups/{group_id}/members/remove\n@desc Delete Member From User Group\n@required {group_id: str # The ID of the target group., email: str # The email of the target workspace member.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/workspace/groups/{group_id}/members\n@desc Add Member To User Group\n@required {group_id: str # The ID of the target group., email: str # The email of the target workspace member.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/workspace/invites/add\n@desc Invite User\n@required {email: str # The email of the customer}\n@optional {workspace_permission: any # The workspace permission of the user. This is deprecated, use `seat_type` instead., seat_type: any # The seat type of the user, group_ids: any # The group ids of the user, usage_limit: any # Monthly credit usage limit for the invitee. Omit or set to null for no custom cap.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/workspace/invites/add-bulk\n@desc Invite Multiple Users\n@required {emails: [str] # The email of the customer}\n@optional {seat_type: any # The seat type of the user, group_ids: any # The group ids of the user, usage_limit: any # Monthly credit usage limit for the invitee. Omit or set to null for no custom cap.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/workspace/invites\n@desc Delete Existing Invitation\n@required {email: str # The email of the customer}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/workspace/members\n@desc Get Workspace Members\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/workspace/members\n@desc Update Member\n@required {email: str # Email of the target user.}\n@optional {is_locked: any # Whether to lock or unlock the user account., workspace_role: any # The workspace role of the user. This is deprecated, use `workspace_seat_type` instead., workspace_seat_type: any # The workspace seat type, allow_downgrade_to_basic_seat: bool=false # When unlocking a user whose original seat type has no seats available but a basic seat is available, downgrade the user to a basic seat instead of failing.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PUT /v1/workspace/members/{user_id}/usage-limit\n@desc Update Member Usage Limit\n@required {user_id: str # User ID of the target user., usage_limit: any # Monthly credit usage limit for the member. Set to null to remove the limit.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/workspace/resources/{resource_id}\n@desc Get Resource\n@required {resource_id: str # The ID of the target resource., resource_type: str # Resource type of the target resource.}\n@returns(200) {resource_id: str, resource_name: any, resource_type: str, creator_user_id: any, anonymous_access_level_override: any, role_to_group_ids: map, share_options: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/workspace/resources/{resource_id}/share\n@desc Share Workspace Resource\n@required {resource_id: str # The ID of the target resource., role: str(admin/editor/commenter/viewer) # Role to grant to the target: one of 'admin', 'editor', 'commenter', or 'viewer'., resource_type: str(voice/voice_collection/pronunciation_dictionary/dubbing/dubbing_project/project/convai_agents/convai_knowledge_base_documents/convai_tools/convai_settings/convai_secrets/workspace_auth_connections/convai_phone_numbers/convai_mcp_servers/convai_api_integration_connections/convai_api_integration_trigger_connections/convai_batch_calls/convai_agent_response_tests/convai_test_suite_invocations/convai_crawl_jobs/convai_crawl_tasks/convai_kb_external_sync_jobs/convai_whatsapp_accounts/convai_agent_versions/convai_agent_branches/convai_agent_versions_deployments/convai_agent_experiments/convai_memory_entries/convai_templates/dashboard/dashboard_configuration/convai_agent_drafts/resource_locators/assets/content_generations/content_templates/content_skills/songs/transcription_tasks/avatars/avatar_video_generations/resource_collection/studio_projects/convai_analysis_items) # Resource types that can be shared in the workspace. The name always need to match the collection names}\n@optional {user_email: any # The email of the user or service account., group_id: any # The ID of the target group. Use 'default' to set the resource's baseline role — every workspace member receives this role unless they hold a higher one through a direct user grant, group membership, or workspace (service account) API key., workspace_api_key_id: any # The ID of the target workspace (service account) API key. This is not the API key string itself that you pass in the header for authentication — it is the key's ID, which workspace admins can find under Developers → Service Accounts.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/workspace/resources/{resource_id}/unshare\n@desc Unshare Workspace Resource\n@required {resource_id: str # The ID of the target resource., resource_type: str(voice/voice_collection/pronunciation_dictionary/dubbing/dubbing_project/project/convai_agents/convai_knowledge_base_documents/convai_tools/convai_settings/convai_secrets/workspace_auth_connections/convai_phone_numbers/convai_mcp_servers/convai_api_integration_connections/convai_api_integration_trigger_connections/convai_batch_calls/convai_agent_response_tests/convai_test_suite_invocations/convai_crawl_jobs/convai_crawl_tasks/convai_kb_external_sync_jobs/convai_whatsapp_accounts/convai_agent_versions/convai_agent_branches/convai_agent_versions_deployments/convai_agent_experiments/convai_memory_entries/convai_templates/dashboard/dashboard_configuration/convai_agent_drafts/resource_locators/assets/content_generations/content_templates/content_skills/songs/transcription_tasks/avatars/avatar_video_generations/resource_collection/studio_projects/convai_analysis_items) # Resource types that can be shared in the workspace. The name always need to match the collection names}\n@optional {user_email: any # The email of the user or service account., group_id: any # The ID of the target group. Use 'default' to set the resource's baseline role — every workspace member receives this role unless they hold a higher one through a direct user grant, group membership, or workspace (service account) API key., workspace_api_key_id: any # The ID of the target workspace (service account) API key. This is not the API key string itself that you pass in the header for authentication — it is the key's ID, which workspace admins can find under Developers → Service Accounts.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/workspace/webhooks\n@desc List Workspace Webhooks\n@optional {include_usages: bool=false # Whether to include active usages of the webhook, only usable by admins}\n@returns(200) {webhooks: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/workspace/webhooks\n@desc Create Workspace Webhook\n@required {settings: map{auth_type!: str, name!: str, webhook_url!: str, request_headers: any, log_redacted_fields: [str]} # Settings for creating an HMAC-authenticated webhook}\n@returns(200) {webhook_id: str, webhook_secret: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/workspace/webhooks/{webhook_id}\n@desc Update Workspace Webhook\n@required {webhook_id: str # The unique ID for the webhook, is_disabled: bool # Whether to disable or enable the webhook, name: str # The display name of the webhook (used for display purposes only).}\n@optional {retry_enabled: any # Whether to enable automatic retries for transient failures (5xx, 429, timeout), request_headers: any # A list of request headers to include with the webhook delivery (optional), events: any # The complete set of workspace-level events this webhook should be subscribed to. The webhook is added to the events in the list and removed from any not in the list. Omit to leave the current event subscriptions unchanged., log_redacted_fields: any # Field names whose values the delivery log hides when it shows the request payload, matched at any depth, ignoring case and punctuation such as _ or -. Fields with secret-looking names, such as tokens and passwords, are always hidden. The stored log and redeliveries keep the original values. At most 50 names, each 1 to 128 characters, with no whitespace, dots or wildcards.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/workspace/webhooks/{webhook_id}\n@desc Delete Workspace Webhook\n@required {webhook_id: str # The unique ID for the webhook}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group music\n@endpoint POST /v1/music/video-to-music\n@desc Video To Music\n@optional {output_format: str(mp3_22050_32/mp3_24000_48/mp3_44100_32/mp3_44100_64/mp3_44100_96/mp3_44100_128/mp3_44100_192/pcm_8000/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/ulaw_8000/alaw_8000/opus_48000_32/opus_48000_64/opus_48000_96/opus_48000_128/opus_48000_192)=mp3_44100_128 # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs., enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. Zero retention mode may only be used by enterprise customers.}\n@returns(200) Generated audio file matching the video. Content-Type and file extension depend on the output_format parameter (default mp3).\n@errors {403: Subscription required., 422: Validation error (e.g. invalid or missing videos).}\n\n@endgroup\n\n@group speech-to-text\n@endpoint POST /v1/speech-to-text\n@desc Speech To Text\n@optional {token: any # A single-use authentication token created via POST /v1/single-use-token/batch_scribe. This token can only be used once and expires after 15 minutes. Alternative to API key or bearer token authentication for frontend clients., enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. This will mean log and transcript storage features are unavailable for this request. Zero retention mode may only be used by enterprise customers.}\n@returns(200) Synchronous transcription result\n@returns(202) Asynchronous request accepted\n@errors {422: Validation Error}\n\n@endpoint GET /v1/speech-to-text/transcripts/{transcription_id}\n@desc Get Transcript By Id\n@required {transcription_id: str # The unique ID of the transcript to retrieve}\n@returns(200) The transcript data\n@errors {401: Authentication required, 404: Transcript not found, 422: Validation Error}\n\n@endpoint DELETE /v1/speech-to-text/transcripts/{transcription_id}\n@desc Delete Transcript By Id\n@required {transcription_id: str # The unique ID of the transcript to delete}\n@returns(200) Delete completed successfully.\n@errors {401: Authentication required, 422: Validation Error}\n\n@endgroup\n\n@group single-use-token\n@endpoint POST /v1/single-use-token/{token_type}\n@desc Create Single Use Token\n@required {token_type: str}\n@returns(200) {token: str} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group forced-alignment\n@endpoint POST /v1/forced-alignment\n@desc Create Forced Alignment\n@returns(200) {characters: [map], words: [map], loss: num} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group convai\n@endpoint GET /v1/convai/conversation/get-signed-url\n@desc Get Signed Url\n@required {agent_id: str # Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.}\n@optional {include_conversation_id: bool=false # Whether to include a conversation_id with the response. If included, the conversation_signature cannot be used again., branch_id: any # The ID of the branch to use, version_id: any # The ID of the version to use, environment: any # The environment to use for resolving environment variables (e.g. 'production', 'staging'). Defaults to 'production'., debug_events_request: bool=false # Whether to enable debug events. Only available for users with editor access to the agent.}\n@returns(200) {signed_url: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/conversation/get_signed_url\n@desc Get Signed Url\n@required {agent_id: str # Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.}\n@optional {include_conversation_id: bool=false # Whether to include a conversation_id with the response. If included, the conversation_signature cannot be used again., branch_id: any # The ID of the branch to use, version_id: any # The ID of the version to use, environment: any # The environment to use for resolving environment variables (e.g. 'production', 'staging'). Defaults to 'production'., debug_events_request: bool=false # Whether to enable debug events. Only available for users with editor access to the agent.}\n@returns(200) {signed_url: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/conversation/token\n@desc Get Webrtc Token\n@required {agent_id: str # Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.}\n@optional {participant_name: any # Optional custom participant name. If not provided, user ID will be used, branch_id: any # The ID of the branch to use, version_id: any # The ID of the version to use, environment: any # The environment to use for resolving environment variables (e.g. 'production', 'staging'). Defaults to 'production'., debug_events_request: bool=false # Whether to enable debug events. Only available for users with editor access to the agent.}\n@returns(200) {token: str, conversation_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/twilio/outbound-call\n@desc Handle An Outbound Call Via Twilio\n@required {agent_id: str, agent_phone_number_id: str, to_number: str}\n@optional {conversation_initiation_client_data: any, call_recording_enabled: any # Whether let Twilio record the call., telephony_call_config: map{ringing_timeout_secs: int, twilio_call_recording_enabled: bool, twilio_machine_detection: any}}\n@returns(200) {success: bool, message: str, conversation_id: any, callSid: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/twilio/register-call\n@desc Register A Twilio Call And Return Twiml\n@required {agent_id: str, from_number: str, to_number: str}\n@optional {direction: str(inbound/outbound)=inbound, conversation_initiation_client_data: any}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/exotel/outbound-call\n@desc Handle An Outbound Call Via Exotel\n@required {agent_id: str, agent_phone_number_id: str, to_number: str}\n@optional {conversation_initiation_client_data: any, telephony_call_config: map{ringing_timeout_secs: int, twilio_call_recording_enabled: bool, twilio_machine_detection: any}}\n@returns(200) {success: bool, message: str, conversation_id: any, callSid: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/whatsapp/outbound-call\n@desc Make An Outbound Call Via Whatsapp\n@required {whatsapp_phone_number_id: str, whatsapp_user_id: str, whatsapp_call_permission_request_template_name: str, whatsapp_call_permission_request_template_language_code: str, agent_id: str}\n@optional {conversation_initiation_client_data: any}\n@returns(200) {success: bool, message: str, conversation_id: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/whatsapp/outbound-message\n@desc Send An Outbound Message Via Whatsapp\n@required {whatsapp_phone_number_id: str, whatsapp_user_id: str, template_name: str, template_language_code: str, template_params: [any], agent_id: str}\n@optional {conversation_initiation_client_data: any}\n@returns(200) {conversation_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/create\n@desc Create Agent\n@required {conversation_config: map{asr: map, turn: map, tts: map, conversation: map, language_presets: map, vad: map, agent: map}}\n@optional {enable_versioning: bool=true # Deprecated: all agents are versioned. This parameter is ignored., platform_settings: any # Platform settings for the agent are all settings that aren't related to the conversation orchestration and content., workflow: map{edges: map, nodes: map, prevent_subagent_loops: bool}, name: any # A name to make the agent easier to find, tags: any # Tags to help classify and filter the agent}\n@returns(200) {agent_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/summaries\n@desc Get Agent Summaries\n@required {agent_ids: [str] # List of agent IDs to fetch summaries for}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}\n@desc Get Agent\n@required {agent_id: str # The id of an agent. This is returned on agent creation.}\n@optional {version_id: any # The ID of the agent version to use, branch_id: any # The ID of the branch to use, include_procedure_generated_workflow_elements: bool=true # Whether to include the workflow nodes and edges generated from structured procedures. When false, the workflow contains only authored elements.}\n@returns(200) {agent_id: str, name: str, conversation_config: map{asr: map{quality: str, provider: str, user_input_audio_format: str, keywords: [str]}, turn: map{turn_timeout: num, initial_wait_time: any, silence_end_call_timeout: num, mode: str, turn_eagerness: str, spelling_patience: str, speculative_turn: bool, retranscribe_on_turn_timeout: bool, turn_model: str, interruption_ignore_terms: [str], interruption_ignore_term_languages: [str], merge_with_default_ignore_terms: bool, transcribe_on_disabled_interruptions: bool, soft_timeout_config: map{timeout_seconds: num, message: str, additional_soft_timeout_messages: [str], use_llm_generated_message: bool, randomize_fillers: bool, max_soft_timeouts_per_generation: int, llm_generated_message_prompt_override: any, disable_until_first_user_message: bool}, noisy_environment_detection: bool, noisy_environment_message: str}, tts: map{model_id: str, voice_id: str, supported_voices: [map], expressive_mode: bool, suggested_audio_tags: [map], agent_output_audio_format: str, optimize_streaming_latency: int, stability: num, speed: num, similarity_boost: num, clone_strength: num, text_normalisation_type: str, pronunciation_dictionary_locators: [map], enable_phoneme_tags: bool, audio_effects: any}, conversation: map{text_only: bool, max_duration_seconds: int, client_events: [str], file_input: map{enabled: bool, max_files_in_memory: int, max_files_per_conversation: int}, monitoring_enabled: bool, monitoring_events: [str], dtmf_input_settings: any, background_sound: map{source_type: any, source_id: any, volume: num, crossfade_loop: bool}, source_attribution: bool}, language_presets: map, vad: map{background_voice_detection: bool}, agent: map{first_message: str, language: str, hinglish_mode: bool, dynamic_variables: map{dynamic_variable_placeholders: map}, disable_first_message_interruptions: bool, max_conversation_duration_message: str, text_behavior_overrides: any, subagent_config: map{agents: [map], self_subagent: any}, prompt: map{prompt: str, llm: str, reasoning_effort: any, service_tier: str, thinking_budget: any, enable_reasoning_summary: bool, temperature: any, max_tokens: int, tool_ids: [str], tool_ids_strict: bool, built_in_tools: map, enable_parallel_tool_calls: bool, mcp_server_ids: [str], native_mcp_server_ids: [str], knowledge_base: [map], custom_llm: any, ignore_default_personality: any, rag: map, timezone: any, backup_llm_config: any, cascade_timeout_seconds: num, tools: [any]}}}, metadata: map{created_at_unix_secs: int, updated_at_unix_secs: int}, platform_settings: map{evaluation: map{criteria: [map]}, widget: map{variant: str, placement: str, expandable: str, avatar: any, feedback_mode: str, end_feedback: any, bg_color: str, text_color: str, btn_color: str, btn_text_color: str, border_color: str, focus_color: str, border_radius: any, btn_radius: any, action_text: any, start_call_text: any, end_call_text: any, expand_text: any, listening_text: any, speaking_text: any, shareable_page_text: any, shareable_page_show_terms: bool, terms_text: any, terms_html: any, terms_key: any, show_avatar_when_collapsed: any, disable_banner: bool, override_link: any, markdown_link_allowed_hosts: [map], markdown_link_include_www: bool, markdown_link_allow_http: bool, mic_muting_enabled: bool, transcript_enabled: bool, text_input_enabled: bool, conversation_mode_toggle_enabled: bool, default_expanded: bool, always_expanded: bool, dismissible: bool, show_agent_status: bool, show_conversation_id: bool, strip_audio_tags: bool, syntax_highlight_theme: any, text_contents: map{main_label: any, start_call: any, start_chat: any, new_call: any, end_call: any, mute_microphone: any, change_language: any, collapse: any, expand: any, copied: any, accept_terms: any, dismiss_terms: any, listening_status: any, speaking_status: any, connecting_status: any, chatting_status: any, queue_waiting_status: any, queue_waiting_status_short: any, input_label: any, input_placeholder: any, input_placeholder_text_only: any, input_placeholder_new_conversation: any, user_ended_conversation: any, agent_ended_conversation: any, conversation_id: any, error_occurred: any, queue_timed_out: any, copy_id: any, initiate_feedback: any, request_follow_up_feedback: any, thanks_for_feedback: any, thanks_for_feedback_details: any, follow_up_feedback_placeholder: any, submit: any, go_back: any, send_message: any, text_mode: any, voice_mode: any, switched_to_text_mode: any, switched_to_voice_mode: any, copy: any, download: any, wrap: any, agent_working: any, agent_done: any, agent_error: any, attach_file: any, remove_file: any, file_upload_error: any, file_type_unsupported: any, file_too_large: any, file_limit_reached: any, typing_indicator: any, rich_content_unavailable: any}, styles: map{base: any, base_hover: any, base_active: any, base_border: any, base_subtle: any, base_primary: any, base_error: any, accent: any, accent_hover: any, accent_active: any, accent_border: any, accent_subtle: any, accent_primary: any, overlay_padding: any, button_radius: any, input_radius: any, bubble_radius: any, sheet_radius: any, compact_sheet_radius: any, dropdown_sheet_radius: any}, show_resize_button: bool, end_confirmation_enabled: bool, mobile_fullscreen: bool, transcript_speech_sync_enabled: bool, language_selector: bool, supports_text_only: bool, custom_avatar_path: any, language_presets: map}, data_collection: map, data_collection_scopes: map, analysis_items: any, overrides: map{conversation_config_override: map{asr: map, turn: map, tts: map, conversation: map, agent: map}, custom_llm_extra_body: bool, enable_conversation_initiation_client_data_from_webhook: bool, enable_starting_workflow_node_id_from_client: bool, enable_procedure_ids_from_client: bool}, workspace_overrides: map{conversation_initiation_client_data_webhook: any, webhooks: map{post_call_webhook_id: any, events: [str], transcript_format: str, exclude_transcript: bool, send_audio: any}}, testing: map{attached_tests: [map]}, archived: bool, guardrails: map{version: str, focus: map{is_enabled: bool}, prompt_injection: map{is_enabled: bool}, content: map{execution_mode: str, config: map, trigger_action: any}, moderation: any, custom: map{config: map}}, summary_language: any, auto_translate_transcript_to_app_language: any, auth: map{enable_auth: bool, allowlist: [map], require_origin_header: bool, shareable_token: any}, call_limits: map{agent_concurrency_limit: int, daily_limit: int, bursting_enabled: bool}, queueing_config: map{enabled: bool, wait_timeout_seconds: int, hold_audio: any}, privacy: map{record_voice: bool, retention_days: int, delete_transcript_and_pii: bool, delete_audio: bool, apply_to_existing_conversations: bool, zero_retention_mode: bool, conversation_history_redaction: map{enabled: bool, entities: [str], excluded_data_collection_ids: [str]}}, trust_context: str, analysis_llm: str, topic_discovery: map, sentiment_analysis: map, alerting: any, safety: map{is_blocked_ivc: bool, is_blocked_non_ivc: bool, ignore_safety_evaluation: bool}}, phone_numbers: [any], whatsapp_accounts: [map], workflow: map{edges: map, nodes: map, prevent_subagent_loops: bool}, access_info: any, tags: [str], version_id: any, branch_id: any, main_branch_id: any, procedures: map, default_hold_audio_url: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/agents/{agent_id}\n@desc Patches An Agent Settings\n@required {agent_id: str # The id of an agent. This is returned on agent creation.}\n@optional {enable_versioning_if_not_enabled: bool=true # Deprecated: all agents are versioned. This parameter is ignored., branch_id: any # The ID of the branch to use, include_procedure_generated_workflow_elements: bool=true # Whether to include the workflow nodes and edges generated from structured procedures. When false, the workflow contains only authored elements., conversation_config: any # Conversation configuration for an agent, platform_settings: any # Platform settings for the agent are all settings that aren't related to the conversation orchestration and content., workflow: map{edges: map, nodes: map, prevent_subagent_loops: bool}, name: any # A name to make the agent easier to find, tags: any # Tags to help classify and filter the agent, version_description: any # Description for this version when publishing changes (only applicable for versioned agents), procedures: any # Procedure versions to publish, keyed by procedure_id. When provided, this map replaces the procedures from the current draft or branch tip. When omitted or null, unpublished procedure edits are used if present; otherwise, the branch tip's procedures are retained. Pass an empty object to remove all procedures.}\n@returns(200) {agent_id: str, name: str, conversation_config: map{asr: map{quality: str, provider: str, user_input_audio_format: str, keywords: [str]}, turn: map{turn_timeout: num, initial_wait_time: any, silence_end_call_timeout: num, mode: str, turn_eagerness: str, spelling_patience: str, speculative_turn: bool, retranscribe_on_turn_timeout: bool, turn_model: str, interruption_ignore_terms: [str], interruption_ignore_term_languages: [str], merge_with_default_ignore_terms: bool, transcribe_on_disabled_interruptions: bool, soft_timeout_config: map{timeout_seconds: num, message: str, additional_soft_timeout_messages: [str], use_llm_generated_message: bool, randomize_fillers: bool, max_soft_timeouts_per_generation: int, llm_generated_message_prompt_override: any, disable_until_first_user_message: bool}, noisy_environment_detection: bool, noisy_environment_message: str}, tts: map{model_id: str, voice_id: str, supported_voices: [map], expressive_mode: bool, suggested_audio_tags: [map], agent_output_audio_format: str, optimize_streaming_latency: int, stability: num, speed: num, similarity_boost: num, clone_strength: num, text_normalisation_type: str, pronunciation_dictionary_locators: [map], enable_phoneme_tags: bool, audio_effects: any}, conversation: map{text_only: bool, max_duration_seconds: int, client_events: [str], file_input: map{enabled: bool, max_files_in_memory: int, max_files_per_conversation: int}, monitoring_enabled: bool, monitoring_events: [str], dtmf_input_settings: any, background_sound: map{source_type: any, source_id: any, volume: num, crossfade_loop: bool}, source_attribution: bool}, language_presets: map, vad: map{background_voice_detection: bool}, agent: map{first_message: str, language: str, hinglish_mode: bool, dynamic_variables: map{dynamic_variable_placeholders: map}, disable_first_message_interruptions: bool, max_conversation_duration_message: str, text_behavior_overrides: any, subagent_config: map{agents: [map], self_subagent: any}, prompt: map{prompt: str, llm: str, reasoning_effort: any, service_tier: str, thinking_budget: any, enable_reasoning_summary: bool, temperature: any, max_tokens: int, tool_ids: [str], tool_ids_strict: bool, built_in_tools: map, enable_parallel_tool_calls: bool, mcp_server_ids: [str], native_mcp_server_ids: [str], knowledge_base: [map], custom_llm: any, ignore_default_personality: any, rag: map, timezone: any, backup_llm_config: any, cascade_timeout_seconds: num, tools: [any]}}}, metadata: map{created_at_unix_secs: int, updated_at_unix_secs: int}, platform_settings: map{evaluation: map{criteria: [map]}, widget: map{variant: str, placement: str, expandable: str, avatar: any, feedback_mode: str, end_feedback: any, bg_color: str, text_color: str, btn_color: str, btn_text_color: str, border_color: str, focus_color: str, border_radius: any, btn_radius: any, action_text: any, start_call_text: any, end_call_text: any, expand_text: any, listening_text: any, speaking_text: any, shareable_page_text: any, shareable_page_show_terms: bool, terms_text: any, terms_html: any, terms_key: any, show_avatar_when_collapsed: any, disable_banner: bool, override_link: any, markdown_link_allowed_hosts: [map], markdown_link_include_www: bool, markdown_link_allow_http: bool, mic_muting_enabled: bool, transcript_enabled: bool, text_input_enabled: bool, conversation_mode_toggle_enabled: bool, default_expanded: bool, always_expanded: bool, dismissible: bool, show_agent_status: bool, show_conversation_id: bool, strip_audio_tags: bool, syntax_highlight_theme: any, text_contents: map{main_label: any, start_call: any, start_chat: any, new_call: any, end_call: any, mute_microphone: any, change_language: any, collapse: any, expand: any, copied: any, accept_terms: any, dismiss_terms: any, listening_status: any, speaking_status: any, connecting_status: any, chatting_status: any, queue_waiting_status: any, queue_waiting_status_short: any, input_label: any, input_placeholder: any, input_placeholder_text_only: any, input_placeholder_new_conversation: any, user_ended_conversation: any, agent_ended_conversation: any, conversation_id: any, error_occurred: any, queue_timed_out: any, copy_id: any, initiate_feedback: any, request_follow_up_feedback: any, thanks_for_feedback: any, thanks_for_feedback_details: any, follow_up_feedback_placeholder: any, submit: any, go_back: any, send_message: any, text_mode: any, voice_mode: any, switched_to_text_mode: any, switched_to_voice_mode: any, copy: any, download: any, wrap: any, agent_working: any, agent_done: any, agent_error: any, attach_file: any, remove_file: any, file_upload_error: any, file_type_unsupported: any, file_too_large: any, file_limit_reached: any, typing_indicator: any, rich_content_unavailable: any}, styles: map{base: any, base_hover: any, base_active: any, base_border: any, base_subtle: any, base_primary: any, base_error: any, accent: any, accent_hover: any, accent_active: any, accent_border: any, accent_subtle: any, accent_primary: any, overlay_padding: any, button_radius: any, input_radius: any, bubble_radius: any, sheet_radius: any, compact_sheet_radius: any, dropdown_sheet_radius: any}, show_resize_button: bool, end_confirmation_enabled: bool, mobile_fullscreen: bool, transcript_speech_sync_enabled: bool, language_selector: bool, supports_text_only: bool, custom_avatar_path: any, language_presets: map}, data_collection: map, data_collection_scopes: map, analysis_items: any, overrides: map{conversation_config_override: map{asr: map, turn: map, tts: map, conversation: map, agent: map}, custom_llm_extra_body: bool, enable_conversation_initiation_client_data_from_webhook: bool, enable_starting_workflow_node_id_from_client: bool, enable_procedure_ids_from_client: bool}, workspace_overrides: map{conversation_initiation_client_data_webhook: any, webhooks: map{post_call_webhook_id: any, events: [str], transcript_format: str, exclude_transcript: bool, send_audio: any}}, testing: map{attached_tests: [map]}, archived: bool, guardrails: map{version: str, focus: map{is_enabled: bool}, prompt_injection: map{is_enabled: bool}, content: map{execution_mode: str, config: map, trigger_action: any}, moderation: any, custom: map{config: map}}, summary_language: any, auto_translate_transcript_to_app_language: any, auth: map{enable_auth: bool, allowlist: [map], require_origin_header: bool, shareable_token: any}, call_limits: map{agent_concurrency_limit: int, daily_limit: int, bursting_enabled: bool}, queueing_config: map{enabled: bool, wait_timeout_seconds: int, hold_audio: any}, privacy: map{record_voice: bool, retention_days: int, delete_transcript_and_pii: bool, delete_audio: bool, apply_to_existing_conversations: bool, zero_retention_mode: bool, conversation_history_redaction: map{enabled: bool, entities: [str], excluded_data_collection_ids: [str]}}, trust_context: str, analysis_llm: str, topic_discovery: map, sentiment_analysis: map, alerting: any, safety: map{is_blocked_ivc: bool, is_blocked_non_ivc: bool, ignore_safety_evaluation: bool}}, phone_numbers: [any], whatsapp_accounts: [map], workflow: map{edges: map, nodes: map, prevent_subagent_loops: bool}, access_info: any, tags: [str], version_id: any, branch_id: any, main_branch_id: any, procedures: map, default_hold_audio_url: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/agents/{agent_id}\n@desc Delete Agent\n@required {agent_id: str # The id of an agent. This is returned on agent creation.}\n@optional {force: bool=false # If set to true, the agent is deleted even if other agents use it as a subagent, and it is removed from those agents and their branches.}\n@returns(200) Successful Response\n@returns(204) Agent successfully deleted\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}/subagent-dependents\n@desc Get Agent Subagent Dependents\n@required {agent_id: str # The id of an agent. This is returned on agent creation.}\n@optional {page_size: int=30 # How many Agents to return at maximum. Can not exceed 100, defaults to 30., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {agents: [any], branches: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}/widget\n@desc Get Agent Widget Config\n@required {agent_id: str # The id of an agent. This is returned on agent creation.}\n@optional {conversation_signature: any # An expiring token that enables a websocket conversation to start. These can be generated for an agent using the /v1/convai/conversation/get_signed_url endpoint}\n@returns(200) {agent_id: str, widget_config: map{variant: str, placement: str, expandable: str, avatar: any, feedback_mode: str, end_feedback: any, bg_color: str, text_color: str, btn_color: str, btn_text_color: str, border_color: str, focus_color: str, border_radius: any, btn_radius: any, action_text: any, start_call_text: any, end_call_text: any, expand_text: any, listening_text: any, speaking_text: any, shareable_page_text: any, shareable_page_show_terms: bool, terms_text: any, terms_html: any, terms_key: any, show_avatar_when_collapsed: any, disable_banner: bool, override_link: any, markdown_link_allowed_hosts: [map], markdown_link_include_www: bool, markdown_link_allow_http: bool, mic_muting_enabled: bool, transcript_enabled: bool, text_input_enabled: bool, conversation_mode_toggle_enabled: bool, default_expanded: bool, always_expanded: bool, dismissible: bool, show_agent_status: bool, show_conversation_id: bool, strip_audio_tags: bool, syntax_highlight_theme: any, text_contents: map{main_label: any, start_call: any, start_chat: any, new_call: any, end_call: any, mute_microphone: any, change_language: any, collapse: any, expand: any, copied: any, accept_terms: any, dismiss_terms: any, listening_status: any, speaking_status: any, connecting_status: any, chatting_status: any, queue_waiting_status: any, queue_waiting_status_short: any, input_label: any, input_placeholder: any, input_placeholder_text_only: any, input_placeholder_new_conversation: any, user_ended_conversation: any, agent_ended_conversation: any, conversation_id: any, error_occurred: any, queue_timed_out: any, copy_id: any, initiate_feedback: any, request_follow_up_feedback: any, thanks_for_feedback: any, thanks_for_feedback_details: any, follow_up_feedback_placeholder: any, submit: any, go_back: any, send_message: any, text_mode: any, voice_mode: any, switched_to_text_mode: any, switched_to_voice_mode: any, copy: any, download: any, wrap: any, agent_working: any, agent_done: any, agent_error: any, attach_file: any, remove_file: any, file_upload_error: any, file_type_unsupported: any, file_too_large: any, file_limit_reached: any, typing_indicator: any, rich_content_unavailable: any}, styles: map{base: any, base_hover: any, base_active: any, base_border: any, base_subtle: any, base_primary: any, base_error: any, accent: any, accent_hover: any, accent_active: any, accent_border: any, accent_subtle: any, accent_primary: any, overlay_padding: any, button_radius: any, input_radius: any, bubble_radius: any, sheet_radius: any, compact_sheet_radius: any, dropdown_sheet_radius: any}, show_resize_button: bool, end_confirmation_enabled: bool, mobile_fullscreen: bool, transcript_speech_sync_enabled: bool, language: str, supported_language_overrides: any, language_presets: map, text_only: bool, supports_text_only: bool, first_message: any, use_rtc: any, file_input_config: map{enabled: bool, max_files_in_memory: int, max_files_per_conversation: int}}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}/link\n@desc Get Shareable Agent Link\n@required {agent_id: str # The id of an agent. This is returned on agent creation.}\n@returns(200) {agent_id: str, token: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/avatar\n@desc Post Agent Avatar\n@required {agent_id: str # The id of an agent. This is returned on agent creation.}\n@returns(200) {agent_id: str, avatar_url: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/hold-audio\n@desc Post Agent Hold Audio\n@required {agent_id: str # The id of an agent. This is returned on agent creation.}\n@returns(200) {agent_id: str, hold_audio: map{audio_path: str, audio_url: str, original_filename: str, duration_secs: num, size_bytes: int}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/agents/{agent_id}/hold-audio\n@desc Delete Agent Hold Audio\n@required {agent_id: str # The id of an agent. This is returned on agent creation.}\n@returns(200) {agent_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents\n@desc List Agents\n@optional {page_size: int=30 # How many Agents to return at maximum. Can not exceed 100, defaults to 30., search: any # Search by agents name., archived: any=false # Filter agents by archived status, show_only_owned_agents: bool=false # If set to true, the endpoint will omit any agents that were shared with you by someone else and include only the ones you own. Deprecated: use created_by_user_id instead., created_by_user_id: any # Filter agents by creator user ID. When set, only agents created by this user are returned. Takes precedence over show_only_owned_agents. Use '@me' to refer to the authenticated user., tags: any # Filter agents by tag. Repeat the parameter to match any of several tags., sort_direction: str=desc # The direction to sort the results, sort_by: any # The field to sort the results by, cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {agents: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agent/{agent_id}/knowledge-base/size\n@desc Returns The Size Of The Agent'S Knowledge Base\n@required {agent_id: str}\n@returns(200) {number_of_pages: num} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agent/{agent_id}/llm-usage/calculate\n@desc Calculate Expected Llm Usage For An Agent\n@required {agent_id: str}\n@optional {prompt_length: any # Length of the prompt in characters., number_of_pages: any # Pages of content in pdf documents OR urls in agent's Knowledge Base., rag_enabled: any # Whether RAG is enabled., service_tier: any # Service tier to price against. Only affects models that offer the tier; others fall back to their standard price.}\n@returns(200) {llm_prices: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/duplicate\n@desc Duplicate Agent\n@required {agent_id: str # The id of an agent. This is returned on agent creation.}\n@optional {name: any # A name to make the agent easier to find}\n@returns(200) {agent_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/simulate-conversation\n@desc Simulates A Conversation\n@required {agent_id: str # The id of an agent. This is returned on agent creation., simulation_specification: map{simulated_user_config!: map, tool_mock_config: map, partial_conversation_history: [map], dynamic_variables: map} # A specification that will be used to simulate a conversation between an agent and an AI user.}\n@optional {extra_evaluation_criteria: any # A list of evaluation criteria to test, new_turns_limit: int=100 # Maximum number of new turns to generate in the conversation simulation}\n@returns(200) {simulated_conversation: [map], analysis: map{evaluation_criteria_results: map, data_collection_results: map, evaluation_criteria_results_list: [map], data_collection_results_list: [map], call_successful: str, call_success_score: any, transcript_summary: str, call_summary_title: any, scoped: [map]}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/simulate-conversation/stream\n@desc Simulates A Conversation (Stream)\n@required {agent_id: str # The id of an agent. This is returned on agent creation., simulation_specification: map{simulated_user_config!: map, tool_mock_config: map, partial_conversation_history: [map], dynamic_variables: map} # A specification that will be used to simulate a conversation between an agent and an AI user.}\n@optional {extra_evaluation_criteria: any # A list of evaluation criteria to test, new_turns_limit: int=100 # Maximum number of new turns to generate in the conversation simulation}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agent-testing/create\n@desc Create Agent Response Test\n@returns(200) {id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agent-testing/folders\n@desc Create Agent Test Folder\n@required {name: str # The name of the folder to create}\n@optional {parent_folder_id: any # The ID of the parent folder. If not provided, the folder will be created at the root level.}\n@returns(200) {id: str, name: str} # Folder successfully created\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agent-testing/folders/{folder_id}\n@desc Get Agent Test Folder By Id\n@required {folder_id: str # The folder ID.}\n@returns(200) {id: str, name: str, folder_path: [map], children_count: int} # Folder details retrieved successfully\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/agent-testing/folders/{folder_id}\n@desc Update Agent Test Folder\n@required {folder_id: str # The folder ID., name: str # The new name for the folder}\n@returns(200) {id: str, name: str, folder_path: [map], children_count: int} # Folder successfully updated\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/agent-testing/folders/{folder_id}\n@desc Delete Agent Test Folder\n@required {folder_id: str # The folder ID.}\n@optional {force: bool=false # Force delete. Required for deleting non-empty folders.}\n@returns(204) Folder successfully deleted\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agent-testing/bulk-move\n@desc Bulk Move Tests To Folder\n@required {entity_ids: [str] # The IDs of tests or folders to move.}\n@optional {move_to: any # The folder to move the entities to. If not set, the entities will be moved to the root folder.}\n@returns(200) Tests or folders successfully moved to another folder\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agent-testing/{test_id}\n@desc Get Agent Response Test By Id\n@required {test_id: str # The id of a chat response test. This is returned on test creation.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint PUT /v1/convai/agent-testing/{test_id}\n@desc Update Agent Response Test\n@required {test_id: str # The id of a chat response test. This is returned on test creation.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/agent-testing/{test_id}\n@desc Delete Agent Response Test\n@required {test_id: str # The id of a chat response test. This is returned on test creation.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agent-testing/summaries\n@desc Get Agent Response Test Summaries By Ids\n@required {test_ids: [str] # List of test IDs to fetch. No duplicates allowed. Prefer at most 1000 IDs per request.}\n@returns(200) {tests: map} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agent-testing\n@desc List Agent Response Tests\n@optional {cursor: any # Used for fetching next page. Cursor is returned in the response., page_size: int=30 # How many Tests to return at maximum. Can not exceed 100, defaults to 30., search: any # Search query to filter tests and folders by name., parent_folder_id: any # Filter by parent folder ID. Use 'root' to get items in the root folder., types: any # If present, the endpoint will return only tests/folders of the given types., include_folders: any # Deprecated. Use the `types` query param and include `folder` instead., sort_mode: str(default/folders_first)=default # Sort mode for listing tests. Use 'folders_first' to place folders before tests., sharing_mode: str=all # Filter test visibility. Use `shared_with_me` to return only tests/folders shared with the current user that they did not create., created_by_user_id: any # Filter tests and folders by creator user ID. Use '@me' to refer to the authenticated user.}\n@returns(200) {tests: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/test-invocations\n@desc List Test Invocations\n@optional {agent_id: any # Filter by agent ID, branch_id: any # Filter by branch ID, created_by_user_id: any # Filter by test run creator user ID, test_id: any # Filter to invocations that include a run of this test id, start_time: any # Inclusive lower bound on created_at, in unix seconds, end_time: any # Inclusive upper bound on created_at, in unix seconds, version_id: any # Filter by the agent version the tests ran against, page_size: int=30 # How many Tests to return at maximum. Can not exceed 100, defaults to 30., search: any # Search query to filter tests and folders by name., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {meta: map{total: any, page: any, page_size: any}, results: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/run-tests\n@desc Run Tests On The Agent\n@required {agent_id: str # The id of an agent. This is returned on agent creation., tests: [map{test_id!: str, workflow_node_id: any, root_folder_id: any, root_folder_name: any}] # List of tests to run on the agent}\n@optional {name: any # Optional name for the test invocation., agent_config_override: any # Configuration overrides to use for testing. If not provided, the agent's default configuration will be used., branch_id: any # ID of the branch to run the tests on. If not provided, the tests will be run on the agent's main branch., repeat_count: int=1 # Number of times to run each test. When greater than 1, results are grouped and summarized.}\n@returns(200) {id: str, name: any, agent_id: any, branch_id: any, version_id: any, ran_against_draft: bool, created_at: int, folder_id: any, repeat_count: int, cancelled: bool, bucketing_status: any, result_groups: [map], test_runs: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/test-invocations/{test_invocation_id}\n@desc Get Test Invocation\n@required {test_invocation_id: str # The id of a test invocation. This is returned when tests are run.}\n@returns(200) {id: str, name: any, agent_id: any, branch_id: any, version_id: any, ran_against_draft: bool, created_at: int, folder_id: any, repeat_count: int, cancelled: bool, bucketing_status: any, result_groups: [map], test_runs: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/test-invocations/{test_invocation_id}\n@desc Update Test Invocation\n@required {test_invocation_id: str # The id of a test invocation. This is returned when tests are run., name: any # New name for the test invocation. Set to null to restore the generated title.}\n@returns(200) {id: str, name: any, agent_id: any, branch_id: any, version_id: any, ran_against_draft: bool, created_at: int, folder_id: any, repeat_count: int, cancelled: bool, bucketing_status: any, result_groups: [map], test_runs: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/test-invocations/{test_invocation_id}/cancel\n@desc Cancel Test Invocation\n@required {test_invocation_id: str # The id of a test invocation. This is returned when tests are run.}\n@returns(204) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/test-invocations/{test_invocation_id}/resubmit\n@desc Resubmit Tests\n@required {test_invocation_id: str # The id of a test invocation. This is returned when tests are run., test_run_ids: [str] # List of test run IDs to resubmit, agent_id: str # Agent ID to resubmit tests for}\n@optional {agent_config_override: any # Configuration overrides to use for testing. If not provided, the agent's default configuration will be used., branch_id: any # ID of the branch to run the tests on. If not provided, the tests will be run on the agent's main branch.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/conversations\n@desc Get Conversations\n@optional {cursor: any # Used for fetching next page. Cursor is returned in the response., agent_id: any # Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource., visited_agent_ids: any # Filter conversations where any of these agents participated. Can not exceed 50 values., visited_agent_branch_ids: any # Filter conversations where any of these agent branches participated. Can not exceed 50 values., triggered_procedure_ids: any # Filter conversations where any of these procedures were triggered. Can not exceed 50 values., call_successful: any # The result of the success evaluation, call_start_before_unix: any # Unix timestamp (in seconds) to filter conversations up to this start date., call_start_after_unix: any # Unix timestamp (in seconds) to filter conversations after to this start date., call_duration_min_secs: any # Minimum call duration in seconds., call_duration_max_secs: any # Maximum call duration in seconds., rating_max: any # Maximum overall rating (1-5)., rating_min: any # Minimum overall rating (1-5)., has_feedback_comment: any # Filter conversations with user feedback comments., user_id: any # Filter conversations by the user ID who initiated them., evaluation_params: any # Evaluation filters. Repeat param. Format: criteria_id:result where result is one of success|failure|unknown. Example: eval=value_framing:success, data_collection_params: any # Data collection filters. Repeat param. Format: id:op:value where op is one of eq|neq|gt|gte|lt|lte|in. For in, pipe-delimit values. An empty value matches conversations where the field was not collected (id:eq:), and neq with an empty value matches where it was (id:neq:). eq is exact equality. gt|gte|lt|lte require a numeric value., dynamic_variable_params: any # Dynamic variable filters. Repeat param. Format: name:op:value where op is one of eq|neq|gt|gte|lt|lte|in. For in, pipe-delimit values. An empty value matches conversations where the variable was not set (name:eq:), and neq with an empty value matches where it was (name:neq:). eq is exact equality. gt|gte|lt|lte require a numeric value. Names containing ':' cannot be expressed., data_collection_filter: any # A single data collection filter, for callers that can only send one scalar value per query param. Same format as data_collection_params (id:op:value); combined with it when both are given., dynamic_variable_filter: any # A single dynamic variable filter, for callers that can only send one scalar value per query param. Same format as dynamic_variable_params (name:op:value); combined with it when both are given., data_collection_ids: any # Data collection field IDs to include in each conversation summary. Repeat param. When omitted, data_collection_results is not returned., evaluation_criteria_ids: any # Evaluation criteria IDs to include in each conversation summary. Repeat param. When omitted, evaluation_criteria_results is not returned., tool_names: any # Filter conversations by tool names used during the call., tool_names_successful: any # Filter conversations by tool names that had successful calls., tool_names_errored: any # Filter conversations by tool names that had errored calls., tool_ids: any # Filter conversations by IDs of tools used during the call. Use '__system_' for system tools. Unlike tool_names, distinguishes between tools that share a name., tool_ids_successful: any # Filter conversations by IDs of tools that had successful calls., tool_ids_errored: any # Filter conversations by IDs of tools that had errored calls., include_invalid_tool_calls: bool=false # Also match tool calls that never ran., main_languages: any # Filter conversations by detected main language (language code)., phone_number_ids: any # Filter conversations by agent phone number IDs., whatsapp_phone_number_ids: any # Filter conversations by agent WhatsApp number IDs., page_size: int=30 # How many conversations to return at maximum. Can not exceed 100, defaults to 30., summary_mode: str(exclude/include)=exclude # Whether to include transcript summaries in the response., search: any # Full-text or fuzzy search over transcript messages, conversation_initiation_source: any, text_only: any, conversation_product_type: any # Restrict results to a single conversation product surface., branch_id: any # Filter conversations by branch ID., version_id: any # Filter conversations by version ID., parent_conversation_id: any # Filter conversations by parent conversation ID for subagent conversations., topic_ids: any # Filter conversations by topic IDs assigned during topic discovery., exclude_statuses: any # Exclude conversations with the given statuses. Useful for hiding in-progress / processing conversations from list views., tag_ids: any # Filter conversations by conversation tag IDs assigned via the conversation-tags endpoints., workflow_node_entered_id: any # Filter conversations to only those that entered the given node., termination_reasons: any # Filter conversations by their stored termination_reason (metadata.termination_reason). Repeat param to match any of several., guardrail_types: any # Filter to conversations where a guardrail of any of these types triggered (metadata.triggered_guardrails.guardrail_type). Repeat param to match any of several., custom_guardrail_names: any # Filter to conversations where a custom guardrail with any of these names triggered (metadata.triggered_guardrails.guardrail_name). Only custom guardrails carry a name. Repeat param to match any of several., sort_direction: str=desc # The direction to sort conversations by call start time. Defaults to descending (newest first).}\n@returns(200) {conversations: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/conversations\n@desc Create Conversation\n@required {agent: map{type!: str, agent_id!: str, branch_id: any, overrides: map}}\n@optional {environment: any # The environment to use for resolving environment variables (e.g. 'production', 'staging'). Defaults to the branch's environment, then 'production'., user_id: any # ID of the end user participating in this conversation (for agent owner's user identification), dynamic_variables: map}\n@returns(200) {conversation_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/users\n@desc Get Conversation Users\n@optional {agent_id: any # Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource., branch_id: any # Filter conversations by branch ID., call_start_before_unix: any # Unix timestamp (in seconds) to filter conversations up to this start date., call_start_after_unix: any # Unix timestamp (in seconds) to filter conversations after to this start date., search: any # Search/filter by user ID (exact match)., page_size: int=30 # How many users to return at maximum. Defaults to 30., sort_by: str=last_contact_unix_secs # The field to sort the results by. Defaults to last_contact_unix_secs., sort_direction: str=desc # The direction to sort the results, cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {users: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/conversations/resolve\n@desc Resolve Conversation Reference\n@required {agent_id: str # Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource., reference: str # A Slack message URL or a Zendesk ticket URL.}\n@returns(200) {agent_id: str, agent_name: any, conversation_product: str, status: str, user_id: any, branch_id: any, version_id: any, metadata: map{start_time_unix_secs: int, accepted_time_unix_secs: any, call_duration_secs: int, queue_wait_secs: any, cost: any, deletion_settings: map{deletion_time_unix_secs: any, deleted_logs_at_time_unix_secs: any, deleted_audio_at_time_unix_secs: any, deleted_transcript_at_time_unix_secs: any, delete_transcript_and_pii: bool, delete_audio: bool}, feedback: map{type: any, overall_score: any, likes: int, dislikes: int, rating: any, comment: any}, authorization_method: str, charging: map{dev_discount: bool, is_burst: bool, tier: any, llm_usage: map{irreversible_generation: map, initiated_generation: map}, llm_price: any, llm_charge: any, call_charge: any, platform_charge: any, platform_usage: map{category_usage: map}, platform_price: any, free_minutes_consumed: num, free_llm_dollars_consumed: num, tts_usage: any, asr_usage: any, analysis: any, voice_surcharge_charge: any}, phone_call: any, batch_call: any, termination_reason: str, error: any, warnings: [str], main_language: any, rag_usage: any, text_only: bool, features_usage: map{language_detection: map{enabled: bool, used: bool}, transfer_to_agent: map{enabled: bool, used: bool}, transfer_to_number: map{enabled: bool, used: bool}, multivoice: map{enabled: bool, used: bool}, dtmf_tones: map{enabled: bool, used: bool}, external_mcp_servers: map{enabled: bool, used: bool}, pii_zrm_workspace: bool, pii_zrm_agent: bool, tool_dynamic_variable_updates: map{enabled: bool, used: bool}, is_livekit: bool, voicemail_detection: map{enabled: bool, used: bool}, dtmf_input: map{enabled: bool, used: bool}, workflow: map{enabled: bool, tool_node: map, standalone_agent_node: map, phone_number_node: map, end_node: map, override_agent_node: map}, agent_testing: map{enabled: bool, tests_ran_after_last_modification: bool, tests_ran_in_last_7_days: bool}, versioning: map{enabled: bool, used: bool}, file_input: map{enabled: bool, used: bool}, freeform_procedure: map{enabled: bool, used: bool}, structured_procedure: map{enabled: bool, used: bool}}, eleven_assistant: map{is_eleven_assistant: bool}, initiator_id: any, conversation_initiation_source: str, conversation_initiation_source_version: any, timezone: any, async_metadata: any, whatsapp: any, sms: any, agent_created_from: str, agent_last_updated_from: str, voice_rewards: [map], cost_fiat: any}, analysis: any, user_message_count: any, agent_message_count: any, visited_agents: [map], conversation_initiation_client_data: map{conversation_config_override: map{asr: any, turn: any, tts: any, conversation: any, agent: any}, custom_llm_extra_body: map, user_id: any, source_info: map{source: any, version: any}, branch_id: any, environment: any, starting_workflow_node_id: any, procedure_ids: any, start_procedure_ids: any, dynamic_variables: map}, environment: str, conversation_id: str, has_audio: bool, has_user_audio: bool, has_response_audio: bool, has_auxiliary_audio: bool, transcript: [map], tag_ids: [str], otlp_traces: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/conversations/{conversation_id}\n@desc Get Conversation Details\n@required {conversation_id: str # The id of the conversation you're taking the action on.}\n@optional {format: str(json/opentelemetry)=json # Response format. Defaults to 'json'. Set to 'opentelemetry' for an OTLP-compatible trace payload using the same structure as the post-call webhook.}\n@returns(200) {agent_id: str, agent_name: any, conversation_product: str, status: str, user_id: any, branch_id: any, version_id: any, metadata: map{start_time_unix_secs: int, accepted_time_unix_secs: any, call_duration_secs: int, queue_wait_secs: any, cost: any, deletion_settings: map{deletion_time_unix_secs: any, deleted_logs_at_time_unix_secs: any, deleted_audio_at_time_unix_secs: any, deleted_transcript_at_time_unix_secs: any, delete_transcript_and_pii: bool, delete_audio: bool}, feedback: map{type: any, overall_score: any, likes: int, dislikes: int, rating: any, comment: any}, authorization_method: str, charging: map{dev_discount: bool, is_burst: bool, tier: any, llm_usage: map{irreversible_generation: map, initiated_generation: map}, llm_price: any, llm_charge: any, call_charge: any, platform_charge: any, platform_usage: map{category_usage: map}, platform_price: any, free_minutes_consumed: num, free_llm_dollars_consumed: num, tts_usage: any, asr_usage: any, analysis: any, voice_surcharge_charge: any}, phone_call: any, batch_call: any, termination_reason: str, error: any, warnings: [str], main_language: any, rag_usage: any, text_only: bool, features_usage: map{language_detection: map{enabled: bool, used: bool}, transfer_to_agent: map{enabled: bool, used: bool}, transfer_to_number: map{enabled: bool, used: bool}, multivoice: map{enabled: bool, used: bool}, dtmf_tones: map{enabled: bool, used: bool}, external_mcp_servers: map{enabled: bool, used: bool}, pii_zrm_workspace: bool, pii_zrm_agent: bool, tool_dynamic_variable_updates: map{enabled: bool, used: bool}, is_livekit: bool, voicemail_detection: map{enabled: bool, used: bool}, dtmf_input: map{enabled: bool, used: bool}, workflow: map{enabled: bool, tool_node: map, standalone_agent_node: map, phone_number_node: map, end_node: map, override_agent_node: map}, agent_testing: map{enabled: bool, tests_ran_after_last_modification: bool, tests_ran_in_last_7_days: bool}, versioning: map{enabled: bool, used: bool}, file_input: map{enabled: bool, used: bool}, freeform_procedure: map{enabled: bool, used: bool}, structured_procedure: map{enabled: bool, used: bool}}, eleven_assistant: map{is_eleven_assistant: bool}, initiator_id: any, conversation_initiation_source: str, conversation_initiation_source_version: any, timezone: any, async_metadata: any, whatsapp: any, sms: any, agent_created_from: str, agent_last_updated_from: str, voice_rewards: [map], cost_fiat: any}, analysis: any, user_message_count: any, agent_message_count: any, visited_agents: [map], conversation_initiation_client_data: map{conversation_config_override: map{asr: any, turn: any, tts: any, conversation: any, agent: any}, custom_llm_extra_body: map, user_id: any, source_info: map{source: any, version: any}, branch_id: any, environment: any, starting_workflow_node_id: any, procedure_ids: any, start_procedure_ids: any, dynamic_variables: map}, environment: str, conversation_id: str, has_audio: bool, has_user_audio: bool, has_response_audio: bool, has_auxiliary_audio: bool, transcript: [map], tag_ids: [str], otlp_traces: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/conversations/{conversation_id}\n@desc Delete Conversation\n@required {conversation_id: str # The id of the conversation you're taking the action on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/conversations/{conversation_id}/summary\n@desc Get Conversation Summary\n@required {conversation_id: str # The id of the conversation you're taking the action on.}\n@optional {max_messages: int=40 # Maximum number of chat message turns to include inline. When the conversation has more than this, the messages are omitted and messages_omitted is set.}\n@returns(200) {conversation_id: str, agent_id: str, status: str, call_summary_title: any, transcript_summary: any, call_successful: any, message_count: int, messages: any, messages_omitted: bool, note: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/conversations/{conversation_id}/sip-messages\n@desc Get Sip Messages For A Conversation\n@required {conversation_id: str # The id of the conversation you're taking the action on.}\n@optional {page_size: int=20, cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {sip_messages: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/conversations/{conversation_id}/audio\n@desc Get Conversation Audio\n@required {conversation_id: str # The id of the conversation you're taking the action on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/conversations/{conversation_id}/files/{file_id}\n@desc Get Conversation File\n@required {conversation_id: str # The id of the conversation you're taking the action on., file_id: str # The file ID returned when it was uploaded.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/conversations/{conversation_id}/files/{file_id}\n@desc Delete File Upload\n@required {file_id: str, conversation_id: str}\n@returns(200) {file_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/conversations/{conversation_id}/feedback\n@desc Send Conversation Feedback\n@required {conversation_id: str # The id of the conversation you're taking the action on.}\n@optional {feedback: any # Either 'like' or 'dislike' to indicate the feedback for the conversation.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/conversations/messages/text-search\n@desc Text Search Conversation Messages\n@required {text_query: str # The search query text for full-text and fuzzy matching}\n@optional {agent_id: any # Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource., visited_agent_ids: any # Filter conversations where any of these agents participated. Can not exceed 50 values., visited_agent_branch_ids: any # Filter conversations where any of these agent branches participated. Can not exceed 50 values., triggered_procedure_ids: any # Filter conversations where any of these procedures were triggered. Can not exceed 50 values., call_successful: any # The result of the success evaluation, call_start_before_unix: any # Unix timestamp (in seconds) to filter conversations up to this start date., call_start_after_unix: any # Unix timestamp (in seconds) to filter conversations after to this start date., call_duration_min_secs: any # Minimum call duration in seconds., call_duration_max_secs: any # Maximum call duration in seconds., rating_max: any # Maximum overall rating (1-5)., rating_min: any # Minimum overall rating (1-5)., has_feedback_comment: any # Filter conversations with user feedback comments., user_id: any # Filter conversations by the user ID who initiated them., evaluation_params: any # Evaluation filters. Repeat param. Format: criteria_id:result where result is one of success|failure|unknown. Example: eval=value_framing:success, data_collection_params: any # Data collection filters. Repeat param. Format: id:op:value where op is one of eq|neq|gt|gte|lt|lte|in. For in, pipe-delimit values. An empty value matches conversations where the field was not collected (id:eq:), and neq with an empty value matches where it was (id:neq:). eq is exact equality. gt|gte|lt|lte require a numeric value., dynamic_variable_params: any # Dynamic variable filters. Repeat param. Format: name:op:value where op is one of eq|neq|gt|gte|lt|lte|in. For in, pipe-delimit values. An empty value matches conversations where the variable was not set (name:eq:), and neq with an empty value matches where it was (name:neq:). eq is exact equality. gt|gte|lt|lte require a numeric value. Names containing ':' cannot be expressed., tool_names: any # Filter conversations by tool names used during the call., tool_names_successful: any # Filter conversations by tool names that had successful calls., tool_names_errored: any # Filter conversations by tool names that had errored calls., tool_ids: any # Filter conversations by IDs of tools used during the call. Use '__system_' for system tools. Unlike tool_names, distinguishes between tools that share a name., tool_ids_successful: any # Filter conversations by IDs of tools that had successful calls., tool_ids_errored: any # Filter conversations by IDs of tools that had errored calls., include_invalid_tool_calls: bool=false # Also match tool calls that never ran., main_languages: any # Filter conversations by detected main language (language code)., phone_number_ids: any # Filter conversations by agent phone number IDs., whatsapp_phone_number_ids: any # Filter conversations by agent WhatsApp number IDs., exclude_statuses: any # Exclude conversations with the given statuses. Useful for hiding in-progress / processing conversations from list views., termination_reasons: any # Filter conversations by their stored termination_reason (metadata.termination_reason). Repeat param to match any of several., page_size: int=20 # Number of results per page. Max 50., summary_mode: str(exclude/include)=exclude # Whether to include transcript summaries in the response., conversation_initiation_source: any, text_only: any, conversation_product_type: any # Restrict results to a single conversation product surface., branch_id: any # Filter conversations by branch ID., version_id: any # Filter conversations by version ID., topic_ids: any # Filter conversations by topic IDs assigned during topic discovery., sort_by: str=search_score # Sort order for search results. 'search_score' sorts by search score, 'created_at' sorts by conversation start time., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {meta: map{total: any, page: any, page_size: any}, results: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/conversations/messages/smart-search\n@desc Smart Search Conversation Messages\n@required {text_query: str # The search query text for semantic similarity matching}\n@optional {agent_id: any # Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource., branch_id: any # Filter conversations by branch ID., page_size: int=20 # Number of results per page. Max 50., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {meta: map{total: any, page: any, page_size: any}, results: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/conversations/{conversation_id}/tags\n@desc Assign Conversation Tags\n@required {conversation_id: str, tag_ids: [str] # Tag IDs to add to the conversation. Re-assigning an existing tag is a no-op.}\n@returns(204) Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/conversations/{conversation_id}/tags/{tag_id}\n@desc Unassign Conversation Tag\n@required {conversation_id: str, tag_id: str}\n@returns(204) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/tags\n@desc List Conversation Tags\n@optional {page_size: int=100 # How many conversation tags to return. Can not exceed 100., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {conversation_tags: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/tags\n@desc Create Conversation Tag\n@required {title: str # Display title of the tag.}\n@optional {description: any # Optional free-text description.}\n@returns(200) {tag_id: str, workspace_id: str, owner_user_id: str, title: str, description: any, created_at_unix_secs: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/tags/{tag_id}\n@desc Get Conversation Tag\n@required {tag_id: str}\n@returns(200) {tag_id: str, workspace_id: str, owner_user_id: str, title: str, description: any, created_at_unix_secs: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/tags/{tag_id}\n@desc Update Conversation Tag\n@required {tag_id: str}\n@optional {title: any # If provided, replaces the tag title. Omit to leave unchanged., description: any # If provided, replaces the tag description. Omit to leave unchanged.}\n@returns(200) {tag_id: str, workspace_id: str, owner_user_id: str, title: str, description: any, created_at_unix_secs: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/tags/{tag_id}\n@desc Delete Conversation Tag\n@required {tag_id: str}\n@returns(204) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}/triage-tickets\n@desc List Agent Conversation Tickets\n@required {agent_id: str}\n@optional {page_size: int=100 # How many agent issues to return. Can not exceed 100., conversation_id: any # Filter agent issues by conversation id., status: any # Filter agent issues by status., sources: any # Filter agent issues by how they were raised (qa, agent, manual). Repeat the parameter to filter by multiple sources., priorities: any # Filter agent issues by priority. Repeat the parameter to filter by multiple priorities., sort_by: str=created_at # Order by most recently created, by priority (most urgent first, then most recently created), or by most recently reported (the newest report merged into the agent issue, else its creation)., owner_user_id: any # Filter agent issues by creator. Use 'agent' for agent-raised issues., assignee_user_id: any # Filter agent issues by assignee. Use 'unassigned' for issues with no assignee., issue_type: any # Filter agent issues by type., label: any # Filter agent issues by an exact label., merged_into_ticket_id: any # Filter agent issues merged into this issue., search: any # Case-insensitive free-text search across the agent issue's title, description, comments, and turn comments., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {agent_conversation_tickets: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/triage-tickets\n@desc Create Manual Agent Ticket\n@required {agent_id: str, qa_comment: str # What the agent issue is about, e.g. a follow-up task for the agent.}\n@optional {title: any # One-line headline shown in the issues list. Defaults to one derived from qa_comment., priority: any # How urgently the agent issue needs attention.}\n@returns(200) {agentqa_ticket_id: str, workspace_id: str, owner_user_id: str, agent_id: str, needs_clustering: bool, title: any, issue_type: any, labels: [str], conversation_ids: [str], first_seen_unix_secs: any, last_seen_unix_secs: any, qa_comment: any, ticket_comments: [map], turn_comments: [map], status: str, priority: any, priority_changes: [map], status_changes: [map], merged_into_ticket_id: any, source: str, assignee_user_id: any, created_at_unix_secs: int, updated_at_unix_secs: int, search_match: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/triage-tickets\n@desc List Workspace Conversation Tickets\n@optional {page_size: int=100 # How many agent issues to return. Can not exceed 100., agent_id: any # Only issues for this agent., status: any # Filter agent issues by status., sources: any # Filter agent issues by how they were raised (qa, agent, manual). Repeat the parameter to filter by multiple sources., priorities: any # Filter agent issues by priority. Repeat the parameter to filter by multiple priorities., sort_by: str=created_at # Order by most recently created, by priority (most urgent first, then most recently created), or by most recently reported (the newest report merged into the agent issue, else its creation)., owner_user_id: any # Filter agent issues by creator. Use 'agent' for agent-raised issues., assignee_user_id: any # Filter agent issues by assignee. Use 'unassigned' for issues with no assignee., issue_type: any # Filter agent issues by type., label: any # Filter agent issues by an exact label., merged_into_ticket_id: any # Filter agent issues merged into this issue., search: any # Case-insensitive free-text search across the agent issue's title, description, comments, and turn comments., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {agent_conversation_tickets: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/triage-tickets\n@desc Create Agent Conversation Ticket\n@required {conversation_id: str # Conversation this agent issue is about.}\n@optional {title: any # One-line headline shown in the issues list. Defaults to one derived from the comments, falling back to the conversation's summary title. Ignored when the comment is added to the conversation's open issue., qa_comment: any # The problem this agent issue is about, covering the whole conversation rather than a single turn., turn_comments: [map{turn_index!: int, comment!: str}] # Optional turn-level comments on what went wrong., priority: any # How urgently the agent issue needs attention. If the conversation already has an open issue, it is raised to this priority when lower.}\n@returns(200) {agentqa_ticket_id: str, workspace_id: str, owner_user_id: str, agent_id: str, needs_clustering: bool, title: any, issue_type: any, labels: [str], conversation_ids: [str], first_seen_unix_secs: any, last_seen_unix_secs: any, qa_comment: any, ticket_comments: [map], turn_comments: [map], status: str, priority: any, priority_changes: [map], status_changes: [map], merged_into_ticket_id: any, source: str, assignee_user_id: any, created_at_unix_secs: int, updated_at_unix_secs: int, search_match: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}/triage-tickets/assignable-users\n@desc Get Agent Conversation Ticket Assignable Users\n@required {agent_id: str}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/triage-tickets/{agentqa_ticket_id}\n@desc Get Agent Conversation Ticket\n@required {agentqa_ticket_id: str}\n@returns(200) {agentqa_ticket_id: str, workspace_id: str, owner_user_id: str, agent_id: str, needs_clustering: bool, title: any, issue_type: any, labels: [str], conversation_ids: [str], first_seen_unix_secs: any, last_seen_unix_secs: any, qa_comment: any, ticket_comments: [map], turn_comments: [map], status: str, priority: any, priority_changes: [map], status_changes: [map], merged_into_ticket_id: any, source: str, assignee_user_id: any, created_at_unix_secs: int, updated_at_unix_secs: int, search_match: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/triage-tickets/{agentqa_ticket_id}\n@desc Update Agent Conversation Ticket\n@required {agentqa_ticket_id: str}\n@optional {title: any # If provided, updates the agent issue's title. Omit to leave unchanged., qa_comment: any # If provided, updates the agent issue's description. Omit to leave unchanged., status: any # If provided, updates the agent issue's status. Omit to leave unchanged., assignee_user_id: any # If provided, updates who is responsible for resolving this agent issue. Must be a workspace member with at least viewer access to the agent. Pass null to unassign. Omit to leave unchanged., priority: any # If provided, updates how urgently the agent issue needs attention. Pass null to clear it. Omit to leave unchanged.}\n@returns(200) {agentqa_ticket_id: str, workspace_id: str, owner_user_id: str, agent_id: str, needs_clustering: bool, title: any, issue_type: any, labels: [str], conversation_ids: [str], first_seen_unix_secs: any, last_seen_unix_secs: any, qa_comment: any, ticket_comments: [map], turn_comments: [map], status: str, priority: any, priority_changes: [map], status_changes: [map], merged_into_ticket_id: any, source: str, assignee_user_id: any, created_at_unix_secs: int, updated_at_unix_secs: int, search_match: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/triage-tickets/{agentqa_ticket_id}\n@desc Delete Agent Conversation Ticket\n@required {agentqa_ticket_id: str}\n@returns(204) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/triage-tickets/{agentqa_ticket_id}/comments\n@desc Add Comment To Agent Conversation Ticket\n@required {agentqa_ticket_id: str, comment: str # A comment discussing how to resolve the agent issue.}\n@returns(200) {agentqa_ticket_id: str, workspace_id: str, owner_user_id: str, agent_id: str, needs_clustering: bool, title: any, issue_type: any, labels: [str], conversation_ids: [str], first_seen_unix_secs: any, last_seen_unix_secs: any, qa_comment: any, ticket_comments: [map], turn_comments: [map], status: str, priority: any, priority_changes: [map], status_changes: [map], merged_into_ticket_id: any, source: str, assignee_user_id: any, created_at_unix_secs: int, updated_at_unix_secs: int, search_match: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/triage-tickets/{agentqa_ticket_id}/merge\n@desc Merge Agent Conversation Tickets\n@required {agentqa_ticket_id: str, source_ticket_ids: [str] # Open issues of the same agent to fold into this one. They are kept with status 'merged', pointing at this issue.}\n@returns(200) {agentqa_ticket_id: str, workspace_id: str, owner_user_id: str, agent_id: str, needs_clustering: bool, title: any, issue_type: any, labels: [str], conversation_ids: [str], first_seen_unix_secs: any, last_seen_unix_secs: any, qa_comment: any, ticket_comments: [map], turn_comments: [map], status: str, priority: any, priority_changes: [map], status_changes: [map], merged_into_ticket_id: any, source: str, assignee_user_id: any, created_at_unix_secs: int, updated_at_unix_secs: int, search_match: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/triage-tickets/{agentqa_ticket_id}/turn-comments\n@desc Add Turn Comment To Agent Conversation Ticket\n@required {agentqa_ticket_id: str, turn_index: int # Zero-based index of the transcript turn this comment refers to., comment: str # What went wrong at this turn.}\n@returns(200) {agentqa_ticket_id: str, workspace_id: str, owner_user_id: str, agent_id: str, needs_clustering: bool, title: any, issue_type: any, labels: [str], conversation_ids: [str], first_seen_unix_secs: any, last_seen_unix_secs: any, qa_comment: any, ticket_comments: [map], turn_comments: [map], status: str, priority: any, priority_changes: [map], status_changes: [map], merged_into_ticket_id: any, source: str, assignee_user_id: any, created_at_unix_secs: int, updated_at_unix_secs: int, search_match: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/phone-numbers\n@desc Import Phone Number\n@returns(200) {phone_number_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/phone-numbers\n@desc List Phone Numbers\n@optional {provider: any # Filter by telephony provider, agent_id: any # Filter by assigned agent ID, branch_id: any # Filter by assigned branch ID}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/phone-numbers/{phone_number_id}\n@desc Get Phone Number\n@required {phone_number_id: str # The phone number ID. This is returned when a phone number is imported.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/phone-numbers/{phone_number_id}\n@desc Delete Phone Number\n@required {phone_number_id: str # The phone number ID. This is returned when a phone number is imported.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/phone-numbers/{phone_number_id}\n@desc Update Phone Number\n@required {phone_number_id: str # The phone number ID. This is returned when a phone number is imported.}\n@optional {agent_id: any, label: any, inbound_trunk_config: any, outbound_trunk_config: any, livekit_stack: any, store_sip_messages: any, environment: any # Environment to use for resolving environment variables on calls to this number., branch_id: any # Agent branch to use for calls to this number.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/v2/phone-numbers\n@desc List Phone Numbers Page\n@optional {page_size: int=100 # Number of phone numbers per page, search: any # Filter by phone number ID, label, or phone number. A phone number ID must match exactly; label and phone number matching is a case-insensitive substring., label: any # Filter by label. Matching is a case-insensitive substring., phone_number: any # Filter by phone number, provider: any # Filter by telephony provider, supports_outbound: any # Filter by whether the phone number can place outbound calls, agent_id: any # Filter by assigned agent ID, branch_id: any # Filter by assigned branch ID, sort_by: any # The field to sort the results by, sort_direction: str=asc # The direction to sort the results, cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {phone_numbers: [any], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/phone-numbers/{phone_number_id}/sip-messages\n@desc Get Sip Messages For A Phone Number\n@required {phone_number_id: str # The phone number ID. This is returned when a phone number is imported.}\n@optional {page_size: int=20, cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {sip_messages: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/llm-usage/calculate\n@desc Calculate Expected Llm Usage\n@required {prompt_length: int # Length of the prompt in characters., number_of_pages: int # Pages of content in PDF documents or URLs in the agent's knowledge base., rag_enabled: bool # Whether RAG is enabled.}\n@optional {service_tier: any # Service tier to price against. Only affects models that offer the tier; others fall back to their standard price.}\n@returns(200) {llm_prices: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/llm/list\n@desc List Available Llms\n@returns(200) {llms: [map], default_deprecation_config: map{warning_start_days: int, fallback_start_days: int, fallback_complete_days: int, fallback_start_percentage: int, fallback_complete_percentage: int}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/conversations/{conversation_id}/files\n@desc Upload File\n@required {conversation_id: str}\n@returns(200) {file_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/analytics/live-count\n@desc Get Live Count\n@optional {agent_id: any # The id of an agent to restrict the analytics to., agent_ids: any # Restrict analytics to the union of the given agents. Takes precedence over `agent_id` when both are supplied.}\n@returns(200) {count: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/knowledge-base/summaries\n@desc Get Knowledge Base Summaries By Ids\n@required {document_ids: [str] # The ids of knowledge base documents.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/knowledge-base\n@desc Add To Knowledge Base\n@optional {agent_id: str=}\n@returns(200) {id: str, name: str, folder_path: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/knowledge-base\n@desc Get Knowledge Base List\n@optional {page_size: int=30 # How many documents to return at maximum. Can not exceed 100, defaults to 30., search: any # If specified, the endpoint returns only such knowledge base documents whose names start with this string., show_only_owned_documents: bool=false # If set to true, the endpoint will return only documents owned by you (and not shared from somebody else). Deprecated: use created_by_user_id instead., created_by_user_id: any # Filter documents by creator user ID. When set, only documents created by this user are returned. Takes precedence over show_only_owned_documents. Use '@me' to refer to the authenticated user., types: any # If present, the endpoint will return only documents of the given types., parent_folder_id: any # If set, the endpoint will return only documents that are direct children of the given folder., ancestor_folder_id: any # If set, the endpoint will return only documents that are descendants of the given folder., folders_first: bool=false # Whether folders should be returned first in the list of documents., sort_direction: str=desc # The direction to sort the results, sort_by: any # The field to sort the results by, cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {documents: [any], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/knowledge-base/url\n@desc Create Url Document\n@required {url: str # URL to a page of documentation that the agent will have access to in order to interact with users.}\n@optional {name: any # A custom, human-readable name for the document., parent_folder_id: any # If set, the created document or folder will be placed inside the given folder., enable_auto_sync: bool=false # Whether to enable auto-sync for this URL document., auto_remove: bool=false # Whether to automatically remove the document if the URL becomes unavailable. Only applicable when auto-sync is enabled., minimum_frequency_days: any # Minimum frequency (in days) at which the document is refreshed. The actual interval may be shorter, never longer. Defaults to 7, tightened to the parent folder's frequency if that is stricter. Only applicable when auto-sync is enabled.}\n@returns(200) {id: str, name: str, folder_path: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/knowledge-base/crawl\n@desc Create Crawl Job\n@required {url: str # URL to a page of documentation that the agent will have access to in order to interact with users.}\n@optional {max_depth: int=3 # Deprecated - this field is a no-op and will be removed in a future version., max_pages: int=1000 # Maximum number of pages to crawl (1-10,000), defaults to 1000., pattern: any # If set, only URLs that match this pattern are included., exclude_patterns: any # If set, URLs that match any of these patterns are skipped, even if they match `pattern`., sitemap_urls: any # List of URLs to crawl from sitemap (optional, overrides automatic URL discovery)., parent_folder_id: any # If set, the created document or folder will be placed inside the given folder., enable_auto_sync: bool=false # Whether to enable auto-sync for this URL document., auto_remove: bool=false # Whether to automatically remove the document if the URL becomes unavailable. Only applicable when auto-sync is enabled., auto_discover: bool=false # Automatically discover and add new pages during auto-sync: pages linked from already-crawled pages for website crawls, or new sitemap entries matching `pattern` and `exclude_patterns` for sitemap crawls. Requires enable_auto_sync=true., minimum_frequency_days: any # Minimum frequency (in days) at which the underlying eligible documents are refreshed. The actual interval may be shorter, never longer. Defaults to 7, tightened to the parent folder's frequency if that is stricter. Only applicable when auto-sync is enabled.}\n@returns(200) {id: str, type: str, root_folder_id: str, status: str, created_at: int, folder_path: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/knowledge-base/crawl\n@desc List Ongoing And Recent Crawl Jobs Created By A User\n@optional {include_job_ids: any # Ids of additional crawl jobs to retrieve, page_size: int=30 # How many documents to return at maximum. Can not exceed 100, defaults to 30., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {crawl_jobs: [map], next_cursor: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/knowledge-base/crawl/{crawl_job_id}\n@desc Get Crawl Job Details\n@required {crawl_job_id: str # The id of the crawl job to retrieve}\n@returns(200) {type: str, seed_url: str, pattern: any, exclude_patterns: [str], max_pages: int, auto_discover: bool, status: str, pages_identified: int, pages_scraped: int, pages_skipped: int, pages_failed: int, root_folder_id: str, updated_at: int, id: str, created_at: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/knowledge-base/crawl/{crawl_job_id}/cancel\n@desc Cancel Crawl Job\n@required {crawl_job_id: str # The id of the crawl job to retrieve}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/knowledge-base/file\n@desc Create File Document\n@returns(200) {id: str, name: str, folder_path: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/knowledge-base/text\n@desc Create Text Document\n@required {text: str # Text content to be added to the knowledge base.}\n@optional {name: any # A custom, human-readable name for the document., parent_folder_id: any # If set, the created document or folder will be placed inside the given folder.}\n@returns(200) {id: str, name: str, folder_path: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/knowledge-base/folder\n@desc Create Folder\n@required {name: str # A custom, human-readable name for the document.}\n@optional {parent_folder_id: any # If set, the created document or folder will be placed inside the given folder., enable_auto_sync: bool=false # Whether to enable auto-sync for this URL document., auto_remove: bool=false # Whether to automatically remove the document if the URL becomes unavailable. Only applicable when auto-sync is enabled., minimum_frequency_days: any # Minimum frequency (in days) at which the underlying eligible documents are refreshed. The actual interval may be shorter, never longer. Defaults to 7, tightened to the parent folder's frequency if that is stricter. Only applicable when auto-sync is enabled.}\n@returns(200) {id: str, name: str, folder_path: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/knowledge-base/{documentation_id}\n@desc Update Document\n@required {documentation_id: str # The id of a document from the knowledge base. This is returned on document addition.}\n@optional {name: any # A custom, human-readable name for the document., content: any # Updated content for the document. Only supported for text documents, URL documents with auto-sync disabled, and file documents that are not synced from an external source., enable_auto_sync: any # Whether the document or folder is refreshed automatically. Only applicable to URL documents, folders, and externally-synced files. Leave unset to keep the current value., auto_remove: any # Whether to automatically remove the document once its source is no longer available. Only applicable when auto-sync is enabled. Leave unset to keep the current value., minimum_frequency_days: any # Minimum frequency (in days) at which the document is refreshed. The actual interval may be shorter, never longer. Only applicable when auto-sync is enabled. Leave unset to keep the current value., tighten_only: bool=false # Folders only. When true, items already in the folder are only tightened to stay at least as strict as the folder, and keep any setting that is stricter than the folder's. When false, they are set to exactly the folder's auto-sync settings. Ignored for externally synced folders, whose contents always follow the folder's schedule.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/knowledge-base/{documentation_id}\n@desc Get Documentation From Knowledge Base\n@required {documentation_id: str # The id of a document from the knowledge base. This is returned on document addition.}\n@optional {agent_id: str=}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/knowledge-base/{documentation_id}\n@desc Delete Knowledge Base Document Or Folder\n@required {documentation_id: str # The id of a document from the knowledge base. This is returned on document addition.}\n@optional {force: bool=false # If set to true, the document or folder will be deleted regardless of whether it is used by any agents and it will be removed from the dependent agents. For non-empty folders, this will also delete all child documents and folders.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/knowledge-base/{documentation_id}/chunking-override\n@desc Get Chunking Override\n@required {documentation_id: str # The id of a document from the knowledge base. This is returned on document addition.}\n@returns(200) {id: str, chunking_override: any, effective_chunking_override: map{max_chunk_size: any, overlap_percentage: any, custom_separators: any}, inherited_chunking_override: map{max_chunk_size: any, overlap_percentage: any, custom_separators: any}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/knowledge-base/{documentation_id}/chunking-override\n@desc Update Chunking Override\n@required {documentation_id: str # The id of a document from the knowledge base. This is returned on document addition., chunking_override: any # RAG chunking override for a document or folder. Null clears the override so ancestors and embedding model defaults apply.}\n@returns(200) {id: str, chunking_override: any, reindex_queued: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/knowledge-base/{documentation_id}/update-file\n@desc Update File Document\n@required {documentation_id: str # The id of a document from the knowledge base. This is returned on document addition.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/knowledge-base/rag-index\n@desc Compute Rag Indexes In Batch\n@required {items: [map{document_id!: str, create_if_missing!: bool, model!: str}] # List of requested RAG indexes. Minimum 1, maximum 100 items.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/knowledge-base/rag-index\n@desc Get Rag Index Overview.\n@returns(200) {total_used_bytes: int, total_max_bytes: int, models: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/knowledge-base/{documentation_id}/refresh\n@desc Refresh Url Document Content\n@required {documentation_id: str # The id of a document from the knowledge base. This is returned on document addition.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/knowledge-base/{documentation_id}/rag-index\n@desc Compute Rag Index.\n@required {documentation_id: str # The id of a document from the knowledge base. This is returned on document addition., model: str(e5_mistral_7b_instruct/multilingual_e5_large_instruct)=e5_mistral_7b_instruct}\n@returns(200) {id: str, model: str, status: str, progress_percentage: num, document_model_index_usage: map{used_bytes: int}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/knowledge-base/{documentation_id}/rag-index\n@desc Get Rag Indexes Of The Specified Knowledgebase Document.\n@required {documentation_id: str # The id of a document from the knowledge base. This is returned on document addition.}\n@returns(200) {indexes: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/knowledge-base/{documentation_id}/rag-index/{rag_index_id}\n@desc Delete Rag Index.\n@required {documentation_id: str # The id of a document from the knowledge base. This is returned on document addition., rag_index_id: str # The id of RAG index of document from the knowledge base.}\n@returns(200) {id: str, model: str, status: str, progress_percentage: num, document_model_index_usage: map{used_bytes: int}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/knowledge-base/search\n@desc Search Knowledge Base Content\n@required {query: str # The search query text}\n@optional {page_size: int=30 # How many documents to return at maximum. Can not exceed 100, defaults to 30., types: any # If present, the endpoint will return only documents of the given types., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {results: [map], next_cursor: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/knowledge-base/rag-query\n@desc Query Agent Knowledge Base Rag\n@required {agent_id: str # The id of an agent. This is returned on agent creation.}\n@optional {branch_id: any # The ID of the branch to use, strategy: str(cat/keyword/semantic/ls)=semantic, query: any # Query to search the knowledge base for. Required for the semantic and keyword strategies., documents: any # IDs or names of knowledge base documents or folders. Semantic and keyword search only search these entries; cat reads the single document given; ls lists the single folder given, or the top level of the knowledge base when omitted., use_agent_defaults: bool=true # When true (the default), retrieval uses the agent's own RAG settings, reproducing exactly what the agent would retrieve. Set to false to retrieve with neutral default RAG settings instead (the agent's embedding model is always kept, since it determines which vector index exists). Useful for auditing the knowledge base independently of how a particular agent is tuned., max_documents_length: any # Optional maximum total character length of document chunks returned. Overrides the selected RAG settings for this query only., max_retrieved_rag_chunks_count: any # Optional maximum number of document chunks retrieved. Overrides the selected RAG settings for this query only.}\n@returns(200) {strategy: str, retrieval_query: any, chunks: [map], document: any, listing: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/knowledge-base/{documentation_id}/dependent-agents\n@desc Get Dependent Agents List\n@required {documentation_id: str # The id of a document from the knowledge base. This is returned on document addition.}\n@optional {dependent_type: str=all # Type of dependent agents to return., page_size: int=30 # How many documents to return at maximum. Can not exceed 100, defaults to 30., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {agents: [any], branches: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/knowledge-base/dependent-agents\n@desc Get Dependent Agents For Multiple Documents\n@required {document_ids: [str] # The ids of documents or folders from the knowledge base.}\n@optional {dependent_type: str=all # Type of dependent agents to return., page_size: int=30 # How many documents to return at maximum. Can not exceed 100, defaults to 30., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {agents: [any], branches: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/knowledge-base/{documentation_id}/content\n@desc Get Document Content\n@required {documentation_id: str # The id of a document from the knowledge base. This is returned on document addition.}\n@returns(200) Streaming document content\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/knowledge-base/{documentation_id}/source-file-url\n@desc Get Document Source File Url\n@required {documentation_id: str # The id of a document from the knowledge base. This is returned on document addition.}\n@returns(200) {signed_url: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/knowledge-base/{documentation_id}/chunk/{chunk_id}\n@desc Get Documentation Chunk From Knowledge Base\n@required {documentation_id: str # The id of a document from the knowledge base. This is returned on document addition., chunk_id: str # The id of a document RAG chunk from the knowledge base.}\n@optional {embedding_model: any # The embedding model used to retrieve the chunk.}\n@returns(200) {id: str, name: str, content: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/knowledge-base/{documentation_id}/chunks\n@desc Get All Rag Chunks For A Document\n@required {documentation_id: str # The id of a document from the knowledge base. This is returned on document addition., embedding_model: str # The embedding model used to retrieve the chunk.}\n@optional {page_size: int=30 # How many documents to return at maximum. Can not exceed 100, defaults to 30., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {chunks: [map], next_cursor: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/knowledge-base/{document_id}/move\n@desc Move Entity To Folder\n@required {document_id: str # The id of a document from the knowledge base. This is returned on document addition.}\n@optional {move_to: any # The folder to move the entities to. If not set, the entities will be moved to the root folder.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/knowledge-base/bulk-move\n@desc Bulk Move Entities To Folder\n@required {document_ids: [str] # The ids of documents or folders from the knowledge base.}\n@optional {move_to: any # The folder to move the entities to. If not set, the entities will be moved to the root folder.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/knowledge-base/bulk-delete\n@desc Bulk Delete Knowledge Base Documents\n@required {document_ids: [str] # The ids of documents or folders from the knowledge base.}\n@optional {force: bool=false # If set to true, documents or folders will be deleted regardless of whether they are used by any agents and will be removed from the dependent agents. For non-empty folders, this will also delete all child documents and folders.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}/topics\n@desc Get Agent Conversation Topics\n@required {agent_id: str # ID of the agent}\n@optional {page_size: any # Number of top-level topic groups to return., sort_by: str=conversations # Column to rank topics by. Use conversations for volume, sentiment with sort_direction=asc for the most negative topics, and frustration with sort_direction=desc for the most frustrated ones. Topics with no score are always ranked last., sort_direction: str=desc # Direction to sort topics., from_unix_secs: any # Start of the window to view topics for. When set with to_unix_secs, the completed daily topic-discovery runs in the range are aggregated together, so the window scopes the metrics as well as the topic set. Floored to the start of its UTC day because runs cover whole UTC days; aggregated_run_count reports how many runs were summed. Omit both bounds to get the single latest run., to_unix_secs: any # End of the window to view topics for., include_evaluation_criteria: bool=true # Include the per-criteria evaluation breakdown on each topic's metrics. Pass false to drop it: it dominates the payload and the weighted success_rate is returned either way., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {topics: [map], window_start_unix_secs: int, window_end_unix_secs: int, aggregated_run_count: int, has_more: bool, next_cursor: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/tools\n@desc Add Tool\n@required {tool_config: any # Configuration for the tool}\n@optional {response_mocks: any # Mock responses with optional parameter conditions. Evaluated top-to-bottom; first match wins.}\n@returns(200) {id: str, tool_config: any, access_info: map{is_creator: bool, creator_name: str, creator_email: str, role: str, anonymous_access_level_override: any, access_source: any}, usage_stats: map{total_calls: int, avg_latency_secs: num}, response_mocks: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/tools\n@desc Get Tools\n@optional {search: any # If specified, the endpoint returns only tools whose names start with this string., page_size: any # How many documents to return at maximum. Can not exceed 100, defaults to 30., show_only_owned_documents: bool=false # If set to true, the endpoint will return only tools owned by you (and not shared from somebody else). Deprecated: use created_by_user_id instead., created_by_user_id: any # Filter tools by creator user ID. When set, only tools created by this user are returned. Takes precedence over show_only_owned_documents. Use '@me' to refer to the authenticated user., types: any # If present, the endpoint will return only tools of the given types., sort_direction: str=desc # The direction to sort the results, sort_by: any # The field to sort the results by, used_by_agent_id: any # Filter to tools referenced by this agent's main branch: tools attached to the agent, tools on authored workflow nodes, and tools referenced by procedures., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {tools: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/tools/{tool_id}\n@desc Get Tool\n@required {tool_id: str # ID of the requested tool.}\n@optional {environment: str=production # Environment whose values are used when the MCP server URL, headers, or auth connection reference environment variables. Mirrors the environment a conversation would run in; defaults to production.}\n@returns(200) {id: str, tool_config: any, access_info: map{is_creator: bool, creator_name: str, creator_email: str, role: str, anonymous_access_level_override: any, access_source: any}, usage_stats: map{total_calls: int, avg_latency_secs: num}, response_mocks: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/tools/{tool_id}\n@desc Update Tool\n@required {tool_id: str # ID of the requested tool., tool_config: any # Configuration for the tool}\n@optional {response_mocks: any # Mock responses with optional parameter conditions. Evaluated top-to-bottom; first match wins.}\n@returns(200) {id: str, tool_config: any, access_info: map{is_creator: bool, creator_name: str, creator_email: str, role: str, anonymous_access_level_override: any, access_source: any}, usage_stats: map{total_calls: int, avg_latency_secs: num}, response_mocks: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/tools/{tool_id}\n@desc Delete Tool\n@required {tool_id: str # ID of the requested tool.}\n@optional {force: bool=false # If set to true, the tool will be deleted regardless of whether it is used by any agents and it will be removed from the dependent agents and branches.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/tools/{tool_id}/dependent-agents\n@desc Get Dependent Agents List\n@required {tool_id: str # ID of the requested tool.}\n@optional {cursor: any # Used for fetching next page. Cursor is returned in the response., page_size: int=30 # How many documents to return at maximum. Can not exceed 100, defaults to 30.}\n@returns(200) {agents: [any], branches: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/tools/{tool_id}/executions\n@desc Get Tool Executions\n@required {tool_id: str # ID of the requested tool.}\n@optional {cursor: any # Used for fetching next page. Cursor is returned in the response., page_size: int=30 # How many documents to return at maximum. Can not exceed 100, defaults to 30., is_error: any # Filter by error status. If not provided, returns all executions., agent_id: any # Filter by agent ID., branch_id: any # Filter by agent branch ID., start_time: any # Filter executions from this Unix timestamp (inclusive)., end_time: any # Filter executions until this Unix timestamp (inclusive).}\n@returns(200) {executions: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/analysis-items\n@desc Create Analysis Item\n@returns(200) {id: str, definition: any, access_info: map{is_creator: bool, creator_name: str, creator_email: str, role: str, anonymous_access_level_override: any, access_source: any}, created_at_unix_secs: int, updated_at_unix_secs: int, current_version_id: str, legacy_source_id: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/analysis-items\n@desc List Analysis Items\n@optional {search: any # If specified, only analysis items whose names start with this string are returned, ordered by relevance rather than sort_direction., page_size: any=30 # How many documents to return at maximum. Can not exceed 100, defaults to 30., kind: any # If specified, only analysis items of this kind are returned., analysis_item_ids: any # If specified, only analysis items with these IDs are returned., created_by_user_id: any # Filter by creator user ID. Use '@me' to refer to the authenticated user., sort_direction: str=desc # The direction to sort the results, cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {analysis_items: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/analysis-items/{analysis_item_id}/attachments\n@desc Update Analysis Item Attachments\n@required {analysis_item_id: str # ID of the requested analysis item., source: str(user/system)}\n@optional {attach: [map{agent_id!: str, branch_id!: str}], detach: [map{agent_id!: str, branch_id!: str}]}\n@returns(200) {results: [any]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/analysis-items/{analysis_item_id}\n@desc Get Analysis Item\n@required {analysis_item_id: str # ID of the requested analysis item.}\n@returns(200) {id: str, definition: any, access_info: map{is_creator: bool, creator_name: str, creator_email: str, role: str, anonymous_access_level_override: any, access_source: any}, created_at_unix_secs: int, updated_at_unix_secs: int, current_version_id: str, legacy_source_id: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/analysis-items/{analysis_item_id}\n@desc Update Analysis Item\n@required {analysis_item_id: str # ID of the requested analysis item.}\n@returns(200) {id: str, definition: any, access_info: map{is_creator: bool, creator_name: str, creator_email: str, role: str, anonymous_access_level_override: any, access_source: any}, created_at_unix_secs: int, updated_at_unix_secs: int, current_version_id: str, legacy_source_id: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/analysis-items/{analysis_item_id}\n@desc Delete Analysis Item\n@required {analysis_item_id: str # ID of the requested analysis item.}\n@optional {force: bool=false # If set to true, the analysis item will be deleted regardless of whether it is used by any agents and it will be removed from the dependent agents and branches.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/analysis-items/{analysis_item_id}/versions\n@desc List Analysis Item Versions\n@required {analysis_item_id: str # ID of the requested analysis item.}\n@optional {page_size: int=30 # How many documents to return at maximum. Can not exceed 100, defaults to 30., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {versions: [map], current_version_id: str, next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/analysis-items/{analysis_item_id}/copy\n@desc Copy Analysis Item\n@required {analysis_item_id: str # ID of the requested analysis item.}\n@returns(200) {id: str, definition: any, access_info: map{is_creator: bool, creator_name: str, creator_email: str, role: str, anonymous_access_level_override: any, access_source: any}, created_at_unix_secs: int, updated_at_unix_secs: int, current_version_id: str, legacy_source_id: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/analysis-items/{analysis_item_id}/dependent-agents\n@desc Get Analysis Item Dependent Agents\n@required {analysis_item_id: str # ID of the requested analysis item.}\n@optional {page_size: int=30 # How many documents to return at maximum. Can not exceed 100, defaults to 30., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {agents: [any], branches: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/settings\n@desc Get Convai Settings\n@returns(200) {conversation_initiation_client_data_webhook: any, webhooks: map{post_call_webhook_id: any, events: [str], transcript_format: str, exclude_transcript: bool, send_audio: any}, can_use_mcp_servers: bool, rag_retention_period_days: int, conversation_embedding_retention_days: any, default_livekit_stack: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/settings\n@desc Update Convai Settings\n@optional {conversation_initiation_client_data_webhook: any, webhooks: map{post_call_webhook_id: any, events: [str], transcript_format: str, exclude_transcript: bool, send_audio: any}, can_use_mcp_servers: bool=false # Whether the workspace can use MCP servers, rag_retention_period_days: int=10, conversation_embedding_retention_days: any # Days to retain conversation embeddings. None means use the system default (30 days)., default_livekit_stack: str(standard/static)=standard}\n@returns(200) {conversation_initiation_client_data_webhook: any, webhooks: map{post_call_webhook_id: any, events: [str], transcript_format: str, exclude_transcript: bool, send_audio: any}, can_use_mcp_servers: bool, rag_retention_period_days: int, conversation_embedding_retention_days: any, default_livekit_stack: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/settings/dashboard\n@desc Get Convai Dashboard Settings\n@returns(200) {charts: [any]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/settings/dashboard\n@desc Update Convai Dashboard Settings\n@optional {charts: [any]}\n@returns(200) {charts: [any]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/secrets\n@desc Create Convai Workspace Secret\n@required {type: str, name: str, value: str}\n@returns(200) {type: str, secret_id: str, name: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/secrets\n@desc Get Convai Workspace Secrets\n@optional {page_size: any # How many documents to return at maximum. Can not exceed 100. If not provided, returns all secrets., dependency_limit: any # Maximum number of dependent resources (tools, agents, phone numbers) to return per secret. Can not exceed 100., search: any # If specified, returns only secrets whose names start with this string., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {secrets: [map], next_cursor: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/secrets/{secret_id}\n@desc Get Convai Workspace Secret\n@required {secret_id: str}\n@returns(200) {type: str, secret_id: str, name: str, used_by: map{tools: [any], tools_has_more: bool, agents: [any], agents_has_more: bool, phone_numbers: [map], phone_numbers_has_more: bool, mcp_servers: [any], others: [str]}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/secrets/{secret_id}\n@desc Delete Convai Workspace Secret\n@required {secret_id: str}\n@returns(204) Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/secrets/{secret_id}\n@desc Update Convai Workspace Secret\n@required {secret_id: str, type: str, name: str, value: str}\n@returns(200) {type: str, secret_id: str, name: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/secrets/{secret_id}/dependencies/{resource_type}\n@desc Get Secret Dependencies By Type\n@required {secret_id: str, resource_type: str}\n@optional {page_size: int=20 # How many dependency items to return per page., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {dependencies: any, next_cursor: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/batch-calling/submit\n@desc Submit A Batch Call Request.\n@required {call_name: str, agent_id: str, recipients: [map{id: any, phone_number: any, whatsapp_user_id: any, conversation_initiation_client_data: any}]}\n@optional {scheduled_time_unix: any, agent_phone_number_id: any, whatsapp_params: any, timezone: any, branch_id: any, environment: any, telephony_call_config: map{ringing_timeout_secs: int, twilio_call_recording_enabled: bool, twilio_machine_detection: any}, target_concurrency_limit: any # Maximum number of simultaneous calls for this batch. When set, dispatch is governed by this limit rather than workspace/agent capacity percentages.}\n@returns(200) {id: str, phone_number_id: any, phone_provider: any, whatsapp_params: any, name: str, agent_id: str, branch_id: any, environment: any, created_at_unix: int, scheduled_time_unix: int, timezone: any, total_calls_dispatched: int, total_calls_scheduled: int, total_calls_finished: int, last_updated_at_unix: int, status: str, retry_count: int, telephony_call_config: map{ringing_timeout_secs: int, twilio_call_recording_enabled: bool, twilio_machine_detection: any}, target_concurrency_limit: any, agent_name: str, branch_name: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/batch-calling/workspace\n@desc Get All Batch Calls For A Workspace.\n@optional {limit: int=100, last_doc: any, agent_id: any # Filter batch calls to a single agent.}\n@returns(200) {batch_calls: [map], next_doc: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/batch-calling/{batch_id}\n@desc Get A Batch Call By Id.\n@required {batch_id: str}\n@returns(200) {id: str, phone_number_id: any, phone_provider: any, whatsapp_params: any, name: str, agent_id: str, branch_id: any, environment: any, created_at_unix: int, scheduled_time_unix: int, timezone: any, total_calls_dispatched: int, total_calls_scheduled: int, total_calls_finished: int, last_updated_at_unix: int, status: str, retry_count: int, telephony_call_config: map{ringing_timeout_secs: int, twilio_call_recording_enabled: bool, twilio_machine_detection: any}, target_concurrency_limit: any, agent_name: str, branch_name: any, recipients: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/batch-calling/{batch_id}\n@desc Delete A Batch Call.\n@required {batch_id: str}\n@returns(204) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/batch-calling/{batch_id}/cancel\n@desc Cancel A Batch Call.\n@required {batch_id: str}\n@returns(200) {id: str, phone_number_id: any, phone_provider: any, whatsapp_params: any, name: str, agent_id: str, branch_id: any, environment: any, created_at_unix: int, scheduled_time_unix: int, timezone: any, total_calls_dispatched: int, total_calls_scheduled: int, total_calls_finished: int, last_updated_at_unix: int, status: str, retry_count: int, telephony_call_config: map{ringing_timeout_secs: int, twilio_call_recording_enabled: bool, twilio_machine_detection: any}, target_concurrency_limit: any, agent_name: str, branch_name: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/batch-calling/{batch_id}/retry\n@desc Retry A Batch Call.\n@required {batch_id: str}\n@returns(200) {id: str, phone_number_id: any, phone_provider: any, whatsapp_params: any, name: str, agent_id: str, branch_id: any, environment: any, created_at_unix: int, scheduled_time_unix: int, timezone: any, total_calls_dispatched: int, total_calls_scheduled: int, total_calls_finished: int, last_updated_at_unix: int, status: str, retry_count: int, telephony_call_config: map{ringing_timeout_secs: int, twilio_call_recording_enabled: bool, twilio_machine_detection: any}, target_concurrency_limit: any, agent_name: str, branch_name: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/batch-calling/{batch_id}/export\n@desc Export Batch Call Results\n@required {batch_id: str}\n@optional {limit: any # Only export the first N recipients; used to preview the columns. Omit to export every recipient.}\n@returns(200) Batch call results CSV.\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/sip-trunk/outbound-call\n@desc Handle An Outbound Call Via Sip Trunk\n@required {agent_id: str, agent_phone_number_id: str, to_number: str}\n@optional {conversation_initiation_client_data: any, telephony_call_config: map{ringing_timeout_secs: int, twilio_call_recording_enabled: bool, twilio_machine_detection: any}}\n@returns(200) {success: bool, message: str, conversation_id: any, sip_call_id: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/mcp-servers\n@desc Create Mcp Server\n@required {config: map{approval_policy: str, tool_approval_hashes: [map], transport: str, url!: any, secret_token: any, request_headers: map, request_meta: map, auth_connection: any, name!: str, description: str, force_pre_tool_speech: bool, pre_tool_speech: str, disable_interruptions: bool, interruption_mode: str, tool_call_sound: any, tool_call_sound_behavior: str, execution_mode: str, response_timeout_secs: int, tool_config_overrides: [map], disable_compression: bool}}\n@returns(200) {id: str, config: map{approval_policy: str, tool_approval_hashes: [map], transport: str, url: any, secret_token: any, request_headers: map, request_meta: map, auth_connection: any, name: str, description: str, force_pre_tool_speech: bool, pre_tool_speech: str, disable_interruptions: bool, interruption_mode: str, tool_call_sound: any, tool_call_sound_behavior: str, execution_mode: str, response_timeout_secs: int, tool_config_overrides: [map], disable_compression: bool}, access_info: any, dependent_agents: [any], metadata: map{created_at: int, owner_user_id: any}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/mcp-servers\n@desc List Mcp Servers\n@returns(200) {mcp_servers: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/mcp-servers/{mcp_server_id}\n@desc Get Mcp Server\n@required {mcp_server_id: str # ID of the MCP Server.}\n@returns(200) {id: str, config: map{approval_policy: str, tool_approval_hashes: [map], transport: str, url: any, secret_token: any, request_headers: map, request_meta: map, auth_connection: any, name: str, description: str, force_pre_tool_speech: bool, pre_tool_speech: str, disable_interruptions: bool, interruption_mode: str, tool_call_sound: any, tool_call_sound_behavior: str, execution_mode: str, response_timeout_secs: int, tool_config_overrides: [map], disable_compression: bool}, access_info: any, dependent_agents: [any], metadata: map{created_at: int, owner_user_id: any}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/mcp-servers/{mcp_server_id}\n@desc Delete Mcp Server\n@required {mcp_server_id: str # ID of the MCP Server.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/mcp-servers/{mcp_server_id}\n@desc Update Mcp Server Configuration\n@required {mcp_server_id: str # ID of the MCP Server.}\n@optional {approval_policy: any # The approval mode to set for the MCP server, force_pre_tool_speech: any # DEPRECATED: use `pre_tool_speech` instead. If set, overrides the server's force_pre_tool_speech setting for this tool., pre_tool_speech: any # If set, overrides the server's pre_tool_speech setting for this tool., disable_interruptions: any # DEPRECATED: use `interruption_mode` instead. If set, overrides the server's disable_interruptions setting for this tool., interruption_mode: any # If set, overrides the server's interruption_mode setting for this tool., tool_call_sound: any # Predefined tool call sound type to play during tool execution for all tools from this MCP server, tool_call_sound_behavior: any # Determines when the tool call sound should play for all tools from this MCP server, execution_mode: any # If set, overrides the server's execution_mode setting for this tool, response_timeout_secs: any # The maximum time in seconds to wait for each MCP tool call to complete., request_headers: any # The headers to include in requests to the MCP server, request_meta: any # Entries sent in the MCP `_meta` field of tools/call requests. Values may be JSON scalars, or references to a workspace secret, dynamic variable, or environment variable resolved per call., disable_compression: any # Whether to disable HTTP compression for this MCP server, secret_token: any # Optional secret token for authentication with this MCP server, auth_connection: any # Optional auth connection to use for authentication with this MCP server}\n@returns(200) {id: str, config: map{approval_policy: str, tool_approval_hashes: [map], transport: str, url: any, secret_token: any, request_headers: map, request_meta: map, auth_connection: any, name: str, description: str, force_pre_tool_speech: bool, pre_tool_speech: str, disable_interruptions: bool, interruption_mode: str, tool_call_sound: any, tool_call_sound_behavior: str, execution_mode: str, response_timeout_secs: int, tool_config_overrides: [map], disable_compression: bool}, access_info: any, dependent_agents: [any], metadata: map{created_at: int, owner_user_id: any}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/mcp-servers/{mcp_server_id}/tools\n@desc List Mcp Server Tools\n@required {mcp_server_id: str # ID of the MCP Server.}\n@optional {environment: str=production # Environment whose values are used when the MCP server URL, headers, or auth connection reference environment variables. Mirrors the environment a conversation would run in; defaults to production.}\n@returns(200) {success: bool, tools: [map], tool_approval_statuses: [map], error_message: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/mcp-servers/{mcp_server_id}/approval-policy\n@desc Update Mcp Server Approval Policy\n@required {mcp_server_id: str # ID of the MCP Server., approval_policy: str(auto_approve_all/require_approval_all/require_approval_per_tool)=require_approval_all # Defines the MCP server-level approval policy for tool execution.}\n@returns(200) {id: str, config: map{approval_policy: str, tool_approval_hashes: [map], transport: str, url: any, secret_token: any, request_headers: map, request_meta: map, auth_connection: any, name: str, description: str, force_pre_tool_speech: bool, pre_tool_speech: str, disable_interruptions: bool, interruption_mode: str, tool_call_sound: any, tool_call_sound_behavior: str, execution_mode: str, response_timeout_secs: int, tool_config_overrides: [map], disable_compression: bool}, access_info: any, dependent_agents: [any], metadata: map{created_at: int, owner_user_id: any}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/mcp-servers/{mcp_server_id}/tool-approvals\n@desc Create Mcp Server Tool Approval\n@required {mcp_server_id: str # ID of the MCP Server., tool_name: str # The name of the MCP tool, tool_description: str # The description of the MCP tool}\n@optional {input_schema: map # The input schema of the MCP tool (the schema defined on the MCP server before ElevenLabs does any extra processing), approval_policy: str(auto_approved/requires_approval)=requires_approval # Defines the tool-level approval policy.}\n@returns(200) {id: str, config: map{approval_policy: str, tool_approval_hashes: [map], transport: str, url: any, secret_token: any, request_headers: map, request_meta: map, auth_connection: any, name: str, description: str, force_pre_tool_speech: bool, pre_tool_speech: str, disable_interruptions: bool, interruption_mode: str, tool_call_sound: any, tool_call_sound_behavior: str, execution_mode: str, response_timeout_secs: int, tool_config_overrides: [map], disable_compression: bool}, access_info: any, dependent_agents: [any], metadata: map{created_at: int, owner_user_id: any}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/mcp-servers/{mcp_server_id}/tool-approvals/{tool_name}\n@desc Delete Mcp Server Tool Approval\n@required {mcp_server_id: str # ID of the MCP Server., tool_name: str # Name of the MCP tool to remove approval for.}\n@returns(200) {id: str, config: map{approval_policy: str, tool_approval_hashes: [map], transport: str, url: any, secret_token: any, request_headers: map, request_meta: map, auth_connection: any, name: str, description: str, force_pre_tool_speech: bool, pre_tool_speech: str, disable_interruptions: bool, interruption_mode: str, tool_call_sound: any, tool_call_sound_behavior: str, execution_mode: str, response_timeout_secs: int, tool_config_overrides: [map], disable_compression: bool}, access_info: any, dependent_agents: [any], metadata: map{created_at: int, owner_user_id: any}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/mcp-servers/{mcp_server_id}/tool-configs\n@desc Create Mcp Tool Configuration Override\n@required {mcp_server_id: str # ID of the MCP Server., tool_name: str # The name of the MCP tool}\n@optional {environment: str=production # Environment whose values are used when the MCP server URL, headers, or auth connection reference environment variables. Mirrors the environment a conversation would run in; defaults to production., force_pre_tool_speech: any # DEPRECATED: use `pre_tool_speech` instead. If set, overrides the server's force_pre_tool_speech setting for this tool., pre_tool_speech: any # If set, overrides the server's pre_tool_speech setting for this tool., disable_interruptions: any # DEPRECATED: use `interruption_mode` instead. If set, overrides the server's disable_interruptions setting for this tool., interruption_mode: any # If set, overrides the server's interruption_mode setting for this tool., tool_call_sound: any # Overrides the server's tool_call_sound setting for this tool. A sound name plays that sound; 'off' overrides to no sound (silence); null means do not override (inherit the server default)., tool_call_sound_behavior: any # If set, overrides the server's tool_call_sound_behavior setting for this tool, execution_mode: any # If set, overrides the server's execution_mode setting for this tool, response_timeout_secs: any # If set, overrides the server's response timeout for this MCP tool., assignments: any # Dynamic variable assignments for this MCP tool, input_overrides: any # Mapping of json path to input override configuration, response_mocks: any # Mock responses with optional parameter conditions. Evaluated top-to-bottom; first match wins.}\n@returns(200) {id: str, config: map{approval_policy: str, tool_approval_hashes: [map], transport: str, url: any, secret_token: any, request_headers: map, request_meta: map, auth_connection: any, name: str, description: str, force_pre_tool_speech: bool, pre_tool_speech: str, disable_interruptions: bool, interruption_mode: str, tool_call_sound: any, tool_call_sound_behavior: str, execution_mode: str, response_timeout_secs: int, tool_config_overrides: [map], disable_compression: bool}, access_info: any, dependent_agents: [any], metadata: map{created_at: int, owner_user_id: any}} # Successful Response\n@errors {409: Tool config override already exists, 422: Validation Error}\n\n@endpoint GET /v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}\n@desc Get Mcp Tool Configuration Override\n@required {mcp_server_id: str # ID of the MCP Server., tool_name: str # Name of the MCP tool to retrieve config overrides for.}\n@returns(200) {tool_name: str, force_pre_tool_speech: any, pre_tool_speech: any, disable_interruptions: any, interruption_mode: any, tool_call_sound: any, tool_call_sound_behavior: any, execution_mode: any, response_timeout_secs: any, assignments: [map], input_overrides: any, response_mocks: any} # Successful Response\n@errors {404: Tool config override not found, 422: Validation Error}\n\n@endpoint PATCH /v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}\n@desc Update Mcp Tool Configuration Override\n@required {mcp_server_id: str # ID of the MCP Server., tool_name: str # Name of the MCP tool to update config overrides for.}\n@optional {environment: str=production # Environment whose values are used when the MCP server URL, headers, or auth connection reference environment variables. Mirrors the environment a conversation would run in; defaults to production., force_pre_tool_speech: any # DEPRECATED: use `pre_tool_speech` instead. If set, overrides the server's force_pre_tool_speech setting for this tool., pre_tool_speech: any # If set, overrides the server's pre_tool_speech setting for this tool., disable_interruptions: any # DEPRECATED: use `interruption_mode` instead. If set, overrides the server's disable_interruptions setting for this tool., interruption_mode: any # If set, overrides the server's interruption_mode setting for this tool., tool_call_sound: any # Overrides the server's tool_call_sound setting for this tool. A sound name plays that sound; 'off' overrides to no sound (silence); null means do not override (inherit the server default)., tool_call_sound_behavior: any # If set, overrides the server's tool_call_sound_behavior setting for this tool, execution_mode: any # If set, overrides the server's execution_mode setting for this tool, response_timeout_secs: any # If set, overrides the server's response timeout for this MCP tool., assignments: any # Dynamic variable assignments for this MCP tool, input_overrides: any # Mapping of json path to input override configuration, response_mocks: any # Mock responses with optional parameter conditions. Evaluated top-to-bottom; first match wins.}\n@returns(200) {id: str, config: map{approval_policy: str, tool_approval_hashes: [map], transport: str, url: any, secret_token: any, request_headers: map, request_meta: map, auth_connection: any, name: str, description: str, force_pre_tool_speech: bool, pre_tool_speech: str, disable_interruptions: bool, interruption_mode: str, tool_call_sound: any, tool_call_sound_behavior: str, execution_mode: str, response_timeout_secs: int, tool_config_overrides: [map], disable_compression: bool}, access_info: any, dependent_agents: [any], metadata: map{created_at: int, owner_user_id: any}} # Successful Response\n@errors {404: Tool config override not found, 422: Validation Error}\n\n@endpoint DELETE /v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}\n@desc Delete Mcp Tool Configuration Override\n@required {mcp_server_id: str # ID of the MCP Server., tool_name: str # Name of the MCP tool to remove config overrides for.}\n@returns(200) {id: str, config: map{approval_policy: str, tool_approval_hashes: [map], transport: str, url: any, secret_token: any, request_headers: map, request_meta: map, auth_connection: any, name: str, description: str, force_pre_tool_speech: bool, pre_tool_speech: str, disable_interruptions: bool, interruption_mode: str, tool_call_sound: any, tool_call_sound_behavior: str, execution_mode: str, response_timeout_secs: int, tool_config_overrides: [map], disable_compression: bool}, access_info: any, dependent_agents: [any], metadata: map{created_at: int, owner_user_id: any}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/whatsapp-accounts/{phone_number_id}\n@desc Get Whatsapp Account\n@required {phone_number_id: str}\n@returns(200) {business_account_id: str, phone_number_id: str, business_account_name: str, phone_number_name: str, phone_number: str, account_type: str, assigned_agent_id: any, enable_messaging: bool, enable_audio_message_response: bool, enable_typing_indicator: bool, assigned_agent_name: any, is_token_expired: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/whatsapp-accounts/{phone_number_id}\n@desc Update Whatsapp Account\n@required {phone_number_id: str}\n@optional {assigned_agent_id: any, enable_messaging: any, enable_audio_message_response: any, enable_typing_indicator: any}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/whatsapp-accounts/{phone_number_id}\n@desc Delete Whatsapp Account\n@required {phone_number_id: str}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/whatsapp-accounts\n@desc List Whatsapp Accounts\n@optional {agent_id: any # Filter by assigned agent ID}\n@returns(200) {items: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/branches\n@desc Create A New Branch\n@required {agent_id: str # The id of an agent. This is returned on agent creation., parent_version_id: str # ID of the version to branch from, name: str # Name of the branch. It is unique within the agent., description: str # Description for the branch}\n@optional {conversation_config: any # Changes to apply to conversation config, platform_settings: any # Changes to apply to platform settings, workflow: any # Updated workflow definition, include_draft: bool=false # When true, the new branch uses the caller's draft procedure set instead of the branch tip. Requires parent_version_id to be the branch tip.}\n@returns(200) {created_branch_id: str, created_version_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}/branches\n@desc List Agent Branches\n@required {agent_id: str # The id of an agent. This is returned on agent creation.}\n@optional {include_archived: bool=false # Whether archived branches should be included, limit: int=100 # How many results at most should be returned, include_commit_status: bool=false # Whether to compute how far each branch has diverged from main (commits_ahead/commits_behind). This walks the version DAG of every branch, so it is slow on agents with long histories and is off by default, leaving those fields null.}\n@returns(200) {meta: map{total: any, page: any, page_size: any}, results: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}/branches/{branch_id}\n@desc Get Agent Branch\n@required {agent_id: str # The id of an agent. This is returned on agent creation., branch_id: str # Unique identifier for the branch.}\n@returns(200) {id: str, name: str, agent_id: str, description: str, created_at: int, last_committed_at: int, is_archived: bool, protection_status: str, auto_rebase: bool, sync_status: any, access_info: any, current_live_percentage: num, parent_branch: any, most_recent_versions: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/agents/{agent_id}/branches/{branch_id}\n@desc Update Agent Branch\n@required {agent_id: str # The id of an agent. This is returned on agent creation., branch_id: str # Unique identifier for the branch.}\n@optional {name: any # New name for the branch. Must be unique within the agent., description: any # New description for the branch. Pass an empty string to clear it., is_archived: any # Whether the branch should be archived, protection_status: any # The protection level for the branch, auto_rebase: any # When true, rebase this branch onto main automatically after each new main version. Cannot be enabled on the main branch.}\n@returns(200) {id: str, name: str, agent_id: str, description: str, created_at: int, last_committed_at: int, is_archived: bool, protection_status: str, auto_rebase: bool, sync_status: any, access_info: any, current_live_percentage: num, parent_branch: any, most_recent_versions: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}/versions/{version_id}\n@desc Get Agent Version Metadata\n@required {agent_id: str # The id of an agent. This is returned on agent creation., version_id: str # Unique identifier for the version.}\n@returns(200) {id: str, agent_id: str, branch_id: str, version_description: str, seq_no_in_branch: int, time_committed_secs: int, parents: map{in_branch_parent_id: any, out_of_branch_parent_id: any, merged_into_branch_id: any, merged_from_branch_id: any, merged_from_version_id: any, rebased_from_version_id: any}, access_info: any, merged_authors: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}/branches/{source_branch_id}/merge-preview\n@desc Preview Merged Configuration\n@required {agent_id: str # The id of an agent. This is returned on agent creation., source_branch_id: str # Unique identifier for the source branch to merge from., target_branch_id: str # The ID of the target branch to merge into.}\n@optional {force: bool=false # When true, source branch changes always win conflicts regardless of timestamps, include_procedure_generated_workflow_elements: bool=true # Whether to include the workflow nodes and edges generated from structured procedures. When false, the workflow contains only authored elements.}\n@returns(200) {agent_id: str, name: str, conversation_config: map{asr: map{quality: str, provider: str, user_input_audio_format: str, keywords: [str]}, turn: map{turn_timeout: num, initial_wait_time: any, silence_end_call_timeout: num, mode: str, turn_eagerness: str, spelling_patience: str, speculative_turn: bool, retranscribe_on_turn_timeout: bool, turn_model: str, interruption_ignore_terms: [str], interruption_ignore_term_languages: [str], merge_with_default_ignore_terms: bool, transcribe_on_disabled_interruptions: bool, soft_timeout_config: map{timeout_seconds: num, message: str, additional_soft_timeout_messages: [str], use_llm_generated_message: bool, randomize_fillers: bool, max_soft_timeouts_per_generation: int, llm_generated_message_prompt_override: any, disable_until_first_user_message: bool}, noisy_environment_detection: bool, noisy_environment_message: str}, tts: map{model_id: str, voice_id: str, supported_voices: [map], expressive_mode: bool, suggested_audio_tags: [map], agent_output_audio_format: str, optimize_streaming_latency: int, stability: num, speed: num, similarity_boost: num, clone_strength: num, text_normalisation_type: str, pronunciation_dictionary_locators: [map], enable_phoneme_tags: bool, audio_effects: any}, conversation: map{text_only: bool, max_duration_seconds: int, client_events: [str], file_input: map{enabled: bool, max_files_in_memory: int, max_files_per_conversation: int}, monitoring_enabled: bool, monitoring_events: [str], dtmf_input_settings: any, background_sound: map{source_type: any, source_id: any, volume: num, crossfade_loop: bool}, source_attribution: bool}, language_presets: map, vad: map{background_voice_detection: bool}, agent: map{first_message: str, language: str, hinglish_mode: bool, dynamic_variables: map{dynamic_variable_placeholders: map}, disable_first_message_interruptions: bool, max_conversation_duration_message: str, text_behavior_overrides: any, subagent_config: map{agents: [map], self_subagent: any}, prompt: map{prompt: str, llm: str, reasoning_effort: any, service_tier: str, thinking_budget: any, enable_reasoning_summary: bool, temperature: any, max_tokens: int, tool_ids: [str], tool_ids_strict: bool, built_in_tools: map, enable_parallel_tool_calls: bool, mcp_server_ids: [str], native_mcp_server_ids: [str], knowledge_base: [map], custom_llm: any, ignore_default_personality: any, rag: map, timezone: any, backup_llm_config: any, cascade_timeout_seconds: num, tools: [any]}}}, metadata: map{created_at_unix_secs: int, updated_at_unix_secs: int}, platform_settings: map{evaluation: map{criteria: [map]}, widget: map{variant: str, placement: str, expandable: str, avatar: any, feedback_mode: str, end_feedback: any, bg_color: str, text_color: str, btn_color: str, btn_text_color: str, border_color: str, focus_color: str, border_radius: any, btn_radius: any, action_text: any, start_call_text: any, end_call_text: any, expand_text: any, listening_text: any, speaking_text: any, shareable_page_text: any, shareable_page_show_terms: bool, terms_text: any, terms_html: any, terms_key: any, show_avatar_when_collapsed: any, disable_banner: bool, override_link: any, markdown_link_allowed_hosts: [map], markdown_link_include_www: bool, markdown_link_allow_http: bool, mic_muting_enabled: bool, transcript_enabled: bool, text_input_enabled: bool, conversation_mode_toggle_enabled: bool, default_expanded: bool, always_expanded: bool, dismissible: bool, show_agent_status: bool, show_conversation_id: bool, strip_audio_tags: bool, syntax_highlight_theme: any, text_contents: map{main_label: any, start_call: any, start_chat: any, new_call: any, end_call: any, mute_microphone: any, change_language: any, collapse: any, expand: any, copied: any, accept_terms: any, dismiss_terms: any, listening_status: any, speaking_status: any, connecting_status: any, chatting_status: any, queue_waiting_status: any, queue_waiting_status_short: any, input_label: any, input_placeholder: any, input_placeholder_text_only: any, input_placeholder_new_conversation: any, user_ended_conversation: any, agent_ended_conversation: any, conversation_id: any, error_occurred: any, queue_timed_out: any, copy_id: any, initiate_feedback: any, request_follow_up_feedback: any, thanks_for_feedback: any, thanks_for_feedback_details: any, follow_up_feedback_placeholder: any, submit: any, go_back: any, send_message: any, text_mode: any, voice_mode: any, switched_to_text_mode: any, switched_to_voice_mode: any, copy: any, download: any, wrap: any, agent_working: any, agent_done: any, agent_error: any, attach_file: any, remove_file: any, file_upload_error: any, file_type_unsupported: any, file_too_large: any, file_limit_reached: any, typing_indicator: any, rich_content_unavailable: any}, styles: map{base: any, base_hover: any, base_active: any, base_border: any, base_subtle: any, base_primary: any, base_error: any, accent: any, accent_hover: any, accent_active: any, accent_border: any, accent_subtle: any, accent_primary: any, overlay_padding: any, button_radius: any, input_radius: any, bubble_radius: any, sheet_radius: any, compact_sheet_radius: any, dropdown_sheet_radius: any}, show_resize_button: bool, end_confirmation_enabled: bool, mobile_fullscreen: bool, transcript_speech_sync_enabled: bool, language_selector: bool, supports_text_only: bool, custom_avatar_path: any, language_presets: map}, data_collection: map, data_collection_scopes: map, analysis_items: any, overrides: map{conversation_config_override: map{asr: map, turn: map, tts: map, conversation: map, agent: map}, custom_llm_extra_body: bool, enable_conversation_initiation_client_data_from_webhook: bool, enable_starting_workflow_node_id_from_client: bool, enable_procedure_ids_from_client: bool}, workspace_overrides: map{conversation_initiation_client_data_webhook: any, webhooks: map{post_call_webhook_id: any, events: [str], transcript_format: str, exclude_transcript: bool, send_audio: any}}, testing: map{attached_tests: [map]}, archived: bool, guardrails: map{version: str, focus: map{is_enabled: bool}, prompt_injection: map{is_enabled: bool}, content: map{execution_mode: str, config: map, trigger_action: any}, moderation: any, custom: map{config: map}}, summary_language: any, auto_translate_transcript_to_app_language: any, auth: map{enable_auth: bool, allowlist: [map], require_origin_header: bool, shareable_token: any}, call_limits: map{agent_concurrency_limit: int, daily_limit: int, bursting_enabled: bool}, queueing_config: map{enabled: bool, wait_timeout_seconds: int, hold_audio: any}, privacy: map{record_voice: bool, retention_days: int, delete_transcript_and_pii: bool, delete_audio: bool, apply_to_existing_conversations: bool, zero_retention_mode: bool, conversation_history_redaction: map{enabled: bool, entities: [str], excluded_data_collection_ids: [str]}}, trust_context: str, analysis_llm: str, topic_discovery: map, sentiment_analysis: map, alerting: any, safety: map{is_blocked_ivc: bool, is_blocked_non_ivc: bool, ignore_safety_evaluation: bool}}, phone_numbers: [any], whatsapp_accounts: [map], workflow: map{edges: map, nodes: map, prevent_subagent_loops: bool}, access_info: any, tags: [str], version_id: any, branch_id: any, main_branch_id: any, procedures: map, default_hold_audio_url: str, overridden_fields: [str], conflicts: [map], source_identical_to_target: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/branches/{source_branch_id}/merge\n@desc Merge A Branch Into A Target Branch\n@required {agent_id: str # The id of an agent. This is returned on agent creation., source_branch_id: str # Unique identifier for the source branch to merge from., target_branch_id: str # The ID of the target branch to merge into.}\n@optional {archive_source_branch: bool=true # Whether to archive the source branch after merging, force: bool=false # Force source branch changes onto the target, overriding timestamp-based conflict resolution}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}/branches/{branch_id}/rebase-preview\n@desc Preview Rebased Configuration\n@required {agent_id: str # The id of an agent. This is returned on agent creation., branch_id: str # Unique identifier for the source branch to merge from.}\n@optional {source_branch_id: any # The ID of the branch to pull changes from. Defaults to the agent's main branch., include_procedure_generated_workflow_elements: bool=true # Whether to include the workflow nodes and edges generated from structured procedures. When false, the workflow contains only authored elements.}\n@returns(200) {agent_id: str, name: str, conversation_config: map{asr: map{quality: str, provider: str, user_input_audio_format: str, keywords: [str]}, turn: map{turn_timeout: num, initial_wait_time: any, silence_end_call_timeout: num, mode: str, turn_eagerness: str, spelling_patience: str, speculative_turn: bool, retranscribe_on_turn_timeout: bool, turn_model: str, interruption_ignore_terms: [str], interruption_ignore_term_languages: [str], merge_with_default_ignore_terms: bool, transcribe_on_disabled_interruptions: bool, soft_timeout_config: map{timeout_seconds: num, message: str, additional_soft_timeout_messages: [str], use_llm_generated_message: bool, randomize_fillers: bool, max_soft_timeouts_per_generation: int, llm_generated_message_prompt_override: any, disable_until_first_user_message: bool}, noisy_environment_detection: bool, noisy_environment_message: str}, tts: map{model_id: str, voice_id: str, supported_voices: [map], expressive_mode: bool, suggested_audio_tags: [map], agent_output_audio_format: str, optimize_streaming_latency: int, stability: num, speed: num, similarity_boost: num, clone_strength: num, text_normalisation_type: str, pronunciation_dictionary_locators: [map], enable_phoneme_tags: bool, audio_effects: any}, conversation: map{text_only: bool, max_duration_seconds: int, client_events: [str], file_input: map{enabled: bool, max_files_in_memory: int, max_files_per_conversation: int}, monitoring_enabled: bool, monitoring_events: [str], dtmf_input_settings: any, background_sound: map{source_type: any, source_id: any, volume: num, crossfade_loop: bool}, source_attribution: bool}, language_presets: map, vad: map{background_voice_detection: bool}, agent: map{first_message: str, language: str, hinglish_mode: bool, dynamic_variables: map{dynamic_variable_placeholders: map}, disable_first_message_interruptions: bool, max_conversation_duration_message: str, text_behavior_overrides: any, subagent_config: map{agents: [map], self_subagent: any}, prompt: map{prompt: str, llm: str, reasoning_effort: any, service_tier: str, thinking_budget: any, enable_reasoning_summary: bool, temperature: any, max_tokens: int, tool_ids: [str], tool_ids_strict: bool, built_in_tools: map, enable_parallel_tool_calls: bool, mcp_server_ids: [str], native_mcp_server_ids: [str], knowledge_base: [map], custom_llm: any, ignore_default_personality: any, rag: map, timezone: any, backup_llm_config: any, cascade_timeout_seconds: num, tools: [any]}}}, metadata: map{created_at_unix_secs: int, updated_at_unix_secs: int}, platform_settings: map{evaluation: map{criteria: [map]}, widget: map{variant: str, placement: str, expandable: str, avatar: any, feedback_mode: str, end_feedback: any, bg_color: str, text_color: str, btn_color: str, btn_text_color: str, border_color: str, focus_color: str, border_radius: any, btn_radius: any, action_text: any, start_call_text: any, end_call_text: any, expand_text: any, listening_text: any, speaking_text: any, shareable_page_text: any, shareable_page_show_terms: bool, terms_text: any, terms_html: any, terms_key: any, show_avatar_when_collapsed: any, disable_banner: bool, override_link: any, markdown_link_allowed_hosts: [map], markdown_link_include_www: bool, markdown_link_allow_http: bool, mic_muting_enabled: bool, transcript_enabled: bool, text_input_enabled: bool, conversation_mode_toggle_enabled: bool, default_expanded: bool, always_expanded: bool, dismissible: bool, show_agent_status: bool, show_conversation_id: bool, strip_audio_tags: bool, syntax_highlight_theme: any, text_contents: map{main_label: any, start_call: any, start_chat: any, new_call: any, end_call: any, mute_microphone: any, change_language: any, collapse: any, expand: any, copied: any, accept_terms: any, dismiss_terms: any, listening_status: any, speaking_status: any, connecting_status: any, chatting_status: any, queue_waiting_status: any, queue_waiting_status_short: any, input_label: any, input_placeholder: any, input_placeholder_text_only: any, input_placeholder_new_conversation: any, user_ended_conversation: any, agent_ended_conversation: any, conversation_id: any, error_occurred: any, queue_timed_out: any, copy_id: any, initiate_feedback: any, request_follow_up_feedback: any, thanks_for_feedback: any, thanks_for_feedback_details: any, follow_up_feedback_placeholder: any, submit: any, go_back: any, send_message: any, text_mode: any, voice_mode: any, switched_to_text_mode: any, switched_to_voice_mode: any, copy: any, download: any, wrap: any, agent_working: any, agent_done: any, agent_error: any, attach_file: any, remove_file: any, file_upload_error: any, file_type_unsupported: any, file_too_large: any, file_limit_reached: any, typing_indicator: any, rich_content_unavailable: any}, styles: map{base: any, base_hover: any, base_active: any, base_border: any, base_subtle: any, base_primary: any, base_error: any, accent: any, accent_hover: any, accent_active: any, accent_border: any, accent_subtle: any, accent_primary: any, overlay_padding: any, button_radius: any, input_radius: any, bubble_radius: any, sheet_radius: any, compact_sheet_radius: any, dropdown_sheet_radius: any}, show_resize_button: bool, end_confirmation_enabled: bool, mobile_fullscreen: bool, transcript_speech_sync_enabled: bool, language_selector: bool, supports_text_only: bool, custom_avatar_path: any, language_presets: map}, data_collection: map, data_collection_scopes: map, analysis_items: any, overrides: map{conversation_config_override: map{asr: map, turn: map, tts: map, conversation: map, agent: map}, custom_llm_extra_body: bool, enable_conversation_initiation_client_data_from_webhook: bool, enable_starting_workflow_node_id_from_client: bool, enable_procedure_ids_from_client: bool}, workspace_overrides: map{conversation_initiation_client_data_webhook: any, webhooks: map{post_call_webhook_id: any, events: [str], transcript_format: str, exclude_transcript: bool, send_audio: any}}, testing: map{attached_tests: [map]}, archived: bool, guardrails: map{version: str, focus: map{is_enabled: bool}, prompt_injection: map{is_enabled: bool}, content: map{execution_mode: str, config: map, trigger_action: any}, moderation: any, custom: map{config: map}}, summary_language: any, auto_translate_transcript_to_app_language: any, auth: map{enable_auth: bool, allowlist: [map], require_origin_header: bool, shareable_token: any}, call_limits: map{agent_concurrency_limit: int, daily_limit: int, bursting_enabled: bool}, queueing_config: map{enabled: bool, wait_timeout_seconds: int, hold_audio: any}, privacy: map{record_voice: bool, retention_days: int, delete_transcript_and_pii: bool, delete_audio: bool, apply_to_existing_conversations: bool, zero_retention_mode: bool, conversation_history_redaction: map{enabled: bool, entities: [str], excluded_data_collection_ids: [str]}}, trust_context: str, analysis_llm: str, topic_discovery: map, sentiment_analysis: map, alerting: any, safety: map{is_blocked_ivc: bool, is_blocked_non_ivc: bool, ignore_safety_evaluation: bool}}, phone_numbers: [any], whatsapp_accounts: [map], workflow: map{edges: map, nodes: map, prevent_subagent_loops: bool}, access_info: any, tags: [str], version_id: any, branch_id: any, main_branch_id: any, procedures: map, default_hold_audio_url: str, overridden_fields: [str], conflicts: [map], source_identical_to_target: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/branches/{branch_id}/rebase\n@desc Rebase A Branch Onto Main\n@required {agent_id: str # The id of an agent. This is returned on agent creation., branch_id: str # Unique identifier for the source branch to merge from.}\n@optional {source_branch_id: any # The ID of the branch to pull changes from. Defaults to the agent's main branch.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/deployments\n@desc Create Or Update Deployments\n@required {agent_id: str # The id of an agent. This is returned on agent creation., deployment_request: map{requests!: [map]}}\n@returns(200) {traffic_percentage_branch_id_map: map} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}/deployments\n@desc List Agent Deployments\n@required {agent_id: str # The id of an agent. This is returned on agent creation.}\n@optional {page: int=1 # Page number, starting at 1, page_size: int=30 # How many results at most should be returned}\n@returns(200) {meta: map{total: any, page: any, page_size: any}, results: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/drafts\n@desc Create Agent Draft\n@required {agent_id: str # The id of an agent. This is returned on agent creation., branch_id: str # The ID of the agent branch to use, conversation_config: map # Conversation config for the draft, platform_settings: map # Platform settings for the draft, workflow: map{edges: map, nodes: map, prevent_subagent_loops: bool}, name: str # Name for the draft}\n@optional {tags: any # Tags to help classify and filter the agent}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/agents/{agent_id}/drafts\n@desc Delete Agent Draft\n@required {agent_id: str # The id of an agent. This is returned on agent creation., branch_id: str # The ID of the agent branch to use}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/merge-proposals\n@desc Create A Merge Proposal\n@required {agent_id: str # The id of an agent. This is returned on agent creation., source_branch_id: str # Branch whose changes should be merged., target_branch_id: str # Branch that should receive the changes., title: str # Short title for the merge_proposal.}\n@optional {description: str= # Optional longer description for reviewers., requested_reviewer_user_ids: any # User IDs to request a review from., triage_ticket_id: any # Issue of this agent that the merge_proposal resolves. Merging it resolves the issue if still open.}\n@returns(200) {created_merge_proposal_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}/merge-proposals\n@desc List Proposals\n@required {agent_id: str # The id of an agent. This is returned on agent creation.}\n@optional {status: any # Only return proposals with this status., source_branch_id: any # Only return proposals with this source branch., target_branch_id: any # Only return proposals with this target branch., search: any # Case-insensitive substring match over title and description., page_size: int=100 # How many results at most should be returned, cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {results: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}\n@desc Get A Merge Proposal\n@required {agent_id: str # The id of an agent. This is returned on agent creation., merge_proposal_id: str # Unique identifier for the merge_proposal.}\n@returns(200) {id: str, agent_id: str, source_branch_id: str, target_branch_id: str, source_tip_version_id_at_creation: str, title: str, description: str, requested_reviewer_user_ids: [str], reviews: [map], comments: [map], outcome: any, created_at: int, updated_at: int, author_user_id: any, access_info: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}\n@desc Update A Merge Proposal\n@required {agent_id: str # The id of an agent. This is returned on agent creation., merge_proposal_id: str # Unique identifier for the merge_proposal.}\n@optional {title: any # New title for the merge_proposal., description: any # New description for the merge_proposal., requested_reviewer_user_ids: any # Replacement list of user IDs to request a review from., close: bool=false # When true, close the merge_proposal without merging.}\n@returns(200) {id: str, agent_id: str, source_branch_id: str, target_branch_id: str, source_tip_version_id_at_creation: str, title: str, description: str, requested_reviewer_user_ids: [str], reviews: [map], comments: [map], outcome: any, created_at: int, updated_at: int, author_user_id: any, access_info: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/reviews\n@desc Review A Merge Proposal\n@required {agent_id: str # The id of an agent. This is returned on agent creation., merge_proposal_id: str # Unique identifier for the merge_proposal., state: str(approved/changes_requested)}\n@optional {comment: str= # Optional comment to leave with the review.}\n@returns(200) {id: str, agent_id: str, source_branch_id: str, target_branch_id: str, source_tip_version_id_at_creation: str, title: str, description: str, requested_reviewer_user_ids: [str], reviews: [map], comments: [map], outcome: any, created_at: int, updated_at: int, author_user_id: any, access_info: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/comments\n@desc Comment On A Merge Proposal\n@required {agent_id: str # The id of an agent. This is returned on agent creation., merge_proposal_id: str # Unique identifier for the merge_proposal., body: str # The comment text. Markdown is supported.}\n@returns(200) {id: str, agent_id: str, source_branch_id: str, target_branch_id: str, source_tip_version_id_at_creation: str, title: str, description: str, requested_reviewer_user_ids: [str], reviews: [map], comments: [map], outcome: any, created_at: int, updated_at: int, author_user_id: any, access_info: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/merge\n@desc Merge A Merge Proposal\n@required {agent_id: str # The id of an agent. This is returned on agent creation., merge_proposal_id: str # Unique identifier for the merge_proposal.}\n@optional {archive_source_branch: bool=true # Whether to archive the source branch after merging., force: bool=false # Force source branch changes onto the target, overriding timestamp-based conflict resolution.}\n@returns(200) {id: str, agent_id: str, source_branch_id: str, target_branch_id: str, source_tip_version_id_at_creation: str, title: str, description: str, requested_reviewer_user_ids: [str], reviews: [map], comments: [map], outcome: any, created_at: int, updated_at: int, author_user_id: any, access_info: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/outbound-campaigns/config\n@desc Get Outbound Campaign Configuration\n@returns(200) {version: int, config: map{policy: map{timezone: str, retry: map{retry_delay_seconds: int, max_short_retries: int, max_total_calls: int, max_callbacks: int, max_redirects: int, interval_placement: str, rotate_step_seconds: int, max_consecutive_failures_per_number: any}, calling_periods: [map], data_collection: map{callback_time: any, redirect_phone_number: any, stop: any, mappings: map}, followup_context: map{call_type: bool, previous_conversation_id: bool, previous_summary: bool, previous_transcript: bool}}, agent_policies: map, whatsapp_voice_policy: any}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PUT /v1/convai/outbound-campaigns/config\n@desc Replace Outbound Campaign Configuration\n@required {config: map{policy: map, agent_policies: map, whatsapp_voice_policy: any}}\n@optional {expected_version: any # The `version` of the configuration being replaced. Omit it only to create the first configuration.}\n@returns(200) {version: int, config: map{policy: map{timezone: str, retry: map{retry_delay_seconds: int, max_short_retries: int, max_total_calls: int, max_callbacks: int, max_redirects: int, interval_placement: str, rotate_step_seconds: int, max_consecutive_failures_per_number: any}, calling_periods: [map], data_collection: map{callback_time: any, redirect_phone_number: any, stop: any, mappings: map}, followup_context: map{call_type: bool, previous_conversation_id: bool, previous_summary: bool, previous_transcript: bool}}, agent_policies: map, whatsapp_voice_policy: any}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/outbound-campaigns/campaigns\n@desc List Outbound Campaigns\n@optional {page_size: int=100 # How many items to return at most., status: any # Only campaigns in one of these statuses., agent_id: any # Only campaigns run by this agent., channel: any # Only campaigns on this channel., mode: any # Only voice or only message campaigns., search: any # Only campaigns whose name contains this text., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {campaigns: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/outbound-campaigns/campaigns/pause-all\n@desc Pause All Outbound Campaigns\n@returns(200) {paused_campaign_ids: [str]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/outbound-campaigns/campaigns/stop-all\n@desc Stop All Outbound Campaigns\n@returns(200) {stopped_campaign_ids: [str], stopping_campaign_ids: [str]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/outbound-campaigns/campaigns/submit\n@desc Create An Outbound Campaign\n@required {call_name: str # The campaign's name., agent_id: str # The agent that places the calls., recipients: [map{phone_number: any, phone_numbers: any, whatsapp_user_id: any, id: any, conversation_initiation_client_data: any}] # Who to call. Each recipient becomes a lead of the campaign., channel_config: any}\n@optional {scheduled_time_unix: any # When to start calling; omit to start now. Calls still wait for the next calling window., timezone: any # IANA timezone to read the calling windows in, overriding the policy's., branch_id: any # The agent branch to call with., environment: any # The environment to resolve the agent's environment variables in., target_concurrency_limit: any # The most calls to place at once., idempotency_key: any # Makes the request safe to retry: a repeat with the same key returns the campaign it created., policy: any # Policy to snapshot onto the campaign. When set, it wins over the workspace default and any per-agent override; when omitted, the workspace configuration must exist and supplies the policy., variant: any # `simple` runs one attempt per recipient with always-on calling windows and nothing collected, and cannot be combined with `policy`. `advanced` uses `policy` or the workspace configuration, and is the default for phone campaigns.}\n@returns(200) {campaign: map{campaign_id: str, call_name: str, agent_id: str, channel_config: any, status: str, policy: map{timezone: str, retry: map{retry_delay_seconds: int, max_short_retries: int, max_total_calls: int, max_callbacks: int, max_redirects: int, interval_placement: str, rotate_step_seconds: int, max_consecutive_failures_per_number: any}, calling_periods: [map], data_collection: map{callback_time: any, redirect_phone_number: any, stop: any, mappings: map}, followup_context: map{call_type: bool, previous_conversation_id: bool, previous_summary: bool, previous_transcript: bool}}, variant: str, source: any, created_at_unix: int, scheduled_time_unix: any, updated_at_unix: int, branch_id: any, environment: any, target_concurrency_limit: any, channel: str, mode: str, counts: map{leads: int, terminal_leads: int, open_attention: int, delivery: any}, agent_name: str}, created: bool, within_calling_window: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/outbound-campaigns/campaigns/{campaign_id}\n@desc Get An Outbound Campaign\n@required {campaign_id: str}\n@returns(200) {campaign_id: str, call_name: str, agent_id: str, channel_config: any, status: str, policy: map{timezone: str, retry: map{retry_delay_seconds: int, max_short_retries: int, max_total_calls: int, max_callbacks: int, max_redirects: int, interval_placement: str, rotate_step_seconds: int, max_consecutive_failures_per_number: any}, calling_periods: [map], data_collection: map{callback_time: any, redirect_phone_number: any, stop: any, mappings: map}, followup_context: map{call_type: bool, previous_conversation_id: bool, previous_summary: bool, previous_transcript: bool}}, variant: str, source: any, created_at_unix: int, scheduled_time_unix: any, updated_at_unix: int, branch_id: any, environment: any, target_concurrency_limit: any, channel: str, mode: str, counts: map{leads: int, terminal_leads: int, open_attention: int, delivery: any}, agent_name: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/outbound-campaigns/campaigns/{campaign_id}/progress\n@desc Get Outbound Campaign Progress\n@required {campaign_id: str}\n@returns(200) {leads: map{total: int, uncalled: int, leads_needing_attention: int, active: int, finished: int, finished_by_disposition: map}, conversations: map{scheduled: int, scheduled_by_type: map, awaiting_permission: int, in_progress: int, awaiting_analysis: int}, next_call_time_unix: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/outbound-campaigns/campaigns/{campaign_id}/leads\n@desc List Outbound Campaign Leads\n@required {campaign_id: str}\n@optional {page_size: int=100 # How many items to return at most., search: any # Only leads whose ID, user ID or phone number contains this text., status: any # `in_progress` for leads still being called, `finished` for leads that won't be called again., disposition: any # Only leads that finished in one of these ways., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {leads: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/outbound-campaigns/campaigns/{campaign_id}/calls\n@desc List Outbound Campaign Calls\n@required {campaign_id: str}\n@optional {page_size: int=100 # How many items to return at most., lead_id: any # Only this lead's calls., status: any # Only calls in this status., call_result: any # Only calls that ended in one of these results., stage: any # Only messages at this delivery stage. Message campaigns only., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {calls: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/outbound-campaigns/campaigns/{campaign_id}/follow-up-requests\n@desc Get Outbound Campaign Follow-Up Requests\n@required {campaign_id: str}\n@returns(200) {callbacks: map{requested: int, requested_by_disposition: map, distinct_leads: int}, redirects: map{requested: int, requested_by_disposition: map, distinct_leads: int}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/outbound-campaigns/campaigns/{campaign_id}/export\n@desc Export Outbound Campaign Calls\n@required {campaign_id: str}\n@optional {limit: any # Only export the first N calls; used to preview the columns. Omit to export every call.}\n@returns(200) Campaign calls CSV.\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/outbound-campaigns/campaigns/{campaign_id}/leads/{lead_id}\n@desc Get An Outbound Campaign Lead\n@required {campaign_id: str, lead_id: str}\n@returns(200) {lead_id: str, recipient_id: any, phone_number: str, phone_numbers: [str], phone_numbers_index: int, user_id: str, attempt_count: int, failure_count: int, callback_count: int, redirect_count: int, do_not_call: bool, terminal_disposition: any, created_at_unix: any, updated_at_unix: int, dynamic_variables: map, overrides: map{language: any, first_message: any, prompt: any, voice_id: any}, delivery: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/outbound-campaigns/campaigns/{campaign_id}/leads/{lead_id}\n@desc Remove An Outbound Campaign Lead\n@required {campaign_id: str, lead_id: str}\n@returns(200) {campaign_id: str, lead_id: str, has_calls_in_flight: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/outbound-campaigns/campaigns/{campaign_id}/pause\n@desc Pause An Outbound Campaign\n@required {campaign_id: str}\n@returns(200) {campaign_id: str, call_name: str, agent_id: str, channel_config: any, status: str, policy: map{timezone: str, retry: map{retry_delay_seconds: int, max_short_retries: int, max_total_calls: int, max_callbacks: int, max_redirects: int, interval_placement: str, rotate_step_seconds: int, max_consecutive_failures_per_number: any}, calling_periods: [map], data_collection: map{callback_time: any, redirect_phone_number: any, stop: any, mappings: map}, followup_context: map{call_type: bool, previous_conversation_id: bool, previous_summary: bool, previous_transcript: bool}}, variant: str, source: any, created_at_unix: int, scheduled_time_unix: any, updated_at_unix: int, branch_id: any, environment: any, target_concurrency_limit: any, channel: str, mode: str, counts: map{leads: int, terminal_leads: int, open_attention: int, delivery: any}, agent_name: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/outbound-campaigns/campaigns/{campaign_id}/resume\n@desc Resume An Outbound Campaign\n@required {campaign_id: str}\n@returns(200) {campaign_id: str, call_name: str, agent_id: str, channel_config: any, status: str, policy: map{timezone: str, retry: map{retry_delay_seconds: int, max_short_retries: int, max_total_calls: int, max_callbacks: int, max_redirects: int, interval_placement: str, rotate_step_seconds: int, max_consecutive_failures_per_number: any}, calling_periods: [map], data_collection: map{callback_time: any, redirect_phone_number: any, stop: any, mappings: map}, followup_context: map{call_type: bool, previous_conversation_id: bool, previous_summary: bool, previous_transcript: bool}}, variant: str, source: any, created_at_unix: int, scheduled_time_unix: any, updated_at_unix: int, branch_id: any, environment: any, target_concurrency_limit: any, channel: str, mode: str, counts: map{leads: int, terminal_leads: int, open_attention: int, delivery: any}, agent_name: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/outbound-campaigns/campaigns/{campaign_id}/stop\n@desc Stop An Outbound Campaign\n@required {campaign_id: str}\n@returns(200) {campaign_id: str, call_name: str, agent_id: str, channel_config: any, status: str, policy: map{timezone: str, retry: map{retry_delay_seconds: int, max_short_retries: int, max_total_calls: int, max_callbacks: int, max_redirects: int, interval_placement: str, rotate_step_seconds: int, max_consecutive_failures_per_number: any}, calling_periods: [map], data_collection: map{callback_time: any, redirect_phone_number: any, stop: any, mappings: map}, followup_context: map{call_type: bool, previous_conversation_id: bool, previous_summary: bool, previous_transcript: bool}}, variant: str, source: any, created_at_unix: int, scheduled_time_unix: any, updated_at_unix: int, branch_id: any, environment: any, target_concurrency_limit: any, channel: str, mode: str, counts: map{leads: int, terminal_leads: int, open_attention: int, delivery: any}, agent_name: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/outbound-campaigns/attention\n@desc List Outbound Campaign Attention Items\n@optional {campaign_id: any # Only this campaign's items., include_resolved: bool=false # Include items that are already resolved., page_size: int=100 # How many items to return at most., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {attention: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/outbound-campaigns/attention/{attention_id}/retry\n@desc Retry An Outbound Campaign Attention Item\n@required {attention_id: str}\n@returns(200) {attention_id: str, campaign_id: str, reason: str, detail: str, status: str, retryable: bool, resolution: any, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/outbound-campaigns/attention/{attention_id}/resolve\n@desc Resolve An Outbound Campaign Attention Item\n@required {attention_id: str, resolution: str # How the item was handled.}\n@returns(200) {attention_id: str, campaign_id: str, reason: str, detail: str, status: str, retryable: bool, resolution: any, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group speech-engine\n@endpoint GET /v1/speech-engine\n@desc List Speech Engines\n@optional {page_size: int=30 # How many Speech Engines to return at maximum. Can not exceed 100, defaults to 30., search: any # Search term to filter Speech Engines by name, sort_direction: str=desc # The direction to sort the results, sort_by: any # The field to sort the results by, cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {speech_engines: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/speech-engine\n@desc Create Speech Engine\n@required {speech_engine: map{ws_url!: str, request_headers: map}}\n@optional {name: str=Speech Engine # Name of the speech engine, asr: map{quality: str, provider: str, user_input_audio_format: str, keywords: [str]}, tts: map{model_id: str, voice_id: str, supported_voices: [map], expressive_mode: bool, suggested_audio_tags: [map], agent_output_audio_format: str, optimize_streaming_latency: int, stability: num, speed: num, similarity_boost: num, clone_strength: num, text_normalisation_type: str, pronunciation_dictionary_locators: [map], enable_phoneme_tags: bool, audio_effects: any}, turn: map{turn_timeout: num, initial_wait_time: any, silence_end_call_timeout: num, mode: str, turn_eagerness: str, spelling_patience: str, speculative_turn: bool, retranscribe_on_turn_timeout: bool, turn_model: str, interruption_ignore_terms: [str], interruption_ignore_term_languages: [str], merge_with_default_ignore_terms: bool, transcribe_on_disabled_interruptions: bool}, vad: map{background_voice_detection: bool}, conversation: map{text_only: bool, max_duration_seconds: int, client_events: [str], file_input: map, monitoring_enabled: bool, monitoring_events: [str], dtmf_input_settings: any, background_sound: map, source_attribution: bool}, privacy: map{record_voice: bool, retention_days: int, delete_transcript_and_pii: bool, delete_audio: bool, apply_to_existing_conversations: bool, zero_retention_mode: bool, conversation_history_redaction: map}, call_limits: map{agent_concurrency_limit: int, daily_limit: int, bursting_enabled: bool}, auth: map{enable_auth: bool}, language: str=en # Language for the speech engine, cascade_timeout_seconds: num=4 # Time in seconds to wait for the upstream speech engine endpoint to respond before the attempt is abandoned and retried. Must be between 2 and 15 seconds., tags: [str] # Tags for categorization, overrides: map{first_message: bool}}\n@returns(201) {speech_engine_id: str, name: str, speech_engine: map{ws_url: str, request_headers: map}, asr: map{quality: str, provider: str, user_input_audio_format: str, keywords: [str]}, tts: map{model_id: str, voice_id: str, supported_voices: [map], expressive_mode: bool, suggested_audio_tags: [map], agent_output_audio_format: str, optimize_streaming_latency: int, stability: num, speed: num, similarity_boost: num, clone_strength: num, text_normalisation_type: str, pronunciation_dictionary_locators: [map], enable_phoneme_tags: bool, audio_effects: any}, turn: map{turn_timeout: num, initial_wait_time: any, silence_end_call_timeout: num, mode: str, turn_eagerness: str, spelling_patience: str, speculative_turn: bool, retranscribe_on_turn_timeout: bool, turn_model: str, interruption_ignore_terms: [str], interruption_ignore_term_languages: [str], merge_with_default_ignore_terms: bool, transcribe_on_disabled_interruptions: bool}, vad: map{background_voice_detection: bool}, conversation: map{text_only: bool, max_duration_seconds: int, client_events: [str], file_input: map{enabled: bool, max_files_in_memory: int, max_files_per_conversation: int}, monitoring_enabled: bool, monitoring_events: [str], dtmf_input_settings: any, background_sound: map{source_type: any, source_id: any, volume: num, crossfade_loop: bool}, source_attribution: bool}, privacy: map{record_voice: bool, retention_days: int, delete_transcript_and_pii: bool, delete_audio: bool, apply_to_existing_conversations: bool, zero_retention_mode: bool, conversation_history_redaction: map{enabled: bool, entities: [str], excluded_data_collection_ids: [str]}}, call_limits: map{agent_concurrency_limit: int, daily_limit: int, bursting_enabled: bool}, auth: map{enable_auth: bool}, language: str, cascade_timeout_seconds: num, tags: [str], overrides: map{first_message: bool}, metadata: map{created_at_unix_secs: int, updated_at_unix_secs: int, created_from: str, last_updated_from: str}, access_info: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/speech-engine/{speech_engine_id}\n@desc Get Speech Engine\n@required {speech_engine_id: str # The speech engine ID (accepts seng_ or agent_ prefix)}\n@returns(200) {speech_engine_id: str, name: str, speech_engine: map{ws_url: str, request_headers: map}, asr: map{quality: str, provider: str, user_input_audio_format: str, keywords: [str]}, tts: map{model_id: str, voice_id: str, supported_voices: [map], expressive_mode: bool, suggested_audio_tags: [map], agent_output_audio_format: str, optimize_streaming_latency: int, stability: num, speed: num, similarity_boost: num, clone_strength: num, text_normalisation_type: str, pronunciation_dictionary_locators: [map], enable_phoneme_tags: bool, audio_effects: any}, turn: map{turn_timeout: num, initial_wait_time: any, silence_end_call_timeout: num, mode: str, turn_eagerness: str, spelling_patience: str, speculative_turn: bool, retranscribe_on_turn_timeout: bool, turn_model: str, interruption_ignore_terms: [str], interruption_ignore_term_languages: [str], merge_with_default_ignore_terms: bool, transcribe_on_disabled_interruptions: bool}, vad: map{background_voice_detection: bool}, conversation: map{text_only: bool, max_duration_seconds: int, client_events: [str], file_input: map{enabled: bool, max_files_in_memory: int, max_files_per_conversation: int}, monitoring_enabled: bool, monitoring_events: [str], dtmf_input_settings: any, background_sound: map{source_type: any, source_id: any, volume: num, crossfade_loop: bool}, source_attribution: bool}, privacy: map{record_voice: bool, retention_days: int, delete_transcript_and_pii: bool, delete_audio: bool, apply_to_existing_conversations: bool, zero_retention_mode: bool, conversation_history_redaction: map{enabled: bool, entities: [str], excluded_data_collection_ids: [str]}}, call_limits: map{agent_concurrency_limit: int, daily_limit: int, bursting_enabled: bool}, auth: map{enable_auth: bool}, language: str, cascade_timeout_seconds: num, tags: [str], overrides: map{first_message: bool}, metadata: map{created_at_unix_secs: int, updated_at_unix_secs: int, created_from: str, last_updated_from: str}, access_info: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/speech-engine/{speech_engine_id}\n@desc Update Speech Engine\n@required {speech_engine_id: str # The speech engine ID (accepts seng_ or agent_ prefix)}\n@optional {name: any, speech_engine: any, asr: any, tts: any, turn: any, vad: any, conversation: any, privacy: any, call_limits: any, auth: any # Who may start a conversation with this speech engine, language: any, cascade_timeout_seconds: any # Time in seconds to wait for the upstream speech engine endpoint to respond before the attempt is abandoned and retried. Must be between 2 and 15 seconds., tags: any, overrides: any}\n@returns(200) {speech_engine_id: str, name: str, speech_engine: map{ws_url: str, request_headers: map}, asr: map{quality: str, provider: str, user_input_audio_format: str, keywords: [str]}, tts: map{model_id: str, voice_id: str, supported_voices: [map], expressive_mode: bool, suggested_audio_tags: [map], agent_output_audio_format: str, optimize_streaming_latency: int, stability: num, speed: num, similarity_boost: num, clone_strength: num, text_normalisation_type: str, pronunciation_dictionary_locators: [map], enable_phoneme_tags: bool, audio_effects: any}, turn: map{turn_timeout: num, initial_wait_time: any, silence_end_call_timeout: num, mode: str, turn_eagerness: str, spelling_patience: str, speculative_turn: bool, retranscribe_on_turn_timeout: bool, turn_model: str, interruption_ignore_terms: [str], interruption_ignore_term_languages: [str], merge_with_default_ignore_terms: bool, transcribe_on_disabled_interruptions: bool}, vad: map{background_voice_detection: bool}, conversation: map{text_only: bool, max_duration_seconds: int, client_events: [str], file_input: map{enabled: bool, max_files_in_memory: int, max_files_per_conversation: int}, monitoring_enabled: bool, monitoring_events: [str], dtmf_input_settings: any, background_sound: map{source_type: any, source_id: any, volume: num, crossfade_loop: bool}, source_attribution: bool}, privacy: map{record_voice: bool, retention_days: int, delete_transcript_and_pii: bool, delete_audio: bool, apply_to_existing_conversations: bool, zero_retention_mode: bool, conversation_history_redaction: map{enabled: bool, entities: [str], excluded_data_collection_ids: [str]}}, call_limits: map{agent_concurrency_limit: int, daily_limit: int, bursting_enabled: bool}, auth: map{enable_auth: bool}, language: str, cascade_timeout_seconds: num, tags: [str], overrides: map{first_message: bool}, metadata: map{created_at_unix_secs: int, updated_at_unix_secs: int, created_from: str, last_updated_from: str}, access_info: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/speech-engine/{speech_engine_id}\n@desc Delete Speech Engine\n@required {speech_engine_id: str # The speech engine ID (accepts seng_ or agent_ prefix)}\n@returns(204) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/speech-engine/{speech_engine_id}/duplicate\n@desc Duplicate Speech Engine\n@required {speech_engine_id: str # The speech engine ID (accepts seng_ or agent_ prefix)}\n@returns(201) {speech_engine_id: str, name: str, speech_engine: map{ws_url: str, request_headers: map}, asr: map{quality: str, provider: str, user_input_audio_format: str, keywords: [str]}, tts: map{model_id: str, voice_id: str, supported_voices: [map], expressive_mode: bool, suggested_audio_tags: [map], agent_output_audio_format: str, optimize_streaming_latency: int, stability: num, speed: num, similarity_boost: num, clone_strength: num, text_normalisation_type: str, pronunciation_dictionary_locators: [map], enable_phoneme_tags: bool, audio_effects: any}, turn: map{turn_timeout: num, initial_wait_time: any, silence_end_call_timeout: num, mode: str, turn_eagerness: str, spelling_patience: str, speculative_turn: bool, retranscribe_on_turn_timeout: bool, turn_model: str, interruption_ignore_terms: [str], interruption_ignore_term_languages: [str], merge_with_default_ignore_terms: bool, transcribe_on_disabled_interruptions: bool}, vad: map{background_voice_detection: bool}, conversation: map{text_only: bool, max_duration_seconds: int, client_events: [str], file_input: map{enabled: bool, max_files_in_memory: int, max_files_per_conversation: int}, monitoring_enabled: bool, monitoring_events: [str], dtmf_input_settings: any, background_sound: map{source_type: any, source_id: any, volume: num, crossfade_loop: bool}, source_attribution: bool}, privacy: map{record_voice: bool, retention_days: int, delete_transcript_and_pii: bool, delete_audio: bool, apply_to_existing_conversations: bool, zero_retention_mode: bool, conversation_history_redaction: map{enabled: bool, entities: [str], excluded_data_collection_ids: [str]}}, call_limits: map{agent_concurrency_limit: int, daily_limit: int, bursting_enabled: bool}, auth: map{enable_auth: bool}, language: str, cascade_timeout_seconds: num, tags: [str], overrides: map{first_message: bool}, metadata: map{created_at_unix_secs: int, updated_at_unix_secs: int, created_from: str, last_updated_from: str}, access_info: any} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group convai\n@endpoint POST /v1/convai/conversations/{conversation_id}/messages\n@desc Send Conversation Message\n@required {conversation_id: str # The Conversation ID, input: [any] # Either one `user_message`, which starts a new turn, or `client_tool_result` items, which answer the `required_actions` of the waiting turn and continue it. Calls that they leave out stay pending. Client tools wait with no timeout. While calls are pending, a `user_message` is rejected. A `user_message` can come with `contextual_update` items, at most one per `context_id`. `client_tool_result` items that answer every pending call can come with `end` updates.}\n@optional {background: bool=false # If true, return a 202 handle after the turn is admitted instead of waiting for generation to finish.}\n@returns(200) {turn_id: str, status: str, output: [map], error: any, required_actions: [map], stream_cursor: any} # Successful Response\n@returns(202) {turn_id: str, status: str, output: [map], error: any, required_actions: [map], stream_cursor: any} # The server admitted the turn in background mode.\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/conversations/{conversation_id}/messages/stream\n@desc Send Conversation Message Stream\n@required {conversation_id: str # The Conversation ID, input: [any] # Either one `user_message`, which starts a new turn, or `client_tool_result` items, which answer the `required_actions` of the waiting turn and continue it. Calls that they leave out stay pending. Client tools wait with no timeout. While calls are pending, a `user_message` is rejected. A `user_message` can come with `contextual_update` items, at most one per `context_id`. `client_tool_result` items that answer every pending call can come with `end` updates.}\n@returns(200) {conversation_id: str, turn_id: str, created_at_unix_ms: int, event: any} # Server-sent events. Each event has the stream cursor as its `id`, the event type as its `event`, and a stream envelope as its `data`.\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/conversations/{conversation_id}/turns/{turn_id}\n@desc Get Conversation Turn\n@required {conversation_id: str # The Conversation ID, turn_id: str # The Turn ID}\n@returns(200) {turn_id: str, status: str, output: [map], error: any, required_actions: [map], stream_cursor: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/conversations/{conversation_id}/turns/{turn_id}/events\n@desc Stream Conversation Turn Events\n@required {conversation_id: str # The Conversation ID, turn_id: str # The Turn ID}\n@optional {Last-Event-ID: any}\n@returns(200) {conversation_id: str, turn_id: str, created_at_unix_ms: int, event: any} # Server-sent events. Each event has the stream cursor as its `id`, the event type as its `event`, and a stream envelope as its `data`.\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures\n@desc Create Procedure\n@required {agent_id: str # Agent ID to get the procedure draft from, branch_id: str # Branch ID to get the procedure draft from}\n@returns(200) {procedure_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures\n@desc List Procedures\n@required {agent_id: str # Agent ID to get the procedure draft from, branch_id: str # Branch ID to get the procedure draft from}\n@optional {agent_version_id: any # The agent version ID to retrieve the procedure for.}\n@returns(200) {procedures: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/compile\n@desc Legacy: Compile Procedures\n@required {agent_id: str # Agent ID to get the procedure draft from, branch_id: str # Branch ID to get the procedure draft from}\n@returns(200) {workflow: map{edges: map, nodes: map, prevent_subagent_loops: bool}} # Successful Response\n@errors {400: Structured procedure validation failed., 422: Validation Error}\n\n@endpoint DELETE /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}\n@desc Remove Procedure\n@required {agent_id: str # Agent ID to get the procedure draft from, branch_id: str # Branch ID to get the procedure draft from, procedure_id: str # The procedure ID}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}\n@desc Get Procedure\n@required {agent_id: str # Agent ID to get the procedure draft from, branch_id: str # Branch ID to get the procedure draft from, procedure_id: str # The procedure ID}\n@optional {version_id: any # The version ID to retrieve. If omitted, returns the version at branch HEAD., agent_version_id: any # The agent version ID to retrieve the procedure for.}\n@returns(200) {procedure_id: str, version_id: any, name: str, content: str, type: str, trigger: str, folder_parent_id: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft\n@desc Get Procedure Draft\n@required {agent_id: str # Agent ID to get the procedure draft from, branch_id: str # Branch ID to get the procedure draft from, procedure_id: str # The procedure ID}\n@returns(200) {procedure_id: str, name: str, content: str, type: str, trigger: str, folder_parent_id: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft\n@desc Update Procedure Draft\n@required {agent_id: str # Agent ID to get the procedure draft from, branch_id: str # Branch ID to get the procedure draft from, procedure_id: str # The procedure ID, name: str # Procedure name, content: str # Procedure content, type: str(free_form/deterministic/folder)=free_form}\n@optional {trigger: any # When the agent should use this procedure. Empty string means this is a sub-procedure that should only start when another procedure references it. Omit this field (or send null) to keep the stored trigger, which is empty on create. Send `\"\"` to clear it. `description` is accepted as an alias.}\n@returns(200) {procedure_id: str, name: str, content: str, type: str, trigger: str, folder_parent_id: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft\n@desc Delete Procedure Draft\n@required {agent_id: str # Agent ID to get the procedure draft from, branch_id: str # Branch ID to get the procedure draft from, procedure_id: str # The procedure ID}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/conversations/{conversation_id}/analysis/run\n@desc Run Conversation Analysis\n@required {conversation_id: str # ID of the conversation}\n@returns(200) {agent_id: str, agent_name: any, conversation_product: str, status: str, user_id: any, branch_id: any, version_id: any, metadata: map{start_time_unix_secs: int, accepted_time_unix_secs: any, call_duration_secs: int, queue_wait_secs: any, cost: any, deletion_settings: map{deletion_time_unix_secs: any, deleted_logs_at_time_unix_secs: any, deleted_audio_at_time_unix_secs: any, deleted_transcript_at_time_unix_secs: any, delete_transcript_and_pii: bool, delete_audio: bool}, feedback: map{type: any, overall_score: any, likes: int, dislikes: int, rating: any, comment: any}, authorization_method: str, charging: map{dev_discount: bool, is_burst: bool, tier: any, llm_usage: map{irreversible_generation: map, initiated_generation: map}, llm_price: any, llm_charge: any, call_charge: any, platform_charge: any, platform_usage: map{category_usage: map}, platform_price: any, free_minutes_consumed: num, free_llm_dollars_consumed: num, tts_usage: any, asr_usage: any, analysis: any, voice_surcharge_charge: any}, phone_call: any, batch_call: any, termination_reason: str, error: any, warnings: [str], main_language: any, rag_usage: any, text_only: bool, features_usage: map{language_detection: map{enabled: bool, used: bool}, transfer_to_agent: map{enabled: bool, used: bool}, transfer_to_number: map{enabled: bool, used: bool}, multivoice: map{enabled: bool, used: bool}, dtmf_tones: map{enabled: bool, used: bool}, external_mcp_servers: map{enabled: bool, used: bool}, pii_zrm_workspace: bool, pii_zrm_agent: bool, tool_dynamic_variable_updates: map{enabled: bool, used: bool}, is_livekit: bool, voicemail_detection: map{enabled: bool, used: bool}, dtmf_input: map{enabled: bool, used: bool}, workflow: map{enabled: bool, tool_node: map, standalone_agent_node: map, phone_number_node: map, end_node: map, override_agent_node: map}, agent_testing: map{enabled: bool, tests_ran_after_last_modification: bool, tests_ran_in_last_7_days: bool}, versioning: map{enabled: bool, used: bool}, file_input: map{enabled: bool, used: bool}, freeform_procedure: map{enabled: bool, used: bool}, structured_procedure: map{enabled: bool, used: bool}}, eleven_assistant: map{is_eleven_assistant: bool}, initiator_id: any, conversation_initiation_source: str, conversation_initiation_source_version: any, timezone: any, async_metadata: any, whatsapp: any, sms: any, agent_created_from: str, agent_last_updated_from: str, voice_rewards: [map], cost_fiat: any}, analysis: any, user_message_count: any, agent_message_count: any, visited_agents: [map], conversation_initiation_client_data: map{conversation_config_override: map{asr: any, turn: any, tts: any, conversation: any, agent: any}, custom_llm_extra_body: map, user_id: any, source_info: map{source: any, version: any}, branch_id: any, environment: any, starting_workflow_node_id: any, procedure_ids: any, start_procedure_ids: any, dynamic_variables: map}, environment: str, conversation_id: str, has_audio: bool, has_user_audio: bool, has_response_audio: bool, has_auxiliary_audio: bool, transcript: [map], tag_ids: [str], otlp_traces: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/conversations/{conversation_id}/analysis/evaluations/run\n@desc Run Conversation Evaluation\n@required {conversation_id: str # ID of the conversation, evaluation_id: str # ID of the single evaluation criterion to rerun.}\n@optional {scope: str(conversation/agent)=conversation, evaluated_agent_id: any # ID of the agent whose evaluation result to rerun, for conversations that transferred between agents. If omitted, a conversation-scoped evaluation reruns for the agent that started the conversation., evaluated_branch_id: any # Branch of `evaluated_agent_id` whose evaluation result to rerun, for conversations that visited the agent on more than one branch. If omitted, the result reruns for every branch of that agent.}\n@returns(200) {agent_id: str, agent_name: any, conversation_product: str, status: str, user_id: any, branch_id: any, version_id: any, metadata: map{start_time_unix_secs: int, accepted_time_unix_secs: any, call_duration_secs: int, queue_wait_secs: any, cost: any, deletion_settings: map{deletion_time_unix_secs: any, deleted_logs_at_time_unix_secs: any, deleted_audio_at_time_unix_secs: any, deleted_transcript_at_time_unix_secs: any, delete_transcript_and_pii: bool, delete_audio: bool}, feedback: map{type: any, overall_score: any, likes: int, dislikes: int, rating: any, comment: any}, authorization_method: str, charging: map{dev_discount: bool, is_burst: bool, tier: any, llm_usage: map{irreversible_generation: map, initiated_generation: map}, llm_price: any, llm_charge: any, call_charge: any, platform_charge: any, platform_usage: map{category_usage: map}, platform_price: any, free_minutes_consumed: num, free_llm_dollars_consumed: num, tts_usage: any, asr_usage: any, analysis: any, voice_surcharge_charge: any}, phone_call: any, batch_call: any, termination_reason: str, error: any, warnings: [str], main_language: any, rag_usage: any, text_only: bool, features_usage: map{language_detection: map{enabled: bool, used: bool}, transfer_to_agent: map{enabled: bool, used: bool}, transfer_to_number: map{enabled: bool, used: bool}, multivoice: map{enabled: bool, used: bool}, dtmf_tones: map{enabled: bool, used: bool}, external_mcp_servers: map{enabled: bool, used: bool}, pii_zrm_workspace: bool, pii_zrm_agent: bool, tool_dynamic_variable_updates: map{enabled: bool, used: bool}, is_livekit: bool, voicemail_detection: map{enabled: bool, used: bool}, dtmf_input: map{enabled: bool, used: bool}, workflow: map{enabled: bool, tool_node: map, standalone_agent_node: map, phone_number_node: map, end_node: map, override_agent_node: map}, agent_testing: map{enabled: bool, tests_ran_after_last_modification: bool, tests_ran_in_last_7_days: bool}, versioning: map{enabled: bool, used: bool}, file_input: map{enabled: bool, used: bool}, freeform_procedure: map{enabled: bool, used: bool}, structured_procedure: map{enabled: bool, used: bool}}, eleven_assistant: map{is_eleven_assistant: bool}, initiator_id: any, conversation_initiation_source: str, conversation_initiation_source_version: any, timezone: any, async_metadata: any, whatsapp: any, sms: any, agent_created_from: str, agent_last_updated_from: str, voice_rewards: [map], cost_fiat: any}, analysis: any, user_message_count: any, agent_message_count: any, visited_agents: [map], conversation_initiation_client_data: map{conversation_config_override: map{asr: any, turn: any, tts: any, conversation: any, agent: any}, custom_llm_extra_body: map, user_id: any, source_info: map{source: any, version: any}, branch_id: any, environment: any, starting_workflow_node_id: any, procedure_ids: any, start_procedure_ids: any, dynamic_variables: map}, environment: str, conversation_id: str, has_audio: bool, has_user_audio: bool, has_response_audio: bool, has_auxiliary_audio: bool, transcript: [map], tag_ids: [str], otlp_traces: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/environment-variables\n@desc List Environment Variables\n@optional {cursor: any # Pagination cursor from previous response, page_size: int=100 # Number of items to return (1-100), label: any # Filter by exact label match, environment: any # Filter to only return variables that have this environment. When specified, the values dict in the response will only contain this environment., type: any # Filter by variable type}\n@returns(200) {environment_variables: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {400: Invalid environment filter, 422: Validation Error}\n\n@endpoint POST /v1/convai/environment-variables\n@desc Create Environment Variable\n@returns(200) {label: str, created_at_unix_secs: int, updated_at_unix_secs: int, created_by_user_id: any, type: str, id: str, workspace_id: str, values: any} # Successful Response\n@errors {400: Invalid parameters, 409: Environment variable with this label already exists, 422: Validation Error}\n\n@endpoint GET /v1/convai/environment-variables/{env_var_id}\n@desc Get Environment Variable\n@required {env_var_id: str}\n@returns(200) {label: str, created_at_unix_secs: int, updated_at_unix_secs: int, created_by_user_id: any, type: str, id: str, workspace_id: str, values: any} # Successful Response\n@errors {404: Environment variable not found, 422: Validation Error}\n\n@endpoint PATCH /v1/convai/environment-variables/{env_var_id}\n@desc Update Environment Variable\n@required {env_var_id: str, values: map # Values to replace. Set to null to remove the value for an environment (except 'production').}\n@returns(200) {label: str, created_at_unix_secs: int, updated_at_unix_secs: int, created_by_user_id: any, type: str, id: str, workspace_id: str, values: any} # Successful Response\n@errors {400: Invalid parameters or type mismatch, 404: Environment variable not found, 422: Validation Error}\n\n@endpoint DELETE /v1/convai/environment-variables/{env_var_id}\n@desc Delete Environment Variable\n@required {env_var_id: str}\n@returns(204) Environment variable deleted\n@errors {404: Environment variable not found, 409: Environment variable is still in use, 422: Validation Error}\n\n@endpoint GET /v1/convai/environments\n@desc List Environments\n@returns(200) {environments: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/environments\n@desc Create Environment\n@required {name: str # Unique name of the environment, e.g. 'staging'.}\n@returns(200) {name: str, updated_at_unix_secs: any, created_by_user_id: any} # Successful Response\n@errors {400: Invalid environment name, 409: Environment with this name already exists, 422: Validation Error}\n\n@endpoint DELETE /v1/convai/environments/{environment}\n@desc Delete Environment\n@required {environment: str # Name of the environment to delete, e.g. 'staging'.}\n@returns(204) Environment deleted\n@errors {400: 'production' cannot be deleted, 404: Environment not found, 422: Validation Error}\n\n@endpoint GET /v1/convai/realtime/conversation-groups\n@desc List Realtime Conversation Groups\n@optional {page_size: int=100 # How many conversation groups to return. Can not exceed 100., search: any # If specified, only conversation groups whose title or description contains this string (case-insensitive) are returned., cursor: any # Used for fetching next page. Cursor is returned in the response.}\n@returns(200) {conversation_groups: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/realtime/conversation-groups\n@desc Create Realtime Conversation Group\n@required {title: str # Name of the conversation group. Names are unique per workspace, ignoring case and extra whitespace, and at most 64 characters.}\n@optional {description: any # Optional description of the conversation group.}\n@returns(200) {id: str, title: str, description: any, access_info: map{is_creator: bool, creator_name: str, creator_email: str, role: str, anonymous_access_level_override: any, access_source: any}, sharing: map{people_count: int, shared_with_everyone: bool, everyone_role: any}, created_at_unix_secs: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/convai/realtime/conversation-groups/{conversation_group_id}\n@desc Get Realtime Conversation Group\n@required {conversation_group_id: str # The id of a realtime conversation group.}\n@returns(200) {id: str, title: str, description: any, access_info: map{is_creator: bool, creator_name: str, creator_email: str, role: str, anonymous_access_level_override: any, access_source: any}, sharing: map{people_count: int, shared_with_everyone: bool, everyone_role: any}, created_at_unix_secs: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/convai/realtime/conversation-groups/{conversation_group_id}\n@desc Update Realtime Conversation Group\n@required {conversation_group_id: str # The id of a realtime conversation group.}\n@optional {title: any # Name of the conversation group. Names are unique per workspace, ignoring case and extra whitespace, and at most 64 characters., description: any # New description of the conversation group.}\n@returns(200) {id: str, title: str, description: any, access_info: map{is_creator: bool, creator_name: str, creator_email: str, role: str, anonymous_access_level_override: any, access_source: any}, sharing: map{people_count: int, shared_with_everyone: bool, everyone_role: any}, created_at_unix_secs: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/realtime/conversation-groups/{conversation_group_id}\n@desc Delete Realtime Conversation Group\n@required {conversation_group_id: str # The id of a realtime conversation group.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint PUT /v1/convai/realtime/conversations/{conversation_id}/conversation-group\n@desc Set Realtime Conversation Group\n@required {conversation_id: str # The id of a realtime conversation., conversation_group_id: str # The conversation group to place the conversation in. A conversation belongs to at most one group, so this moves it out of any current group.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/convai/realtime/conversations/{conversation_id}/conversation-group\n@desc Clear Realtime Conversation Group\n@required {conversation_id: str # The id of a realtime conversation.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/convai/realtime/client_secrets\n@desc Create Realtime Client Secret\n@returns(200) {value: str, expires_at: int, session: any} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group music\n@endpoint POST /v1/music/plan\n@desc Generate Composition Plan\n@required {prompt: str # A simple text prompt to compose a plan from.}\n@optional {enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. Zero retention mode may only be used by enterprise customers., music_length_ms: any # The length of the composition plan to generate in milliseconds. Must be between 3000ms and 600000ms. Optional - if not provided, the model will choose a length based on the prompt., source_composition_plan: any # An optional composition plan to use as a source for the new composition plan., model_id: str(music_v1/music_v2/music_v2_5)=music_v1}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/music\n@desc Compose Music\n@optional {output_format: str(auto/mp3_48000_128/mp3_48000_192/mp3_48000_240/mp3_48000_320/mp3_22050_32/mp3_24000_48/mp3_44100_32/mp3_44100_64/mp3_44100_96/mp3_44100_128/mp3_44100_192/pcm_8000/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/ulaw_8000/alaw_8000/opus_48000_32/opus_48000_64/opus_48000_96/opus_48000_128/opus_48000_192)=auto # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. Use \"auto\" (the default) to let the API pick the best format for the selected model: mp3_44100_128 for v1 models and mp3_48000_192 for v2 models., enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. Zero retention mode may only be used by enterprise customers., prompt: any # A simple text prompt to generate a song from. Cannot be used in conjunction with `composition_plan`., generation_mode: any # Optional generation mode hint for prompt-based music generation. Can only be used with `prompt`., music_prompt: any # A music prompt. Deprecated. Use `composition_plan` instead., lyrics_text: any # The lyrics text to use for the generation., composition_plan: any # A detailed composition plan to guide music generation. Cannot be used in conjunction with `prompt`., music_length_ms: any # The length of the song to generate in milliseconds. Used only in conjunction with `prompt`. Must be between 3000ms and 600000ms. Optional - if not provided, the model will choose a length based on the prompt., model_id: str(music_v1/music_v2/music_v2_5)=music_v1, seed: any # Random seed to initialize the music generation process. Providing the same seed with the same parameters can help achieve more consistent results, but exact reproducibility is not guaranteed and outputs may change across system updates. Cannot be used in conjunction with prompt., force_instrumental: bool=false # If true, guarantees that the generated song will be instrumental. If false, the song may or may not be instrumental depending on the `prompt`. Can only be used with `prompt`., finetune_id: any # The ID of the finetune to use for the generation, finetune_strength: num=1 # How strongly the finetune influences the generation. Defaults to 1.0 (full strength). Lower values soften the influence of the finetune, leaving more room for prompt-level steering. Only meaningful when `finetune_id` is also provided., use_phonetic_names: bool=false # If true, proper names in the prompt will be phonetically spelled in the lyrics for better pronunciation by the music model. The original names will be restored in word timestamps., respect_sections_durations: bool=true # Controls how strictly section durations in the `composition_plan` are enforced. Only used with `composition_plan` and only applies to `music_v1`; for `music_v2` and `music_v2_5` section durations are always enforced and this is ignored. When false for `music_v1`, the model may adjust individual section durations for better quality and latency, while preserving the total song duration from the plan., store_for_inpainting: bool=false # Whether to store the generated song for inpainting., sign_with_c2pa: bool=false # Whether to sign the generated song with C2PA. Applicable only for mp3 files.}\n@returns(200) The generated audio file in the format specified\n@errors {422: Validation Error}\n\n@endpoint POST /v1/music/detailed\n@desc Compose Music With A Detailed Response\n@optional {output_format: str(auto/mp3_48000_128/mp3_48000_192/mp3_48000_240/mp3_48000_320/mp3_22050_32/mp3_24000_48/mp3_44100_32/mp3_44100_64/mp3_44100_96/mp3_44100_128/mp3_44100_192/pcm_8000/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/ulaw_8000/alaw_8000/opus_48000_32/opus_48000_64/opus_48000_96/opus_48000_128/opus_48000_192)=auto # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. Use \"auto\" (the default) to let the API pick the best format for the selected model: mp3_44100_128 for v1 models and mp3_48000_192 for v2 models., enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. Zero retention mode may only be used by enterprise customers., prompt: any # A simple text prompt to generate a song from. Cannot be used in conjunction with `composition_plan`., generation_mode: any # Optional generation mode hint for prompt-based music generation. Can only be used with `prompt`., music_prompt: any # A music prompt. Deprecated. Use `composition_plan` instead., lyrics_text: any # The lyrics text to use for the generation., composition_plan: any # A detailed composition plan to guide music generation. Cannot be used in conjunction with `prompt`., music_length_ms: any # The length of the song to generate in milliseconds. Used only in conjunction with `prompt`. Must be between 3000ms and 600000ms. Optional - if not provided, the model will choose a length based on the prompt., model_id: str(music_v1/music_v2/music_v2_5)=music_v1, seed: any # Random seed to initialize the music generation process. Providing the same seed with the same parameters can help achieve more consistent results, but exact reproducibility is not guaranteed and outputs may change across system updates. Cannot be used in conjunction with prompt., force_instrumental: bool=false # If true, guarantees that the generated song will be instrumental. If false, the song may or may not be instrumental depending on the `prompt`. Can only be used with `prompt`., finetune_id: any # The ID of the finetune to use for the generation, finetune_strength: num=1 # How strongly the finetune influences the generation. Defaults to 1.0 (full strength). Lower values soften the influence of the finetune, leaving more room for prompt-level steering. Only meaningful when `finetune_id` is also provided., use_phonetic_names: bool=false # If true, proper names in the prompt will be phonetically spelled in the lyrics for better pronunciation by the music model. The original names will be restored in word timestamps., respect_sections_durations: bool=true # Controls how strictly section durations in the `composition_plan` are enforced. Only used with `composition_plan` and only applies to `music_v1`; for `music_v2` and `music_v2_5` section durations are always enforced and this is ignored. When false for `music_v1`, the model may adjust individual section durations for better quality and latency, while preserving the total song duration from the plan., store_for_inpainting: bool=false # Whether to store the generated song for inpainting., with_timestamps: bool=false # Whether to return the timestamps of the words in the generated song., with_waveform_visual: bool=false # Whether to return the visual waveform of the generated song., sign_with_c2pa: bool=false # Whether to sign the generated song with C2PA. Applicable only for mp3 files., model_style_prefix: str(music/sfx)=music}\n@returns(200) Multipart/mixed response with JSON metadata and binary audio file\n@errors {422: Validation Error}\n\n@endpoint POST /v1/music/detailed/stream\n@desc Stream Composed Music With A Detailed Response\n@optional {output_format: str(auto/mp3_48000_128/mp3_48000_192/mp3_48000_240/mp3_48000_320/mp3_22050_32/mp3_24000_48/mp3_44100_32/mp3_44100_64/mp3_44100_96/mp3_44100_128/mp3_44100_192/pcm_8000/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/ulaw_8000/alaw_8000/opus_48000_32/opus_48000_64/opus_48000_96/opus_48000_128/opus_48000_192)=auto # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. Use \"auto\" (the default) to let the API pick the best format for the selected model: mp3_44100_128 for v1 models and mp3_48000_192 for v2 models., enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. Zero retention mode may only be used by enterprise customers., prompt: any # A simple text prompt to generate a song from. Cannot be used in conjunction with `composition_plan`., generation_mode: any # Optional generation mode hint for prompt-based music generation. Can only be used with `prompt`., music_prompt: any # A music prompt. Deprecated. Use `composition_plan` instead., lyrics_text: any # The lyrics text to use for the generation., composition_plan: any # A detailed composition plan to guide music generation. Cannot be used in conjunction with `prompt`., music_length_ms: any # The length of the song to generate in milliseconds. Used only in conjunction with `prompt`. Must be between 3000ms and 600000ms. Optional - if not provided, the model will choose a length based on the prompt., model_id: str(music_v1/music_v2/music_v2_5)=music_v1, seed: any # Random seed to initialize the music generation process. Providing the same seed with the same parameters can help achieve more consistent results, but exact reproducibility is not guaranteed and outputs may change across system updates. Cannot be used in conjunction with prompt., force_instrumental: bool=false # If true, guarantees that the generated song will be instrumental. If false, the song may or may not be instrumental depending on the `prompt`. Can only be used with `prompt`., finetune_id: any # The ID of the finetune to use for the generation, finetune_strength: num=1 # How strongly the finetune influences the generation. Defaults to 1.0 (full strength). Lower values soften the influence of the finetune, leaving more room for prompt-level steering. Only meaningful when `finetune_id` is also provided., use_phonetic_names: bool=false # If true, proper names in the prompt will be phonetically spelled in the lyrics for better pronunciation by the music model. The original names will be restored in word timestamps., store_for_inpainting: bool=false # Whether to store the generated song for inpainting., with_timestamps: bool=false # Whether to return the timestamps of the words in the generated song., with_waveform_visual: bool=false # Whether to return the visual waveform of the generated song.}\n@returns(200) Server-Sent Events for composition plan, song metadata, audio chunks with optional word timestamps and visual waveform, and completion.\n@errors {422: Validation Error}\n\n@endpoint POST /v1/music/stream\n@desc Stream Composed Music\n@optional {output_format: str(auto/mp3_48000_128/mp3_48000_192/mp3_48000_240/mp3_48000_320/mp3_22050_32/mp3_24000_48/mp3_44100_32/mp3_44100_64/mp3_44100_96/mp3_44100_128/mp3_44100_192/pcm_8000/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/ulaw_8000/alaw_8000/opus_48000_32/opus_48000_64/opus_48000_96/opus_48000_128/opus_48000_192)=auto # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. Use \"auto\" (the default) to let the API pick the best format for the selected model: mp3_44100_128 for v1 models and mp3_48000_192 for v2 models., enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. Zero retention mode may only be used by enterprise customers., prompt: any # A simple text prompt to generate a song from. Cannot be used in conjunction with `composition_plan`., generation_mode: any # Optional generation mode hint for prompt-based music generation. Can only be used with `prompt`., music_prompt: any # A music prompt. Deprecated. Use `composition_plan` instead., lyrics_text: any # The lyrics text to use for the generation., composition_plan: any # A detailed composition plan to guide music generation. Cannot be used in conjunction with `prompt`., music_length_ms: any # The length of the song to generate in milliseconds. Used only in conjunction with `prompt`. Must be between 3000ms and 600000ms. Optional - if not provided, the model will choose a length based on the prompt., model_id: str(music_v1/music_v2/music_v2_5)=music_v1, seed: any # Random seed to initialize the music generation process. Providing the same seed with the same parameters can help achieve more consistent results, but exact reproducibility is not guaranteed and outputs may change across system updates. Cannot be used in conjunction with prompt., force_instrumental: bool=false # If true, guarantees that the generated song will be instrumental. If false, the song may or may not be instrumental depending on the `prompt`. Can only be used with `prompt`., finetune_id: any # The ID of the finetune to use for the generation, finetune_strength: num=1 # How strongly the finetune influences the generation. Defaults to 1.0 (full strength). Lower values soften the influence of the finetune, leaving more room for prompt-level steering. Only meaningful when `finetune_id` is also provided., use_phonetic_names: bool=false # If true, proper names in the prompt will be phonetically spelled in the lyrics for better pronunciation by the music model. The original names will be restored in word timestamps., store_for_inpainting: bool=false # Whether to store the generated song for inpainting.}\n@returns(200) Streaming audio data in the format specified\n@errors {422: Validation Error}\n\n@endpoint POST /v1/music/upload\n@desc Upload Music\n@returns(200) {song_id: str, composition_plan: any, words_timestamps: any, waveform_visual: any} # Successfully uploaded music file with optional composition plan\n@errors {422: Validation Error}\n\n@endpoint POST /v1/music/stem-separation\n@desc Stem Separation\n@optional {output_format: str(mp3_22050_32/mp3_24000_48/mp3_44100_32/mp3_44100_64/mp3_44100_96/mp3_44100_128/mp3_44100_192/pcm_8000/pcm_16000/pcm_22050/pcm_24000/pcm_32000/pcm_44100/pcm_48000/ulaw_8000/alaw_8000/opus_48000_32/opus_48000_64/opus_48000_96/opus_48000_128/opus_48000_192)=mp3_44100_128 # Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs., enable_logging: bool=true # When enable_logging is set to false zero retention mode will be used for the request. Zero retention mode may only be used by enterprise customers.}\n@returns(200) ZIP archive containing separated audio stems. Each stem is provided as a separate audio file in the requested output format.\n@errors {422: Validation Error}\n\n@endpoint GET /v1/music/finetunes\n@desc Get Music Finetunes\n@optional {cursor: any # Used for fetching the next page. Cursor is returned in the response., page_size: int=50 # How many finetunes to return. Max 150, default 50., visibility: any # Filter by visibility. 'private' returns private finetunes; 'workspace' returns workspace-shared finetunes; 'public' returns public finetunes, which are currently ElevenLabs curated finetunes. Omit to return all accessible finetunes., created_by: any # Filter by creator. 'self' returns finetunes you created; 'workspace' returns finetunes created by workspace teammates; 'elevenlabs' returns ElevenLabs curated finetunes. Omit to return finetunes from all creators., sort: str(created_at/name)=created_at # Sort by field (created_at or name), sort_direction: str(asc/desc)=desc # Sort direction (asc or desc)}\n@returns(200) {finetunes: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/music/finetunes\n@desc Create Music Finetune\n@returns(201) {id: str, name: str, tags: [str], primary_genre: any, model_id: str, created_at: str(date-time), visibility: str, created_by: str, status: str, training_progress: num, failure_reason: any} # Successful Response\n@errors {403: Missing permissions to manage music finetunes., 404: Finetune not found., 422: Validation Error}\n\n@endpoint GET /v1/music/finetunes/{finetune_id}\n@desc Get Music Finetune\n@required {finetune_id: str}\n@returns(200) {id: str, name: str, tags: [str], primary_genre: any, model_id: str, created_at: str(date-time), visibility: str, created_by: str, status: str, training_progress: num, failure_reason: any} # Successful Response\n@errors {403: Missing permissions to manage music finetunes., 404: Finetune not found., 422: Validation Error}\n\n@endpoint PATCH /v1/music/finetunes/{finetune_id}\n@desc Update Music Finetune\n@required {finetune_id: str}\n@optional {name: any # Updated name for the finetune., tags: any # Replacement set of tags., primary_genre: any # Updated primary musical genre., visibility: any # Finetune visibility. Only 'private' and 'workspace' can be set.}\n@returns(200) {id: str, name: str, tags: [str], primary_genre: any, model_id: str, created_at: str(date-time), visibility: str, created_by: str, status: str, training_progress: num, failure_reason: any} # Successful Response\n@errors {403: Missing permissions to manage music finetunes., 404: Finetune not found., 422: Validation Error}\n\n@endpoint DELETE /v1/music/finetunes/{finetune_id}\n@desc Delete Music Finetune\n@required {finetune_id: str}\n@returns(200) {id: str, name: str, tags: [str], primary_genre: any, model_id: str, created_at: str(date-time), visibility: str, created_by: str, status: str, training_progress: num, failure_reason: any} # Successful Response\n@errors {403: Missing permissions to manage music finetunes., 404: Finetune not found., 422: Validation Error}\n\n@endgroup\n\n@group productions\n@endpoint POST /v1/productions/orders\n@desc Create Order\n@returns(200) {order_id: str, sandbox: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/productions/orders\n@desc List Orders\n@optional {page_size: int=20 # Maximum number of orders to return per page., offset: int=0 # Number of orders to skip for pagination., status: any # Filter orders by one or more statuses., start_date: any # Filter orders created on or after this date., end_date: any # Filter orders created on or before this date.}\n@returns(200) {orders: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/productions/orders/{order_id}\n@desc Get Order\n@required {order_id: str # The ID of the order.}\n@returns(200) {order_id: str, name: str, state: str, items: [map], total_amount_usd: any, sandbox: bool, created_at: str(date-time), submitted_at: any, paid_at: any, accepted_at: any, completed_at: any, cancel_reason: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/productions/orders/{order_id}\n@desc Update Order\n@required {order_id: str # The ID of the order., request: map{name!: str}}\n@returns(200) {name: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/productions/orders/{order_id}/media\n@desc Register Media\n@required {order_id: str # The ID of the order to which this media will be attached.}\n@returns(200) {media_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/productions/orders/{order_id}/media/{media_id}\n@desc Get Media Info\n@required {order_id: str # The ID of the order., media_id: str # The ID of the media file.}\n@returns(200) {media_id: str, name: str, content_type: str, language: any, signed_url: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/productions/orders/{order_id}/items\n@desc Upsert Order Item\n@required {order_id: str # The ID of the order., request: map{item!: any, item_id: any}}\n@returns(200) {item_id: str, quote: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/productions/orders/{order_id}/items/{item_id}\n@desc Remove Order Item\n@required {order_id: str # The ID of the order., item_id: str # The ID of the order item.}\n@returns(200) {success: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/productions/orders/{order_id}/submit\n@desc Submit Order\n@required {order_id: str # The ID of the order.}\n@returns(200) {order_id: str, state: str, submitted_at: str(date-time)} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/productions/orders/{order_id}/deliverables\n@desc Get Order Deliverables\n@required {order_id: str # The ID of the order.}\n@returns(200) {deliverables: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/productions/orders/languages/{order_item_kind}\n@desc Get Available Languages\n@required {order_item_kind: str # The kind of order item.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group voices\n@endpoint POST /v1/voices/pvc\n@desc Create Pvc Voice\n@required {name: str # The name that identifies this voice. This will be displayed in the dropdown of the website., language: str # Language used in the samples.}\n@optional {description: any # Description to use for the created voice., labels: any # Labels for the voice. Keys can be language, accent, gender, or age.}\n@returns(200) {voice_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/voices/pvc/{voice_id}\n@desc Edit Pvc Voice\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.}\n@optional {name: str # The name that identifies this voice. This will be displayed in the dropdown of the website., language: str # Language used in the samples., description: any # Description to use for the created voice., labels: any # Labels for the voice. Keys can be language, accent, gender, or age.}\n@returns(200) {voice_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/voices/pvc/{voice_id}/samples\n@desc Add Samples To Pvc Voice\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/voices/pvc/{voice_id}/samples/{sample_id}\n@desc Update Pvc Voice Sample\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices., sample_id: str # Sample ID to be used}\n@optional {remove_background_noise: bool=false # If set will remove background noise for voice samples using our audio isolation model. If the samples do not include background noise, it can make the quality worse., selected_speaker_ids: any # Speaker IDs to be used for PVC training. Make sure you send all the speaker IDs you want to use for PVC training in one request because the last request will override the previous ones., trim_start_time: any # The start time of the audio to be used for PVC training. Time should be in milliseconds, trim_end_time: any # The end time of the audio to be used for PVC training. Time should be in milliseconds, file_name: any # The name of the audio file to be used for PVC training.}\n@returns(200) {voice_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/voices/pvc/{voice_id}/samples/{sample_id}\n@desc Delete Pvc Voice Sample\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices., sample_id: str # Sample ID to be used}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/voices/pvc/{voice_id}/samples/{sample_id}/audio\n@desc Retrieve Voice Sample Audio\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices., sample_id: str # Sample ID to be used}\n@optional {remove_background_noise: bool=false # If set will remove background noise for voice samples using our audio isolation model. If the samples do not include background noise, it can make the quality worse.}\n@returns(200) {audio_base_64: str, voice_id: str, sample_id: str, media_type: str, duration_secs: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/voices/pvc/{voice_id}/samples/{sample_id}/waveform\n@desc Retrieve Voice Sample Visual Waveform\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices., sample_id: str # Sample ID to be used}\n@returns(200) {sample_id: str, visual_waveform: [num]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/voices/pvc/{voice_id}/samples/{sample_id}/speakers\n@desc Retrieve Speaker Separation Status\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices., sample_id: str # Sample ID to be used}\n@returns(200) {voice_id: str, sample_id: str, status: str, speakers: any, selected_speaker_ids: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/voices/pvc/{voice_id}/samples/{sample_id}/separate-speakers\n@desc Start Speaker Separation\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices., sample_id: str # Sample ID to be used}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/voices/pvc/{voice_id}/samples/{sample_id}/speakers/{speaker_id}/audio\n@desc Retrieve Separated Speaker Audio\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices., sample_id: str # Sample ID to be used, speaker_id: str # Speaker ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/{voice_id}/samples/{sample_id}/speakers to list all the available speakers for a sample.}\n@returns(200) {audio_base_64: str, media_type: str, duration_secs: num} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/voices/pvc/{voice_id}/captcha\n@desc Get Pvc Voice Captcha\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/voices/pvc/{voice_id}/captcha\n@desc Verify Pvc Voice Captcha\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/voices/pvc/{voice_id}/train\n@desc Run Pvc Training\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.}\n@optional {model_id: any # The model ID to use for the conversion.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/voices/pvc/{voice_id}/verification\n@desc Request Manual Verification\n@required {voice_id: str # Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.}\n@returns(200) {status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group flows\n@endpoint POST /v1/flows/video\n@desc Create Video Generation\n@returns(200) {id: str, status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/flows/video\n@desc List Video Generations\n@optional {cursor: any # Pagination cursor: the `next_cursor` value of the previous page's response. Omit it for the first page., page_size: int=30 # How many generations to return per page., status: any # Only return generations with this lifecycle status., model_id: any # Only return generations of this model.}\n@returns(200) {generations: [any], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/flows/video/{generation_id}\n@desc Get Video Generation\n@required {generation_id: str}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/flows/image\n@desc Create Image Generation\n@returns(200) {id: str, status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/flows/image\n@desc List Image Generations\n@optional {cursor: any # Pagination cursor: the `next_cursor` value of the previous page's response. Omit it for the first page., page_size: int=30 # How many generations to return per page., status: any # Only return generations with this lifecycle status., model_id: any # Only return generations of this model.}\n@returns(200) {generations: [any], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/flows/image/{generation_id}\n@desc Get Image Generation\n@required {generation_id: str}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/flows/text-to-speech\n@desc Create Speech Generation\n@returns(200) {id: str, status: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/flows/text-to-speech\n@desc List Speech Generations\n@optional {cursor: any # Pagination cursor: the `next_cursor` value of the previous page's response. Omit it for the first page., page_size: int=30 # How many generations to return per page., status: any # Only return generations with this lifecycle status., model_id: any # Only return generations of this model.}\n@returns(200) {generations: [any], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/flows/text-to-speech/{generation_id}\n@desc Get Speech Generation\n@required {generation_id: str}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/flows/templates/{template_id}/runs\n@desc Create Template Run\n@required {template_id: str # The ID of the template, as shown in the ElevenLabs app or by `GET /v1/flows/templates`., inputs: map # Input values keyed by input port id. Every input port of the version being run must be given; a missing or unknown id is rejected. Pass `{}` for a template with no inputs.}\n@optional {version_id: any # The template snapshot to run. Pass a specific version id to pin that snapshot, or `latest` (the default when omitted) to run the template's most recently published version. Only published versions can be pinned, except by the template's owner, who may also pin an unpublished saved snapshot to try it out before publishing. The live draft is never run through this API., webhook: any # Include to send the run's result to the workspace's configured flows webhooks once the run's `status` reaches `completed` or `failed`. One event for the whole run: the `flows_template_run` event's `data` matches the terminal response of `GET /v1/flows/templates/{template_id}/runs/{run_id}`.}\n@returns(200) {id: str, template_id: str, version_id: str, status: str, outputs: map} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/flows/templates/{template_id}/runs\n@desc List Template Runs\n@required {template_id: str # The ID of the template, as shown in the ElevenLabs app or by `GET /v1/flows/templates`.}\n@optional {cursor: any # Pagination cursor: the `next_cursor` value of the previous page's response. Omit it for the first page., page_size: int=30 # How many runs to return per page., version_id: any # Only return runs of this template version id.}\n@returns(200) {runs: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/flows/templates/{template_id}/runs/{run_id}\n@desc Get Template Run\n@required {template_id: str # The ID of the template, as shown in the ElevenLabs app or by `GET /v1/flows/templates`., run_id: str}\n@returns(200) {id: str, template_id: str, version_id: str, status: str, outputs: map} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/flows/templates\n@desc List Templates\n@optional {cursor: any # Pagination cursor: the `next_cursor` value of the previous page's response. Omit it for the first page., page_size: int=10 # How many templates to return per page. Lower than the run list's ceiling because each row expands its versions' input and output schemas., versions_per_template: int=3 # How many of each template's published versions to return, newest first. `has_more_versions` tells you when a template has more., search: any # Only return templates whose name or description contains this text.}\n@returns(200) {templates: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/flows/templates/{template_id}\n@desc Get Template\n@required {template_id: str # The ID of the template, as shown in the ElevenLabs app or by `GET /v1/flows/templates`.}\n@optional {versions_per_template: int=10 # How many of each template's published versions to return, newest first. `has_more_versions` tells you when a template has more.}\n@returns(200) {id: str, name: str, description: any, versions: [map], has_more_versions: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group assets\n@endpoint POST /v1/assets\n@desc Upload Asset\n@returns(200) {asset_id: str, name: str, mime_type: str, created_at_unix: int, content_url: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/assets\n@desc List Assets\n@optional {page_size: int=30 # Number of assets to return., cursor: any # Token from a previous response's `next_cursor`. Omit to fetch the first page., search: any # Optional free-text search filter over asset names.}\n@returns(200) {assets: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/assets/{asset_id}\n@desc Get Asset\n@required {asset_id: str # ID of the asset.}\n@returns(200) {asset_id: str, name: str, mime_type: str, created_at_unix: int, content_url: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/assets/{asset_id}\n@desc Delete Asset\n@required {asset_id: str # ID of the asset.}\n@returns(204) Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group workspace\n@endpoint POST /v1/workspace/analytics/query/usage-by-product-over-time\n@desc Get Workspace Usage\n@required {start_time: int # Start of the time range as a Unix timestamp in milliseconds. Must be at least 2020-01-01., end_time: int # End of the time range as a Unix timestamp in milliseconds. Must be at least 2020-01-01.}\n@optional {interval_seconds: int=60 # Bucket size in seconds. Each row in the response covers this many seconds of the selected time range. For example, pass 3600 for hourly buckets, 86400 for daily buckets, or 604800 for weekly buckets. Whether `time_zone` shifts bucket boundaries depends on this value: week multiples (e.g. 604800) are calendar weeks that start Monday at local midnight; whole-day multiples that are not whole weeks (e.g. 86400) align to local midnight; whole-hour multiples up to 24 hours (e.g. 3600, 14400) align to local hour boundaries from midnight; sub-hour values and other sizes remain UTC-anchored regardless of `time_zone`., group_by: any, filters: any, time_zone: str=UTC # IANA time zone identifier (e.g. 'America/New_York', 'Europe/London', 'UTC') used to align bucket boundaries for eligible `interval_seconds` values. Week multiples (e.g. 604800) are calendar weeks that start Monday at local midnight. Whole-day multiples that are not whole weeks start at local midnight; whole-hour multiples up to 24 hours align to local hour boundaries from midnight. Sub-hour intervals and other bucket sizes remain UTC-anchored regardless of this setting. Defaults to UTC.}\n@returns(200) {columns: [str], column_types: [str], rows: [[any]], column_units: [any]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/workspace/analytics/usage\n@desc Get Workspace Cost Usage\n@required {start_time: int # Start of the time range as a Unix timestamp in milliseconds. Must be at least 2020-01-01., end_time: int # End of the time range as a Unix timestamp in milliseconds. Must be at least 2020-01-01., interval_seconds: int # Bucket size in seconds, in whole UTC days. Pass 86400 for daily buckets or 604800 for weekly buckets, which start on Monday.}\n@optional {group_by: any, filters: any}\n@returns(200) {columns: [str], column_types: [str], rows: [[any]], column_units: [any]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/workspace/analytics/requests\n@desc List Api Requests\n@optional {start_time: any # Start of the time range as a Unix timestamp in milliseconds., end_time: any # End of the time range as a Unix timestamp in milliseconds., limit: int=100, sort: any # Optional timestamp sort direction. If omitted, defaults to desc when end_time is provided, otherwise asc., filters: any, search: any}\n@returns(200) {columns: [str], column_types: [str], rows: [[any]], column_units: [any]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/workspace/webhooks/{webhook_id}/test\n@desc Send Test Webhook Event\n@required {webhook_id: str # The ID of the webhook., webhook_type: str(project_conversion_status/chapter_conversion_status/post_call_transcription/post_call_transcription_otel/post_call_audio/post_call_unredacted_transcription/post_call_unredacted_transcription_otel/post_call_unredacted_audio/post_call_analysis/call_initiation_failure/conversation_initiation_client_data/answering_machine_detection/voice_removal_notice/voice_removal_notice_withdrawn/voice_removed/speech_to_text_transcription/webhook_error/speech_to_text_batch/agent_qa_evaluation_completed/convai_alerting_notification/flows_generation/flows_template_run/dubbing_project_ready/dubbing_project_failed/dubbing_language_completed/dubbing_language_failed/support_ticket_message_added)}\n@returns(200) {delivery_id: str, outcome: str, response_code: any, latency_ms: any, response_content_type: any, response_body_bytes: any, failure_origin: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/workspace/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliver\n@desc Redeliver Webhook Delivery\n@required {webhook_id: str # The ID of the webhook., delivery_id: str # The ID of the delivery to send again.}\n@returns(200) {delivery_id: str, outcome: str, response_code: any, latency_ms: any, response_content_type: any, response_body_bytes: any, failure_origin: any} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group reception\n@endpoint GET /v1/reception/services\n@desc Get All Services\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@optional {staff_id: any # Only services this staff member performs., asset_id: any # Only services that book this asset., is_active: any # Only active (`true`) or inactive (`false`) services., kind: any # Only services of this kind.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/services\n@desc Create Service\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on., name: str}\n@optional {pricing_mode: str(fixed/quote)=fixed # Whether a catalog item's price and duration are known up front.  - `fixed`: the catalog price and duration apply (the default). - `quote`: neither is known until the owner has seen the job. The   receptionist collects intake answers and files a quote request instead   of booking a slot or taking an order., intake_questions: [map{id: str, label!: str, kind: str, options: [str], required: bool, is_active: bool}] # Questions the agent asks before booking or ordering this item. Required for a useful `pricing_mode='quote'` item -- without them a quote request arrives with nothing to price -- but also valid on fixed-price items that need extra detail (current hair color before a dye job, allergies before a treatment)., groups: [map{label!: str, rank: int}] # Group memberships for this item. Each entry carries the group label and the item's 0-based rank within that group., ungrouped_rank: any # Display position among items with no group; `null` sorts last. Change it with the reorder endpoint., description: str, variants: [map{id: str, duration_minutes!: int, price: any, is_active: bool}] # Bookable options for this service. Always non-empty; `variants[0]` is the default option shown when callers don't pick a specific variant. Each entry has its own duration and (optional) price, and uniqueness is keyed by duration., kind: str(classic/rental/group)=classic # What a service books.  - `classic`: a staff-delivered service (haircut, consultation, massage, ...). - `rental`: an asset reservation (court, room, equipment). - `group`: seats in a multi-participant session (class, workshop, tour)., buffer_minutes: int=0 # Turnover/cleanup time reserved after each booking. Applies to every service kind; default 0 means no buffer., service_location: str(business/customer)=business # Where a classic service is delivered., add_ons: [map{id: str, name!: str, description: str, add_duration_minutes: int, add_price: num}] # Optional extras that can be added to a booking of this service., max_participants: any # Capacity for `kind='group'`: how many seats a single session can sell across all registrations. Must be null for classic and rental services (those are always exclusive to one client per booking)., capacity: any # Not used to limit bookings; set `max_participants` on group services instead., is_active: bool=true # Whether the service is offered; inactive services can't be booked., any_staff_member: bool=true # Whether any staff member can deliver the service. When false, only the staff in `staff_ids` can. Ignored for rentals., staff_ids: [str] # Staff assigned to this service; must be empty for kind='rental'., asset_ids: [str] # Assets, such as rooms or equipment, this service can be booked on., advance_booking_minutes: int=1440 # How far into the future customer-facing channels (public booking page, voice agent) may book this service. Applies to every kind., location_ids: [str] # Locations where this service is offered; empty list means all locations., display_on_booking_page: bool=true # Whether the service is listed on the public booking page., travel_minutes: int=0 # Travel time in minutes added before/after appointments for customer-location services. Blocks the staff member's calendar but is not visible to the customer. Ignored when `service_location='business'`., travel_before: bool=true # Add travel time before the appointment (outbound trip)., travel_after: bool=true # Add travel time after the appointment (return trip)., promotions: [map{id: str, name!: str, target: str, variant_id: any, add_on_id: any, promotional_price!: num, days_of_week: [int], start_date!: str(date), end_date!: str(date), is_active: bool}] # Time-bound discounts applicable to this service or specific variants.}\n@returns(200) {pricing_mode: str, intake_questions: [map], groups: [map], ungrouped_rank: any, name: str, description: str, variants: [map], kind: str, buffer_minutes: int, service_location: str, add_ons: [map], max_participants: any, capacity: any, is_active: bool, any_staff_member: bool, staff_ids: [str], asset_ids: [str], advance_booking_minutes: int, location_ids: [str], display_on_booking_page: bool, travel_minutes: int, travel_before: bool, travel_after: bool, promotions: [map], id: str, created_at_unix: int, updated_at_unix: int, duration_minutes: int, price: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/services/{service_id}\n@desc Get Service\n@required {service_id: str # ID of the service. Returned when you create one; list them with `GET /v1/reception/services`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) {pricing_mode: str, intake_questions: [map], groups: [map], ungrouped_rank: any, name: str, description: str, variants: [map], kind: str, buffer_minutes: int, service_location: str, add_ons: [map], max_participants: any, capacity: any, is_active: bool, any_staff_member: bool, staff_ids: [str], asset_ids: [str], advance_booking_minutes: int, location_ids: [str], display_on_booking_page: bool, travel_minutes: int, travel_before: bool, travel_after: bool, promotions: [map], id: str, created_at_unix: int, updated_at_unix: int, duration_minutes: int, price: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PUT /v1/reception/services/{service_id}\n@desc Update Service\n@required {service_id: str # ID of the service. Returned when you create one; list them with `GET /v1/reception/services`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@optional {pricing_mode: str(fixed/quote)=fixed # Whether a catalog item's price and duration are known up front.  - `fixed`: the catalog price and duration apply (the default). - `quote`: neither is known until the owner has seen the job. The   receptionist collects intake answers and files a quote request instead   of booking a slot or taking an order., intake_questions: [map{id: str, label!: str, kind: str, options: [str], required: bool, is_active: bool}] # Questions the agent asks before booking or ordering this item. Required for a useful `pricing_mode='quote'` item -- without them a quote request arrives with nothing to price -- but also valid on fixed-price items that need extra detail (current hair color before a dye job, allergies before a treatment)., groups: [map{label!: str, rank: int}] # Group memberships for this item. Each entry carries the group label and the item's 0-based rank within that group., ungrouped_rank: any # Display position among items with no group; `null` sorts last. Change it with the reorder endpoint., name: str, description: str, variants: [map{id: str, duration_minutes!: int, price: any, is_active: bool}] # Bookable options for this service. Always non-empty; `variants[0]` is the default option shown when callers don't pick a specific variant. Each entry has its own duration and (optional) price, and uniqueness is keyed by duration., kind: str(classic/rental/group)=classic # What a service books.  - `classic`: a staff-delivered service (haircut, consultation, massage, ...). - `rental`: an asset reservation (court, room, equipment). - `group`: seats in a multi-participant session (class, workshop, tour)., buffer_minutes: int # Turnover/cleanup time reserved after each booking. Applies to every service kind; default 0 means no buffer., service_location: str(business/customer)=business # Where a classic service is delivered., add_ons: [map{id: str, name!: str, description: str, add_duration_minutes: int, add_price: num}] # Optional extras that can be added to a booking of this service., max_participants: any # Capacity for `kind='group'`: how many seats a single session can sell across all registrations. Must be null for classic and rental services (those are always exclusive to one client per booking)., capacity: any # Not used to limit bookings; set `max_participants` on group services instead., is_active: bool # Whether the service is offered; inactive services can't be booked., any_staff_member: bool # Whether any staff member can deliver the service. When false, only the staff in `staff_ids` can. Ignored for rentals., staff_ids: [str] # Staff assigned to this service; must be empty for kind='rental'., asset_ids: [str] # Assets, such as rooms or equipment, this service can be booked on., advance_booking_minutes: int # How far into the future customer-facing channels (public booking page, voice agent) may book this service. Applies to every kind., location_ids: [str] # Locations where this service is offered; empty list means all locations., display_on_booking_page: bool # Whether the service is listed on the public booking page., travel_minutes: int # Travel time in minutes added before/after appointments for customer-location services. Blocks the staff member's calendar but is not visible to the customer. Ignored when `service_location='business'`., travel_before: bool # Add travel time before the appointment (outbound trip)., travel_after: bool # Add travel time after the appointment (return trip)., promotions: [map{id: str, name!: str, target: str, variant_id: any, add_on_id: any, promotional_price!: num, days_of_week: [int], start_date!: str(date), end_date!: str(date), is_active: bool}] # Time-bound discounts applicable to this service or specific variants., duration_minutes: any # Sets the first variant's duration. Ignored when `variants` is sent., price: any # Sets the first variant's price. Ignored when `variants` is sent.}\n@returns(200) {service: any, has_affected_events: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/reception/services/{service_id}\n@desc Delete Service\n@required {service_id: str # ID of the service. Returned when you create one; list them with `GET /v1/reception/services`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/services/{service_id}/confirm-update\n@desc Confirm Service Update\n@required {service_id: str # ID of the service. Returned when you create one; list them with `GET /v1/reception/services`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@optional {reprice: bool=false # Also update the price on the service's future bookings., pricing_mode: str(fixed/quote)=fixed # Whether a catalog item's price and duration are known up front.  - `fixed`: the catalog price and duration apply (the default). - `quote`: neither is known until the owner has seen the job. The   receptionist collects intake answers and files a quote request instead   of booking a slot or taking an order., intake_questions: [map{id: str, label!: str, kind: str, options: [str], required: bool, is_active: bool}] # Questions the agent asks before booking or ordering this item. Required for a useful `pricing_mode='quote'` item -- without them a quote request arrives with nothing to price -- but also valid on fixed-price items that need extra detail (current hair color before a dye job, allergies before a treatment)., groups: [map{label!: str, rank: int}] # Group memberships for this item. Each entry carries the group label and the item's 0-based rank within that group., ungrouped_rank: any # Display position among items with no group; `null` sorts last. Change it with the reorder endpoint., name: str, description: str, variants: [map{id: str, duration_minutes!: int, price: any, is_active: bool}] # Bookable options for this service. Always non-empty; `variants[0]` is the default option shown when callers don't pick a specific variant. Each entry has its own duration and (optional) price, and uniqueness is keyed by duration., kind: str(classic/rental/group)=classic # What a service books.  - `classic`: a staff-delivered service (haircut, consultation, massage, ...). - `rental`: an asset reservation (court, room, equipment). - `group`: seats in a multi-participant session (class, workshop, tour)., buffer_minutes: int # Turnover/cleanup time reserved after each booking. Applies to every service kind; default 0 means no buffer., service_location: str(business/customer)=business # Where a classic service is delivered., add_ons: [map{id: str, name!: str, description: str, add_duration_minutes: int, add_price: num}] # Optional extras that can be added to a booking of this service., max_participants: any # Capacity for `kind='group'`: how many seats a single session can sell across all registrations. Must be null for classic and rental services (those are always exclusive to one client per booking)., capacity: any # Not used to limit bookings; set `max_participants` on group services instead., is_active: bool # Whether the service is offered; inactive services can't be booked., any_staff_member: bool # Whether any staff member can deliver the service. When false, only the staff in `staff_ids` can. Ignored for rentals., staff_ids: [str] # Staff assigned to this service; must be empty for kind='rental'., asset_ids: [str] # Assets, such as rooms or equipment, this service can be booked on., advance_booking_minutes: int # How far into the future customer-facing channels (public booking page, voice agent) may book this service. Applies to every kind., location_ids: [str] # Locations where this service is offered; empty list means all locations., display_on_booking_page: bool # Whether the service is listed on the public booking page., travel_minutes: int # Travel time in minutes added before/after appointments for customer-location services. Blocks the staff member's calendar but is not visible to the customer. Ignored when `service_location='business'`., travel_before: bool # Add travel time before the appointment (outbound trip)., travel_after: bool # Add travel time after the appointment (return trip)., promotions: [map{id: str, name!: str, target: str, variant_id: any, add_on_id: any, promotional_price!: num, days_of_week: [int], start_date!: str(date), end_date!: str(date), is_active: bool}] # Time-bound discounts applicable to this service or specific variants., duration_minutes: any # Sets the first variant's duration. Ignored when `variants` is sent., price: any # Sets the first variant's price. Ignored when `variants` is sent.}\n@returns(200) {service: any, has_affected_events: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/assets\n@desc Get All Assets\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/assets\n@desc Create Asset\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on., name: str}\n@optional {groups: [map{label!: str, rank: int}] # Group memberships for this item. Each entry carries the group label and the item's 0-based rank within that group., ungrouped_rank: any # Display position among items with no group; `null` sorts last. Change it with the reorder endpoint., description: str, is_active: bool=true # Whether the asset can be booked. Inactive assets keep their booking history., available_hours: any # Custom availability hours for this asset. Null means follow the assigned location's operating_hours (requires location_id)., photo_url: any # URL of a photo of the asset., location_id: any # Location this asset belongs to; empty means available at all locations., customer_facing_name: str}\n@returns(200) {groups: [map], ungrouped_rank: any, name: str, description: str, is_active: bool, available_hours: any, photo_url: any, location_id: any, customer_facing_name: str, id: str, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/assets/{asset_id}\n@desc Get Asset\n@required {asset_id: str # ID of the asset. Returned when you create one; list them with `GET /v1/reception/assets`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) {groups: [map], ungrouped_rank: any, name: str, description: str, is_active: bool, available_hours: any, photo_url: any, location_id: any, customer_facing_name: str, id: str, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PUT /v1/reception/assets/{asset_id}\n@desc Update Asset\n@required {asset_id: str # ID of the asset. Returned when you create one; list them with `GET /v1/reception/assets`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@optional {groups: [map{label!: str, rank: int}] # Group memberships for this item. Each entry carries the group label and the item's 0-based rank within that group., ungrouped_rank: any # Display position among items with no group; `null` sorts last. Change it with the reorder endpoint., name: str, description: str, is_active: bool # Whether the asset can be booked. Inactive assets keep their booking history., available_hours: any # Custom availability hours for this asset. Null means follow the assigned location's operating_hours (requires location_id)., photo_url: any # URL of a photo of the asset., location_id: any # Location this asset belongs to; empty means available at all locations., customer_facing_name: str}\n@returns(200) {groups: [map], ungrouped_rank: any, name: str, description: str, is_active: bool, available_hours: any, photo_url: any, location_id: any, customer_facing_name: str, id: str, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/reception/assets/{asset_id}\n@desc Delete Asset\n@required {asset_id: str # ID of the asset. Returned when you create one; list them with `GET /v1/reception/assets`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/products\n@desc Get All Products\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@optional {group: any # Only products filed under the group with this label., is_active: any # Only active (`true`) or inactive (`false`) products.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/products\n@desc Create Product\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on., name: str}\n@optional {pricing_mode: str(fixed/quote)=fixed # Whether a catalog item's price and duration are known up front.  - `fixed`: the catalog price and duration apply (the default). - `quote`: neither is known until the owner has seen the job. The   receptionist collects intake answers and files a quote request instead   of booking a slot or taking an order., intake_questions: [map{id: str, label!: str, kind: str, options: [str], required: bool, is_active: bool}] # Questions the agent asks before booking or ordering this item. Required for a useful `pricing_mode='quote'` item -- without them a quote request arrives with nothing to price -- but also valid on fixed-price items that need extra detail (current hair color before a dye job, allergies before a treatment)., groups: [map{label!: str, rank: int}] # Group memberships for this item. Each entry carries the group label and the item's 0-based rank within that group., ungrouped_rank: any # Display position among items with no group; `null` sorts last. Change it with the reorder endpoint., description: str, price: any # Price of the product; null for no listed price., is_active: bool=true # False hides the product without deleting it., orderable: bool=true # False keeps the product listed (callers can ask about it) but not orderable., allowed_fulfillment_types: [str] # Fulfillment options customers may choose when ordering this product., location_ids: [str] # Locations where this product is sold; empty list means all locations., track_quantity: bool=false # Whether this product is counted. A counted product starts with nothing on hand at every location.}\n@returns(200) {pricing_mode: str, intake_questions: [map], groups: [map], ungrouped_rank: any, name: str, description: str, price: any, is_active: bool, orderable: bool, allowed_fulfillment_types: [str], location_ids: [str], stock: any, id: str, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/products/{product_id}\n@desc Get Product\n@required {product_id: str # ID of the product. Returned when you create one; list them with `GET /v1/reception/products`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) {pricing_mode: str, intake_questions: [map], groups: [map], ungrouped_rank: any, name: str, description: str, price: any, is_active: bool, orderable: bool, allowed_fulfillment_types: [str], location_ids: [str], stock: any, id: str, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PUT /v1/reception/products/{product_id}\n@desc Update Product\n@required {product_id: str # ID of the product. Returned when you create one; list them with `GET /v1/reception/products`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@optional {pricing_mode: str(fixed/quote)=fixed # Whether a catalog item's price and duration are known up front.  - `fixed`: the catalog price and duration apply (the default). - `quote`: neither is known until the owner has seen the job. The   receptionist collects intake answers and files a quote request instead   of booking a slot or taking an order., intake_questions: [map{id: str, label!: str, kind: str, options: [str], required: bool, is_active: bool}] # Questions the agent asks before booking or ordering this item. Required for a useful `pricing_mode='quote'` item -- without them a quote request arrives with nothing to price -- but also valid on fixed-price items that need extra detail (current hair color before a dye job, allergies before a treatment)., groups: [map{label!: str, rank: int}] # Group memberships for this item. Each entry carries the group label and the item's 0-based rank within that group., ungrouped_rank: any # Display position among items with no group; `null` sorts last. Change it with the reorder endpoint., name: str, description: str, price: any # Price of the product; null for no listed price., is_active: bool # False hides the product without deleting it., orderable: bool # False keeps the product listed (callers can ask about it) but not orderable., allowed_fulfillment_types: [str] # Fulfillment options customers may choose when ordering this product., location_ids: [str] # Locations where this product is sold; empty list means all locations., track_quantity: bool # Whether this product is counted. Switching it only changes the mode: turning it on keeps whatever is already on hand, turning it off drops the counts. Use the stock endpoints to change the amounts themselves.}\n@returns(200) {pricing_mode: str, intake_questions: [map], groups: [map], ungrouped_rank: any, name: str, description: str, price: any, is_active: bool, orderable: bool, allowed_fulfillment_types: [str], location_ids: [str], stock: any, id: str, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/reception/products/{product_id}\n@desc Delete Product\n@required {product_id: str # ID of the product. Returned when you create one; list them with `GET /v1/reception/products`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/reception/products/{product_id}/stock\n@desc Update Product Stock\n@required {product_id: str # ID of the product. Returned when you create one; list them with `GET /v1/reception/products`., xi-workspace-id: str # The customer workspace a reseller's API key acts on., location_id: str # Location whose count is set., on_hand: int # The new on-hand quantity., expected_on_hand: int # On-hand value the caller last saw. The write is rejected with a 409 if it no longer matches, so a sale made while the caller was editing is never overwritten.}\n@returns(200) {pricing_mode: str, intake_questions: [map], groups: [map], ungrouped_rank: any, name: str, description: str, price: any, is_active: bool, orderable: bool, allowed_fulfillment_types: [str], location_ids: [str], stock: any, id: str, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/products/{product_id}/stock/adjust\n@desc Adjust Product Stock\n@required {product_id: str # ID of the product. Returned when you create one; list them with `GET /v1/reception/products`., xi-workspace-id: str # The customer workspace a reseller's API key acts on., location_id: str # Location whose count changes., delta: int # Signed change to apply to on-hand. Prefer this over an absolute write whenever the intent is 'a few more/fewer'.}\n@returns(200) {pricing_mode: str, intake_questions: [map], groups: [map], ungrouped_rank: any, name: str, description: str, price: any, is_active: bool, orderable: bool, allowed_fulfillment_types: [str], location_ids: [str], stock: any, id: str, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/staff\n@desc Get All Staff\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/staff\n@desc Create Staff Member\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on., name: str}\n@optional {groups: [map{label!: str, rank: int}] # Group memberships for this item. Each entry carries the group label and the item's 0-based rank within that group., ungrouped_rank: any # Display position among items with no group; `null` sorts last. Change it with the reorder endpoint., description: str, is_active: bool=true # Whether the staff member can be booked. Inactive staff keep their booking history., email: str= # Email address of the staff member., phone: str, sms_notifications_opted_in: bool=false # Whether this staff member currently receives SMS booking notifications. Defaults to opted out — a staff member must be explicitly opted in; flipped to False automatically when they reply STOP to the workspace number., photo_url: any # URL of a photo of the staff member., location_id: any # Location this staff member is assigned to; empty means available at all locations., working_hours: any # Custom working hours for this staff member. Null means follow the assigned location's operating_hours (requires location_id)., display_on_booking_page: bool=true # Whether customers can see and pick this staff member by name on the booking page. False keeps them bookable, just not shown by name., customer_facing_name: str}\n@returns(200) {groups: [map], ungrouped_rank: any, name: str, description: str, is_active: bool, email: str, phone: str, sms_notifications_opted_in: bool, photo_url: any, location_id: any, working_hours: any, display_on_booking_page: bool, customer_facing_name: str, id: str, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/staff/{staff_id}\n@desc Get Staff Member\n@required {staff_id: str # ID of the staff member. Returned when you create one; list them with `GET /v1/reception/staff`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) {groups: [map], ungrouped_rank: any, name: str, description: str, is_active: bool, email: str, phone: str, sms_notifications_opted_in: bool, photo_url: any, location_id: any, working_hours: any, display_on_booking_page: bool, customer_facing_name: str, id: str, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PUT /v1/reception/staff/{staff_id}\n@desc Update Staff Member\n@required {staff_id: str # ID of the staff member. Returned when you create one; list them with `GET /v1/reception/staff`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@optional {groups: [map{label!: str, rank: int}] # Group memberships for this item. Each entry carries the group label and the item's 0-based rank within that group., ungrouped_rank: any # Display position among items with no group; `null` sorts last. Change it with the reorder endpoint., name: str, description: str, is_active: bool # Whether the staff member can be booked. Inactive staff keep their booking history., email: str # Email address of the staff member., phone: str, sms_notifications_opted_in: bool # Whether this staff member currently receives SMS booking notifications. Defaults to opted out — a staff member must be explicitly opted in; flipped to False automatically when they reply STOP to the workspace number., photo_url: any # URL of a photo of the staff member., location_id: any # Location this staff member is assigned to; empty means available at all locations., working_hours: any # Custom working hours for this staff member. Null means follow the assigned location's operating_hours (requires location_id)., display_on_booking_page: bool # Whether customers can see and pick this staff member by name on the booking page. False keeps them bookable, just not shown by name., customer_facing_name: str}\n@returns(200) {groups: [map], ungrouped_rank: any, name: str, description: str, is_active: bool, email: str, phone: str, sms_notifications_opted_in: bool, photo_url: any, location_id: any, working_hours: any, display_on_booking_page: bool, customer_facing_name: str, id: str, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/reception/staff/{staff_id}\n@desc Delete Staff Member\n@required {staff_id: str # ID of the staff member. Returned when you create one; list them with `GET /v1/reception/staff`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/customer-facing-agents\n@desc List Receptionists\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/reception/customer-facing-agents/{agent_id}\n@desc Update Receptionist\n@required {agent_id: str # ID of the receptionist. List them with `GET /v1/reception/customer-facing-agents`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@optional {config: any # Receptionist settings to change; omitted settings keep their value., name: any # New display name for the receptionist., widget: any # New website widget appearance.}\n@returns(200) {agent_id: str, config: map{additional_instructions: str, tone_traits: [str], details_to_collect: [str], llm: any, reasoning_effort: any, disable_rag: bool, background_voice_detection: bool, turn_eagerness: str, voice_id: str, language: str, additional_languages: [str], first_message: str, disable_first_message_interruptions: bool, enable_end_call_tool: bool, enable_skip_turn_tool: bool, enable_play_keypad_touch_tone_tool: bool, agent_rules: [map], transfer_rules: [map], hide_caller_number_on_transfers: bool, record_after_transfers: bool, procedures: [map], enable_secure_mode: bool, enable_spam_protection: bool}, deactivated_at_unix: any, deactivation_reason: any, name: str, agent_exists: bool, is_transfer_allowed: bool, widget: any, is_active: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/customer-facing-agents/{agent_id}/activate\n@desc Activate Receptionist\n@required {agent_id: str # ID of the receptionist. List them with `GET /v1/reception/customer-facing-agents`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) {agent_id: str, config: map{additional_instructions: str, tone_traits: [str], details_to_collect: [str], llm: any, reasoning_effort: any, disable_rag: bool, background_voice_detection: bool, turn_eagerness: str, voice_id: str, language: str, additional_languages: [str], first_message: str, disable_first_message_interruptions: bool, enable_end_call_tool: bool, enable_skip_turn_tool: bool, enable_play_keypad_touch_tone_tool: bool, agent_rules: [map], transfer_rules: [map], hide_caller_number_on_transfers: bool, record_after_transfers: bool, procedures: [map], enable_secure_mode: bool, enable_spam_protection: bool}, deactivated_at_unix: any, deactivation_reason: any, name: str, agent_exists: bool, is_transfer_allowed: bool, widget: any, is_active: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/customer-facing-agents/{agent_id}/rules\n@desc Add Rule\n@required {agent_id: str # ID of the receptionist. List them with `GET /v1/reception/customer-facing-agents`., xi-workspace-id: str # The customer workspace a reseller's API key acts on., title: str, description: str}\n@optional {priority: str(strict/suggestion)=strict # How strictly the receptionist follows a rule.}\n@returns(200) {title: str, description: str, priority: str, id: str, created_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PUT /v1/reception/customer-facing-agents/{agent_id}/rules/{rule_id}\n@desc Update Rule\n@required {agent_id: str # ID of the receptionist. List them with `GET /v1/reception/customer-facing-agents`., rule_id: str # ID of the rule. Returned when you add one, and listed in the receptionist's `config.agent_rules`., xi-workspace-id: str # The customer workspace a reseller's API key acts on., title: str, description: str}\n@optional {priority: str(strict/suggestion)=strict # How strictly the receptionist follows a rule.}\n@returns(200) {title: str, description: str, priority: str, id: str, created_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/reception/customer-facing-agents/{agent_id}/rules/{rule_id}\n@desc Delete Rule\n@required {agent_id: str # ID of the receptionist. List them with `GET /v1/reception/customer-facing-agents`., rule_id: str # ID of the rule. Returned when you add one, and listed in the receptionist's `config.agent_rules`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/customer-facing-agents/{agent_id}/procedures\n@desc List Procedures\n@required {agent_id: str # ID of the receptionist. List them with `GET /v1/reception/customer-facing-agents`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/customer-facing-agents/{agent_id}/procedures\n@desc Add Procedure\n@required {agent_id: str # ID of the receptionist. List them with `GET /v1/reception/customer-facing-agents`., xi-workspace-id: str # The customer workspace a reseller's API key acts on., name: str, trigger: str}\n@optional {body: str= # Step-by-step instructions, as markdown.}\n@returns(201) {name: str, trigger: str, body: str, id: str, created_at_unix: int, source_key: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PUT /v1/reception/customer-facing-agents/{agent_id}/procedures/{procedure_id}\n@desc Update Procedure\n@required {agent_id: str # ID of the receptionist. List them with `GET /v1/reception/customer-facing-agents`., procedure_id: str # ID of the procedure. Returned when you add one; list them with `GET /v1/reception/customer-facing-agents/{agent_id}/procedures`., xi-workspace-id: str # The customer workspace a reseller's API key acts on., name: str, trigger: str}\n@optional {body: str= # Step-by-step instructions, as markdown.}\n@returns(200) {name: str, trigger: str, body: str, id: str, created_at_unix: int, source_key: any} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/reception/customer-facing-agents/{agent_id}/procedures/{procedure_id}\n@desc Delete Procedure\n@required {agent_id: str # ID of the receptionist. List them with `GET /v1/reception/customer-facing-agents`., procedure_id: str # ID of the procedure. Returned when you add one; list them with `GET /v1/reception/customer-facing-agents/{agent_id}/procedures`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/customer-facing-agents/{agent_id}/transfer-rules\n@desc Add Transfer Rule\n@required {agent_id: str # ID of the receptionist. List them with `GET /v1/reception/customer-facing-agents`., xi-workspace-id: str # The customer workspace a reseller's API key acts on., label: str, phone_number: str, condition: str}\n@optional {post_dial_digits: any # DTMF digits automatically played after the transfer destination picks up (e.g. '1' to answer a 'press 1 to accept' screen, or 'www1234' to key an extension after a pause). Valid characters are 0-9, *, #, w (0.5s pause) and W (1s pause). Twilio transfers only.}\n@returns(200) {label: str, phone_number: str, condition: str, post_dial_digits: any, id: str, created_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PUT /v1/reception/customer-facing-agents/{agent_id}/transfer-rules/{rule_id}\n@desc Update Transfer Rule\n@required {agent_id: str # ID of the receptionist. List them with `GET /v1/reception/customer-facing-agents`., rule_id: str # ID of the transfer rule. Returned when you add one, and listed in the receptionist's `config.transfer_rules`., xi-workspace-id: str # The customer workspace a reseller's API key acts on., label: str, phone_number: str, condition: str}\n@optional {post_dial_digits: any # DTMF digits automatically played after the transfer destination picks up (e.g. '1' to answer a 'press 1 to accept' screen, or 'www1234' to key an extension after a pause). Valid characters are 0-9, *, #, w (0.5s pause) and W (1s pause). Twilio transfers only.}\n@returns(200) {label: str, phone_number: str, condition: str, post_dial_digits: any, id: str, created_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/reception/customer-facing-agents/{agent_id}/transfer-rules/{rule_id}\n@desc Delete Transfer Rule\n@required {agent_id: str # ID of the receptionist. List them with `GET /v1/reception/customer-facing-agents`., rule_id: str # ID of the transfer rule. Returned when you add one, and listed in the receptionist's `config.transfer_rules`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/phone-numbers/assignments\n@desc List Phone Numbers\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/phone-numbers/assignments\n@desc Assign Phone Number\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on., customer_facing_agent_id: str # The receptionist that answers calls to the number.}\n@optional {area_codes: any # Preferred US or Canadian area codes, e.g. `[\"415\", \"628\"]`. Codes outside the business's country are ignored, and any number is given when none of these is available., number_type: any # Local or mobile, in a country that requires paperwork before a number takes calls. Leave unset to try mobile first. Ignored in the US and Canada., idempotency_key: any # Client-generated key that makes a retry safe. The same key and body within 24 hours returns the first result without running again. While that first request is still running, a retry gets 409 `idempotency_key_in_progress`; a different body with the same key gets 400 `idempotency_key_reused`. A request that fails is not saved, so it can be retried with the same key.}\n@returns(201) {phone_number: any, is_byo: bool, provider: str, nanp_area_code: int, customer_facing_agent_id: any, deactivated_at_unix: any, deactivation_reason: any, regulatory_status: any, regulatory_number_type: any, regulatory_country: any, id: str, created_at_unix: int, updated_at_unix: int, is_active: bool, accepts_public_calls: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/reception/phone-numbers/assignments/{phone_assignment_id}\n@desc Release Phone Number\n@required {phone_assignment_id: str # ID of the phone number assignment. Returned when you assign a number; list them with `GET /v1/reception/phone-numbers/assignments`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(204) Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/reception/phone-numbers/assignments/{phone_assignment_id}\n@desc Move Phone Number\n@required {phone_assignment_id: str # ID of the phone number assignment. Returned when you assign a number; list them with `GET /v1/reception/phone-numbers/assignments`., xi-workspace-id: str # The customer workspace a reseller's API key acts on., customer_facing_agent_id: str # The receptionist that answers calls to the number from now on.}\n@returns(200) {phone_number: any, is_byo: bool, provider: str, nanp_area_code: int, customer_facing_agent_id: any, deactivated_at_unix: any, deactivation_reason: any, regulatory_status: any, regulatory_number_type: any, regulatory_country: any, id: str, created_at_unix: int, updated_at_unix: int, is_active: bool, accepts_public_calls: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/holidays\n@desc Get All Holidays\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@optional {start_unix: any # Filter entries overlapping from this timestamp, end_unix: any # Filter entries overlapping before this timestamp, time_off_type: any # Filter by type: location, staff, or asset, resource_id: any # Filter by associated resource ID (staff/asset), location_id: any # Filter by location ID}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/holidays\n@desc Create Holiday\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on., name: str # Display name of the closure or time off., start_date: map{year!: int, month!: int, day!: int} # Represents a calendar date as individual numeric components., end_date: map{year!: int, month!: int, day!: int} # Represents a calendar date as individual numeric components., time_off_type: str(staff/asset/location) # What a time-off entry blocks: a staff member, an asset, or a location.}\n@optional {holiday_type: str(closed/override)=closed # Whether the entry closes the target for the whole range or replaces its working hours., override_hours: any # Replacement working hours when holiday_type is 'override'., resource_id: any # The staff member or asset ID; required when time_off_type is 'staff' or 'asset'., location_id: any # For LOCATION type: the location this closure applies to., reason: any # Optional note on why the closure or time off happens, up to 500 characters.}\n@returns(200) {name: str, start_date: map{year: int, month: int, day: int}, end_date: map{year: int, month: int, day: int}, holiday_type: str, override_hours: any, time_off_type: str, resource_id: any, location_id: any, reason: any, id: str, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/holidays/{holiday_id}\n@desc Get Holiday\n@required {holiday_id: str # ID of the holiday or time-off entry. Returned when you create one; list them with `GET /v1/reception/holidays`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) {name: str, start_date: map{year: int, month: int, day: int}, end_date: map{year: int, month: int, day: int}, holiday_type: str, override_hours: any, time_off_type: str, resource_id: any, location_id: any, reason: any, id: str, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PUT /v1/reception/holidays/{holiday_id}\n@desc Update Holiday\n@required {holiday_id: str # ID of the holiday or time-off entry. Returned when you create one; list them with `GET /v1/reception/holidays`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@optional {name: str # Display name of the closure or time off., start_date: map{year!: int, month!: int, day!: int} # Represents a calendar date as individual numeric components., end_date: map{year!: int, month!: int, day!: int} # Represents a calendar date as individual numeric components., holiday_type: str(closed/override)=closed # Whether the entry closes the target for the whole range or replaces its working hours., override_hours: any # Replacement working hours when holiday_type is 'override'., time_off_type: str(staff/asset/location) # What a time-off entry blocks: a staff member, an asset, or a location., resource_id: any # The staff member or asset ID; required when time_off_type is 'staff' or 'asset'., location_id: any # For LOCATION type: the location this closure applies to., reason: any # Optional note on why the closure or time off happens, up to 500 characters.}\n@returns(200) {name: str, start_date: map{year: int, month: int, day: int}, end_date: map{year: int, month: int, day: int}, holiday_type: str, override_hours: any, time_off_type: str, resource_id: any, location_id: any, reason: any, id: str, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/reception/holidays/{holiday_id}\n@desc Delete Holiday\n@required {holiday_id: str # ID of the holiday or time-off entry. Returned when you create one; list them with `GET /v1/reception/holidays`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/locations\n@desc List Locations\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/locations\n@desc Create Location\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on., name: str}\n@optional {address: str, notes: str, operating_hours: any # Per-location operating hours. On create, omit to have the server prefill from the most recently added active location., customer_facing_name: str, max_concurrent_appointments: int=1 # Maximum number of appointments that may overlap at this location at a single instant. Only enforced while the booking page setting concurrent_limit_enabled is on., is_active: bool=true # Whether the location is active. Inactive locations take no bookings.}\n@returns(200) {name: str, address: str, notes: str, operating_hours: map{hours: map, timezone: any}, customer_facing_name: str, max_concurrent_appointments: int, id: str, deactivated_at_unix: any, deactivation_reason: any, is_active: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/locations/{location_id}\n@desc Get Location\n@required {location_id: str # ID of the location. Returned when you create one; list them with `GET /v1/reception/locations`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) {name: str, address: str, notes: str, operating_hours: map{hours: map, timezone: any}, customer_facing_name: str, max_concurrent_appointments: int, id: str, deactivated_at_unix: any, deactivation_reason: any, is_active: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PUT /v1/reception/locations/{location_id}\n@desc Update Location\n@required {location_id: str # ID of the location. Returned when you create one; list them with `GET /v1/reception/locations`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@optional {name: str, address: str, notes: str, operating_hours: any # Per-location operating hours. On create, omit to have the server prefill from the most recently added active location., customer_facing_name: str, max_concurrent_appointments: int # Maximum number of appointments that may overlap at this location at a single instant. Only enforced while the booking page setting concurrent_limit_enabled is on., is_active: bool # Whether the location is active. Inactive locations take no bookings.}\n@returns(200) {name: str, address: str, notes: str, operating_hours: map{hours: map, timezone: any}, customer_facing_name: str, max_concurrent_appointments: int, id: str, deactivated_at_unix: any, deactivation_reason: any, is_active: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/reception/locations/{location_id}\n@desc Delete Location\n@required {location_id: str # ID of the location. Returned when you create one; list them with `GET /v1/reception/locations`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/agent-info\n@desc Get Business Profile\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) {business_name: str, business_country: any, business_description: str, timezone: str(zoneinfo), currency: str, operating_hours: map{hours: map, timezone: any}, tool_call_sound: any, id: str, created_at_unix: int, updated_at_unix: int, workspace_now: map{today: map{year: int, month: int, day: int}, hour: int, minute: int, fetched_at_ms: int}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint PUT /v1/reception/agent-info\n@desc Update Business Profile\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@optional {business_name: str= # Name of the business., business_country: any # ISO 3166-1 alpha-2 country code where the business is based (e.g. 'US', 'PL', 'DE')., business_description: str= # What the business does, given to the receptionist., timezone: str(zoneinfo) # IANA timezone of the business., currency: str(USD/EUR/GBP/PLN/CAD/AUD/CHF/SEK/NOK/DKK/ISK/CZK/HUF/RON/BGN/JPY/CNY/TWD/INR/BRL/MXN/KRW/SGD/HKD/NZD/ZAR/AED/SAR/QAR/KWD/ILS/TRY/THB/IDR/MYR/PHP/VND/BDT/RUB/UAH/CLP/COP/ARS/PEN/EGP/NGN/KES/PKR)=USD # Currency code for all prices (ISO 4217), operating_hours: map{hours: map, timezone: any}, tool_call_sound: any # Ambient sound played while any receptionist runs a tool (e.g. checking availability or looking up a client), filling the silence callers would otherwise hear. One sound for the whole workspace, because custom webhook and MCP tools are shared by every receptionist. Off when null.}\n@returns(200) {business_name: str, business_country: any, business_description: str, timezone: str(zoneinfo), currency: str, operating_hours: map{hours: map, timezone: any}, tool_call_sound: any, id: str, created_at_unix: int, updated_at_unix: int, workspace_now: map{today: map{year: int, month: int, day: int}, hour: int, minute: int, fetched_at_ms: int}} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/knowledge-sources\n@desc List Knowledge Sources\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/knowledge-sources\n@desc Upload Knowledge Source\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) {source_type: str, source_url: any, last_scraped_at_unix: any, original_filename: str, content_type: str, file_size_bytes: int, status: str, error_message: any, failure_reason: any, crawl_entire_site: bool, scraped_pages_count: int, content_preview: any, processing_started_at_unix: any, id: str, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/knowledge-sources/{source_id}\n@desc Get Knowledge Source\n@required {source_id: str # ID of the knowledge source. Returned when you add one; list them with `GET /v1/reception/knowledge-sources`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) {source_type: str, source_url: any, last_scraped_at_unix: any, original_filename: str, content_type: str, file_size_bytes: int, status: str, error_message: any, failure_reason: any, crawl_entire_site: bool, scraped_pages_count: int, content_preview: any, processing_started_at_unix: any, id: str, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/reception/knowledge-sources/{source_id}\n@desc Delete Knowledge Source\n@required {source_id: str # ID of the knowledge source. Returned when you add one; list them with `GET /v1/reception/knowledge-sources`., xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/knowledge-sources/urls\n@desc Add Url Source\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on., url: str(uri) # The HTTPS page or site to read.}\n@optional {crawl_entire_site: bool=false # Crawl the whole site instead of only the page at url.}\n@returns(200) {source_type: str, source_url: any, last_scraped_at_unix: any, original_filename: str, content_type: str, file_size_bytes: int, status: str, error_message: any, failure_reason: any, crawl_entire_site: bool, scraped_pages_count: int, content_preview: any, processing_started_at_unix: any, id: str, created_at_unix: int, updated_at_unix: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/reseller/workspaces\n@desc List Reseller Workspaces\n@optional {cursor: any # Pagination cursor from previous response, page_size: int=50 # Number of workspaces per page}\n@returns(200) {workspaces: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/reseller/workspaces\n@desc Create Reseller Workspace\n@required {business_name: str}\n@optional {subscription: any # Paid tier to subscribe to. Omitted leaves the workspace with no subscription., phone_number: any # A free number from the reseller's phone pool, reserved for the workspace until onboarding binds it to the receptionist., members: [map{email!: str, role: str}]= # People to invite once the workspace exists, capped by the tier's team size. Best-effort: each outcome is in `member_results`., complete_onboarding: bool=false # Finish setup right away, as `POST /v1/reception/reseller/workspaces/{workspace_id}/complete-onboarding` does. Best-effort: `onboarding_completed_at_unix` stays null on failure, and that call can be retried., idempotency_key: any # Client-generated key that makes a retry safe. The same key and body within 24 hours returns the first result without running again. While that first request is still running, a retry gets 409 `idempotency_key_in_progress`; a different body with the same key gets 400 `idempotency_key_reused`. A request that fails is not saved, so it can be retried with the same key.}\n@returns(200) {workspace_id: str, business_name: str, billing_tier: any, receptionist_count: int, calls_last_30_days: int, created_at_unix: int, subscription: any, has_payment_issue: bool, onboarding_completed_at_unix: any, member_results: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/reseller/workspaces/{workspace_id}/complete-onboarding\n@desc Complete Reseller Workspace Onboarding\n@required {workspace_id: str # ID of the customer workspace. Returned when you provision one; list them with `GET /v1/reception/reseller/workspaces`.}\n@returns(200) {onboarding_completed_at_unix: any, customer_facing_agent_id: str} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/reseller/workspaces/{workspace_id}/subscription\n@desc Assign Reseller Tier\n@required {workspace_id: str # ID of the customer workspace. Returned when you provision one; list them with `GET /v1/reception/reseller/workspaces`., tier_id: str}\n@optional {billing_period: str(monthly_period/annual_period)=monthly_period, idempotency_key: any # Client-generated key that makes a retry safe. The same key and body within 24 hours returns the first result without running again. While that first request is still running, a retry gets 409 `idempotency_key_in_progress`; a different body with the same key gets 400 `idempotency_key_reused`. A request that fails is not saved, so it can be retried with the same key.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/reception/reseller/workspaces/{workspace_id}/subscription\n@desc Change Reseller Tier\n@required {workspace_id: str # ID of the customer workspace. Returned when you provision one; list them with `GET /v1/reception/reseller/workspaces`., tier_id: str}\n@optional {billing_period: str(monthly_period/annual_period)=monthly_period, idempotency_key: any # Client-generated key that makes a retry safe. The same key and body within 24 hours returns the first result without running again. While that first request is still running, a retry gets 409 `idempotency_key_in_progress`; a different body with the same key gets 400 `idempotency_key_reused`. A request that fails is not saved, so it can be retried with the same key.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/reception/reseller/workspaces/{workspace_id}/subscription\n@desc Unassign Reseller Tier\n@required {workspace_id: str # ID of the customer workspace. Returned when you provision one; list them with `GET /v1/reception/reseller/workspaces`.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/reseller/workspaces/{workspace_id}/subscription/restore\n@desc Restore Reseller Subscription\n@required {workspace_id: str # ID of the customer workspace. Returned when you provision one; list them with `GET /v1/reception/reseller/workspaces`.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/reseller/workspaces/{workspace_id}/subscription/cancel-downgrade\n@desc Cancel Reseller Pending Downgrade\n@required {workspace_id: str # ID of the customer workspace. Returned when you provision one; list them with `GET /v1/reception/reseller/workspaces`.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/reseller/tier-ladder\n@desc List Reseller Tiers\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/reseller/billing/invoices\n@desc List Reseller Invoices\n@optional {cursor: any # Pagination cursor from previous response, page_size: int=25 # Number of invoices per page}\n@returns(200) {invoices: [map], next_cursor: any, has_more: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/reseller/billing/invoices/{invoice_id}\n@desc Get Reseller Invoice\n@required {invoice_id: str # ID of the invoice. List them with `GET /v1/reception/reseller/billing/invoices`.}\n@returns(200) {invoice_id: str, workspace_id: any, workspace_name: str, status: str, amount_cents: int, currency: str, created_unix: int, paid_unix: any, pay_url: any, pdf_url: any, lines: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/reseller/billing/upcoming\n@desc List Reseller Upcoming Payments\n@returns(200) {payments: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/team/members\n@desc Get Team Members\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint GET /v1/reception/team/invites\n@desc Get Pending Team Invites\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /v1/reception/team/invites\n@desc Invite Team Member\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on., email: str # The email address to invite.}\n@optional {role: str(workspace_admin/workspace_member)=workspace_member # The role the invitee joins with: 'workspace_admin' or 'workspace_member'.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/reception/team/invites\n@desc Cancel Team Invite\n@required {xi-workspace-id: str # The customer workspace a reseller's API key acts on., email: str # Email address the pending invite was sent to.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint PATCH /v1/reception/team/members/{user_id}\n@desc Update Team Member Role\n@required {user_id: str # User ID of the member to update, xi-workspace-id: str # The customer workspace a reseller's API key acts on., role: str(workspace_admin/workspace_member) # The member's new role.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endpoint DELETE /v1/reception/team/members/{user_id}\n@desc Remove Team Member\n@required {user_id: str # User ID of the member to remove, xi-workspace-id: str # The customer workspace a reseller's API key acts on.}\n@returns(200) Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group docs\n@endpoint GET /docs\n@desc Redirect To Mintlify\n@returns(200) Successful Response\n\n@endgroup\n\n@end\n"}}