Deprecated endpoint that registers a Retell call to obtain an access token for web client SDKs. Use the v3 create-web-call endpoint instead.
Was this page helpful?
⌘I
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Retell AI","description":"Explore Retell AI docs to learn how to build, test, deploy, and optimize AI voice agents with APIs, integrations, conversation flows, and production-ready tools.","colors":{"primary":"#606A78","light":"#F5F5FA","dark":"#172131"},"logo":{"light":"https://mintcdn.com/retellai/-E9UettTBfBiCBBS/images/docs-light.png?fit=max\u0026auto=format\u0026n=-E9UettTBfBiCBBS\u0026q=85\u0026s=64eb26a2d3cc9a67ee3ea0bfe086dd14","dark":"https://mintcdn.com/retellai/-E9UettTBfBiCBBS/images/docs-dark.png?fit=max\u0026auto=format\u0026n=-E9UettTBfBiCBBS\u0026q=85\u0026s=08472a0c78599498b85d23348d7826f6"},"favicon":"https://mintcdn.com/retellai/TsBk7Stx4694-7p1/logo/favicon-light.ico?fit=max\u0026auto=format\u0026n=TsBk7Stx4694-7p1\u0026q=85\u0026s=4e90f4db5e89b5ec7fe249a4844c2d97","api":{"openapi":["openapi-final.yaml"],"playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer"},"server":"https://api.retellai.com"}},"navbar":{"links":[{"icon":"message-circle-question-mark","href":"https://docs.retellai.com/general/support","label":"Support"},{"icon":"chart-line","href":"https://status.retellai.com/","label":"Status"},{"icon":"book","href":"https://www.retellai.com/changelog","label":"Changelog"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.retellai.com"}},"footer":{"socials":{"x":"https://x.com/retellai","linkedin":"https://www.linkedin.com/company/98828489","github":"https://github.com/RetellAI","instagram":"https://www.instagram.com/retell_ai","youtube":"https://www.youtube.com/@retellai"}},"fonts":{"family":"Inter"},"icons":{"library":"lucide"},"styling":{"codeblocks":"dark","latex":false},"integrations":{"mixpanel":{"projectToken":"c8676d3561adb5eefc366aa2a66725bc"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"interaction":{"drilldown":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"retellai","hasAudioNarration":false,"actualSubdomain":"retellai","customDomains":["docs.retellai.com"],"gitSource":{"type":"github","owner":"retellai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfbca1489bdbef01bbddf6","collectionId":"2ec1a076-8824-4365-85b7-b6101f1aa41f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfbca1489bdbef01bbddf6"},"feedback":{"thumbs":true,"edits":false,"issues":false,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adfbde3c552ab86f89927e9","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Guides","count":206},{"language":"default","tag":"API Reference","count":107},{"language":"default","tag":"Build","count":67},{"language":"default","tag":"Integrations","count":30},{"language":"default","tag":"Deploy","count":29},{"language":"default","tag":"Conversation flow agents","count":24},{"language":"default","tag":"Deprecations","count":22},{"language":"default","tag":"CRM","count":21},{"language":"default","tag":"Detailed Deprecation Guide","count":21},{"language":"default","tag":"Monitor","count":17}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instinct-self-updating-docs","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@media (min-width:1024px){#navbar .flex-1:has(>[data-slot=context-menu-trigger]),#navbar .flex-1:has(>a>.nav-logo){flex:none!important;width:15rem}#navbar .justify-end:has(.nav-tabs),#navbar .ustify-end:has(.nav-tabs){justify-content:space-between!important;margin-left:0!important}#navbar .flex:has(>.justify-end),#navbar .flex:has(>.ustify-end){flex:1!important}#navbar .nav-tabs{white-space:nowrap}}.max-w-prose,.max-w-xl,article{max-width:48rem!important}video.scroll-play{cursor:zoom-in}.video-zoom-overlay{position:fixed;inset:0;z-index:9999;display:flex;align-items:center;justify-content:center;padding:4vmin;background:rgba(0,0,0,.8);backdrop-filter:blur(2px);cursor:zoom-out}.video-zoom-media{max-width:92vw;max-height:92vh;width:auto;height:auto;border-radius:12px;box-shadow:0 10px 40px rgba(0,0,0,.5);cursor:default}.video-zoom-close{position:fixed;top:16px;right:20px;display:flex;align-items:center;justify-content:center;width:40px;height:40px;padding:0;border:0;border-radius:999px;background:rgba(255,255,255,.15);color:#fff;font-size:24px;line-height:1;cursor:pointer}.video-zoom-close:hover{background:rgba(255,255,255,.3)}.ui-btn{background-color:#f4f5f7!important;color:#1f2328!important;border:1px solid #d0d5dd!important;border-bottom-width:2px!important;border-radius:6px!important;padding:.1em .42em!important}[data-theme=dark] .ui-btn,html.dark .ui-btn{background-color:#21252d!important;color:#e6e8eb!important;border-color:#3a4048!important}img[src$=\"/images/icons/wss-badge.svg\"]{width:auto!important;height:15px!important}a[aria-current=page] img[src$=\"/images/icons/wss-badge.svg\"]{content:url(\"data:image/svg+xml,%3Csvg xmlns=%22http://www.w3.org/2000/svg%22 width=%2227%22 height=%2215%22 viewBox=%220 0 27 15%22 role=%22img%22 aria-label=%22WSS%22%3E %3Crect width=%2227%22 height=%2215%22 rx=%224%22 fill=%22%23F54A00%22/%3E %3Ctext x=%2213.5%22 y=%2210.7%22 text-anchor=%22middle%22 font-family=%22ui-sans-serif, system-ui, -apple-system, Segoe UI, Inter, Helvetica, Arial, sans-serif%22 font-size=%228.8%22 font-weight=%22700%22 fill=%22%23FFFFFF%22%3EWSS%3C/text%3E %3C/svg%3E\")}"}],"page":{"pagePath":"api-references/register-call","slug":"/api-references/register-call","pageMetadata":{"title":"Register Call (Deprecated)","description":"Deprecated endpoint that registers a Retell call to obtain an access token for web client SDKs. Use the v3 create-web-call endpoint instead.","openapi":"deprecated post /register-call","href":"/api-references/register-call"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Deprecated endpoint that registers a Retell call to obtain an access token for web client SDKs. Use the v3 create-web-call endpoint instead.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Register Call (Deprecated)","description":"Deprecated endpoint that registers a Retell call to obtain an access token for web client SDKs. Use the v3 create-web-call endpoint instead.","openapi":"deprecated post /register-call","href":"/api-references/register-call"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/retellai/e3fe5c9b64f9e274/scroll-play-videos.js"],"subdomain":"retellai","siteName":"Retell AI","title":"Register Call (Deprecated) - Retell AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-09T23:52:57.067Z","originalFileLocation":"api-references/register-call.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Deprecated endpoint that registers a Retell call to obtain an access token for web client SDKs. Use the v3 create-web-call endpoint instead.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Retell AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/retellai/aRxZhiMifgkRJF_R/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/retellai/aRxZhiMifgkRJF_R/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/retellai/aRxZhiMifgkRJF_R/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/retellai/aRxZhiMifgkRJF_R/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/retellai/aRxZhiMifgkRJF_R/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/retellai/aRxZhiMifgkRJF_R/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/retellai/aRxZhiMifgkRJF_R/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/retellai/aRxZhiMifgkRJF_R/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/retellai/aRxZhiMifgkRJF_R/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Register Call (Deprecated) - Retell AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Deprecated endpoint that registers a Retell call to obtain an access token for web client SDKs. Use the v3 create-web-call endpoint instead.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Retell AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.retellai.com/api-references/register-call\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://retellai.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Register+Call+%28Deprecated%29\u0026amp;description=Deprecated+endpoint+that+registers+a+Retell+call+to+obtain+an+access+token+for+web+client+SDKs.+Use+the+v3+create-web-call+endpoint+instead.\u0026amp;theme=35696226f7b423b96c359dbf\u0026amp;signature=7c9fe8bbfc9d23c9222ebfcfa4911f0ed69342fb15203eb29e6f799b4bb4c881\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Register Call (Deprecated) - Retell AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Deprecated endpoint that registers a Retell call to obtain an access token for web client SDKs. Use the v3 create-web-call endpoint instead.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://retellai.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Register+Call+%28Deprecated%29\u0026amp;description=Deprecated+endpoint+that+registers+a+Retell+call+to+obtain+an+access+token+for+web+client+SDKs.+Use+the+v3+create-web-call+endpoint+instead.\u0026amp;theme=35696226f7b423b96c359dbf\u0026amp;signature=7c9fe8bbfc9d23c9222ebfcfa4911f0ed69342fb15203eb29e6f799b4bb4c881\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/retellai/aRxZhiMifgkRJF_R/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Retell AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#606A78\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.retellai.com/api-references/register-call\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-references/register-call.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Retell AI\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Retell AI","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book","groups":[{"group":" ","pages":[{"title":"Introduction to Retell","href":"/general/introduction"},{"title":"Build your first phone agent in 15 minutes","href":"/get-started/quick-start"}]},{"group":"Conductor (AI Assistant)","icon":"https://mintlify.s3.us-west-1.amazonaws.com/retellai/images/conductor/conductor-icon.svg","pages":[{"title":"Retell AI Conductor overview","sidebarTitle":"Overview","href":"/conductor/overview"},{"group":"Functionality","pages":[{"title":"Build and refine agents","href":"/conductor/build-and-refine"},{"title":"Test and improve agents","href":"/conductor/test-and-improve"},{"title":"Inspect knowledge bases","href":"/conductor/knowledge-base"},{"title":"Review calls and chats","href":"/conductor/call-and-chat-history"},{"title":"Build analytics dashboards","href":"/conductor/analytics-dashboards"},{"title":"Review QA results","href":"/conductor/ai-qa"},{"title":"Review contacts","href":"/conductor/contacts"}]},{"title":"Pricing","href":"/conductor/usage-and-billing"}]},{"group":"Build","icon":"bot","pages":[{"title":"Build a Retell agent: configuration overview","href":"/build/overview"},{"title":"Single prompt vs. conversation flow","href":"/build/choose-agent-type"},{"title":"General prompting principles","href":"/build/prompt-engineering-guide"},{"group":"Single prompt agents","pages":[{"title":"Single prompt best practices","href":"/build/single-multi-prompt/write-single-prompt"},{"title":"Configure basic settings","href":"/build/single-multi-prompt/configure-basic-settings"},{"group":"Functions","pages":[{"title":"Function calling for single and multi-prompt agents","href":"/build/single-multi-prompt/function-calling"},{"title":"End call","href":"/build/single-multi-prompt/end-call"},{"title":"Transfer call tool (single \u0026 multi-prompt agents)","href":"/build/single-multi-prompt/transfer-call"},{"title":"Send SMS","href":"/build/single-multi-prompt/send-sms"},{"title":"Press digit (IVR navigation)","href":"/build/single-multi-prompt/press-digit"},{"title":"Integrate any system with custom function","href":"/build/single-multi-prompt/custom-function"},{"title":"Integration tools","href":"/build/single-multi-prompt/integration-tools"},{"title":"Code tool: run JavaScript in a Retell agent","href":"/build/single-multi-prompt/code-tool"},{"title":"Extract Dynamic Variables","href":"/build/single-multi-prompt/extract-dv"},{"title":"Agent Transfer tool: hand a call to another AI agent","href":"/build/single-multi-prompt/transfer-agent"},{"title":"MCP tools for single and multi-prompt agents","href":"/build/single-multi-prompt/mcp"}]}]},{"group":"Conversation flow agents","pages":[{"title":"Conversation flow agents: structured voice AI call control","href":"/build/conversation-flow/overview"},{"title":"Conversation flow best practices","href":"/build/conversation-flow/best-practices"},{"title":"Configure global settings","href":"/build/conversation-flow/global-setting"},{"group":"Nodes","pages":[{"title":"Nodes and edges","href":"/build/conversation-flow/node"},{"title":"Subagent node","href":"/build/conversation-flow/subagent-node"},{"title":"Conversation node","href":"/build/conversation-flow/conversation-node"},{"group":"Function Node","pages":[{"title":"Call a function from a conversation flow node","href":"/build/conversation-flow/function-node"},{"title":"Custom function in conversation flow","href":"/build/conversation-flow/custom-function"},{"title":"Integration tools in conversation flow","href":"/build/conversation-flow/integration-tools"}]},{"title":"Code node: run JavaScript in a conversation flow","href":"/build/conversation-flow/code-node"},{"title":"Call transfer node in conversation flow","href":"/build/conversation-flow/call-transfer-node"},{"title":"Press Digit Node","href":"/build/conversation-flow/press-digit-node"},{"title":"End node","href":"/build/conversation-flow/end-node"},{"title":"Logic Split Node","href":"/build/conversation-flow/logic-split-node"},{"title":"SMS Node","href":"/build/conversation-flow/sms-node"},{"title":"Extract Dynamic Variable Node","href":"/build/conversation-flow/extract-dv-node"},{"title":"Agent Transfer Node","href":"/build/conversation-flow/transfer-agent-node"},{"title":"MCP node in conversation flow","href":"/build/conversation-flow/mcp-node"}]},{"title":"Transition conditions","href":"/build/conversation-flow/transition-condition"},{"title":"Reusable subflows for conversation flow agents","href":"/build/conversation-flow/components"},{"title":"Flex Mode: dynamic conversation flow execution","href":"/build/conversation-flow/flex-mode"},{"group":"Advanced features","pages":[{"title":"Global Node","href":"/build/conversation-flow/global-node"},{"title":"Finetune Examples","href":"/build/conversation-flow/finetune-examples"}]},{"title":"Debug guide","href":"/build/conversation-flow/debug-guide"}]},{"group":"Multi-prompt agents (legacy)","pages":[{"title":"Multi-prompt agents","href":"/build/single-multi-prompt/write-multi-prompt"}]},{"title":"Create chat agent","href":"/build/create-chat-agent"},{"title":"Agent workflow","href":"/agent/agent-workflow"},{"title":"Set language for your agent","href":"/agent/language"},{"title":"Configure a multilingual agent","href":"/agent/multilingual"},{"title":"Supported languages by provider","href":"/build/language-support"},{"group":"Understand user speech better","pages":[{"title":"Speech recognition providers","href":"/build/asr-providers"},{"title":"Transcription modes","href":"/build/transcription-mode"},{"title":"Handle background speech \u0026 noise","href":"/build/handle-background-noise"}]},{"group":"Generate better responses from LLM","pages":[{"title":"Agent Handbook","href":"/build/agent-handbook"},{"title":"Conversational Mode","href":"/build/conversational-mode"},{"title":"Pronunciation examples","href":"/build/prompt-situation-guide"},{"title":"Configure LLM Options","href":"/build/llm-options"}]},{"group":"Customize the synthesized speech","pages":[{"title":"Choose a custom voice","href":"/build/voice"},{"title":"Platform voices","href":"/build/platform-voices"},{"title":"Expressive Mode: add emotion and emphasis to agent speech","href":"/build/expressive-mode"},{"title":"Add custom pronunciation","href":"/build/add-pronunciation"},{"title":"Make the agent stay silent","href":"/build/no-response"},{"title":"Speech controls","href":"/build/speech-controls"},{"title":"Set up TTS fallback","href":"/build/tts-fallback"}]},{"group":"Integrate telephony features","pages":[{"title":"Handle voicemail and IVR","href":"/build/handle-voicemail"},{"title":"Capture DTMF input from user","href":"/build/user-dtmf"},{"title":"Set \u0026 parse custom SIP headers","href":"/build/telephony/sip-headers"}]},{"group":"Provide context to the agent","pages":[{"title":"Knowledge base setup and retrieval tuning","href":"/build/knowledge-base"},{"title":"Dynamic variables","href":"/build/dynamic-variables"}]},{"title":"Guardrails","href":"/build/guardrails"},{"title":"Do-not-call requests","href":"/build/do-not-call"}]},{"group":"Test","icon":"flask-conical","pages":[{"title":"Testing overview","href":"/test/test-overview"},{"group":"LLM Playground","pages":[{"title":"Manually test your agent","href":"/test/llm-playground"},{"title":"Debug your agent response","href":"/test/llm-playground-debug"}]},{"group":"LLM Simulation Testing","pages":[{"title":"Automatically test your agent","href":"/test/llm-simulation-testing"},{"title":"Batch test your agent","href":"/test/batch-test-simulation"}]},{"group":"Audio Testing","pages":[{"title":"Web call testing","href":"/test/test-web"},{"title":"Phone call testing","href":"/test/test-phone"}]},{"title":"Testing with Conductor","icon":"https://mintlify.s3.us-west-1.amazonaws.com/retellai/images/conductor/conductor-icon.svg","href":"/test/testing-with-conductor"},{"title":"Testing pricing","href":"/test/testing-pricing"}]},{"group":"Deploy","icon":"phone","pages":[{"title":"Purchase phone number","href":"/deploy/purchase-number"},{"title":"A/B Testing","href":"/deploy/ab-testing"},{"group":"Connect to custom telephony providers via SIP","pages":[{"title":"Connect Retell voice agents to custom telephony","href":"/deploy/custom-telephony"},{"group":"Connect via SIP trunking","pages":[{"title":"Connect a Twilio number to Retell with elastic SIP trunking","sidebarTitle":"Twilio","href":"/deploy/twilio"},{"title":"Telnyx","href":"/deploy/telnyx"},{"title":"Vonage","href":"/deploy/vonage"}]},{"group":"Connect to CCaaS","pages":[{"title":"Avaya","href":"/deploy/avaya"},{"title":"Connect Genesys Cloud to Retell","href":"/deploy/genesys"},{"title":"Connect Five9 to Retell","href":"/deploy/five9"},{"title":"Amazon Connect","href":"/deploy/amazon-connect"}]}]},{"group":"Make \u0026 receive phone calls","pages":[{"title":"Make outbound calls","href":"/deploy/outbound-call"},{"group":"Inbound calls","pages":[{"title":"Receive calls","href":"/deploy/inbound-call"},{"title":"Inbound call \u0026 SMS webhook","href":"/features/inbound-call-webhook"}]},{"title":"International calling","href":"/deploy/international-call"}]},{"title":"Implement chat with create chat completion","href":"/deploy/create-chat-completion"},{"title":"Website widget","href":"/deploy/chat-widget"},{"group":"Send \u0026 receive SMS","pages":[{"title":"Enable SMS","href":"/deploy/enable-sms"},{"title":"SMS campaign application","href":"/deploy/sms-campaign-application"}]},{"title":"Agent versions and tags","href":"/agent/version"},{"title":"Compare agent versions","href":"/agent/version-comparison"},{"title":"Create and schedule batch calls","href":"/deploy/make-batch-call"},{"group":"Increase call pickup rate","pages":[{"title":"Spam likely overview","href":"/build/telephony/call_efficiency_overview"},{"title":"Add a business profile","href":"/build/telephony/business-profile"},{"title":"Apply for verified phone number","href":"/build/telephony/verified-phone"},{"title":"Apply for branded call","href":"/build/telephony/branded-call"},{"title":"Handle application rejection","href":"/build/telephony/branded-call-rejection"},{"title":"Stop caller ID service","href":"/build/telephony/delete-service"}]},{"title":"Make a web call","href":"/deploy/web-call"},{"title":"Understand concurrency \u0026 limits","href":"/deploy/concurrency"}]},{"group":"Data","icon":"database","pages":[{"title":"Call \u0026 chat history","href":"/features/session-history"},{"title":"Contacts","href":"/features/contacts"},{"title":"Contact memory","href":"/features/contact-memory"}]},{"group":"Monitor","icon":"square-activity","pages":[{"title":"Monitor live calls","href":"/features/live-monitoring"},{"title":"Analytics dashboard","href":"/features/analytics-dashboard"},{"title":"Alert rules for call and chat metrics","href":"/features/alerting-overview"},{"group":"Register \u0026 handle webhooks","pages":[{"group":"Call Event Webhook","pages":[{"title":"Retell webhooks overview","href":"/features/webhook-overview"},{"title":"Register and set up a Retell webhook","href":"/features/register-webhook"}]},{"title":"Secure the webhook","href":"/features/secure-webhook"}]},{"group":"Post Call Extraction","pages":[{"title":"Post Call Extraction overview and categories","href":"/features/post-call-analysis-overview"},{"title":"Define the information you want to extract","href":"/features/post-call-analysis-create"},{"title":"Consume the analysis data","href":"/features/post-call-analysis-consumption"},{"title":"Rerun Post Call/Chat Extraction","href":"/features/rerun-call-analysis"}]},{"group":"AI Quality Assurance","pages":[{"title":"Automatically evaluate call quality with AI QA","sidebarTitle":"AI Quality Assurance","href":"/ai-qa/overview"},{"group":"Create QA","pages":[{"title":"Access AI QA","href":"/ai-qa/get-started"},{"title":"Define a QA cohort","href":"/ai-qa/create-cohort"},{"title":"Define resolution criteria","href":"/ai-qa/define-resolution-criteria"}]},{"title":"View QA results","href":"/ai-qa/view-qa-results"},{"title":"AI QA metrics","href":"/ai-qa/terminologies"},{"title":"Address metric issues","href":"/ai-qa/address-metric-issues"}]}]},{"group":"Reliability \u0026 Debugging","icon":"bug","pages":[{"title":"Reliability Overview","href":"/reliability/reliability-overview"},{"group":"Latency","pages":[{"title":"Check estimated latency","href":"/reliability/check-estimated-latency"},{"title":"Check actual latency","href":"/reliability/check-actual-latency"},{"title":"Troubleshoot high latency","href":"/reliability/troubleshoot-latency"}]},{"group":"Fix agent behaviors","pages":[{"title":"Transcription accuracy","href":"/reliability/wrong-transcript"},{"title":"Debug wrong response","href":"/reliability/wrong-response"}]},{"group":"Debug phone call issues","pages":[{"title":"Debug call transfer failure","href":"/reliability/call-performance"},{"title":"Debug call disconnection","href":"/reliability/debug-call-disconnect"},{"title":"Debug outbound connection issues","href":"/reliability/debug-outbound-call"},{"title":"Debug SIP calls using PCAP file","href":"/reliability/debug-calls-pcap"}]},{"title":"Agent paused or banned","href":"/reliability/agent-paused"},{"title":"Prevent abuse","href":"/reliability/prevent-abuse"},{"title":"Fraud Protection","href":"/reliability/fraud-protection"}]},{"group":"Accounts and Workspace","icon":"circle-user-round","pages":[{"title":"Create and manage Retell workspaces","href":"/accounts/workspace"},{"title":"Manage your Retell AI account","href":"/accounts/account"},{"title":"Use your business email","href":"/accounts/business-email"},{"title":"Access Control","href":"/accounts/access-control"},{"title":"KYC Verification","href":"/accounts/kyc"},{"group":"Billing","pages":[{"title":"Retell AI billing: credits, auto recharge, and invoices","href":"/accounts/billing"},{"title":"Exceptions to Our Per-Minute Pricing","href":"/accounts/billing-exceptions"},{"title":"Add payment methods","href":"/accounts/add-payment"},{"title":"Handle failed payments","href":"/accounts/fail-payment"}]},{"group":"Keys","pages":[{"title":"API Key Overview","href":"/accounts/api-keys-overview"},{"title":"Manage API keys and permission scopes","href":"/accounts/manage-api-keys"},{"title":"Public keys","href":"/accounts/public-keys"}]},{"group":"Privacy and Compliance","pages":[{"title":"Data Storage Settings","href":"/accounts/privacy-disable"},{"title":"Data Retention Policy","href":"/accounts/data-retention"},{"title":"Opt in to secure URL","href":"/accounts/signed-secure-url"},{"title":"Security and compliance","href":"/general/compliance"}]}]},{"group":"Integrations","icon":"unplug","pages":[{"title":"Connect CRMs, calendars, and knowledge sources to Retell","sidebarTitle":"Integrations overview","href":"/integrations/overview"},{"group":"CRM","pages":[{"title":"CRM integrations","href":"/integrations/crm-overview"},{"title":"CRM data mappings","href":"/integrations/crm-mappings"},{"group":"HubSpot","pages":[{"title":"Connect HubSpot","sidebarTitle":"Connect","href":"/integrations/hubspot"},{"title":"HubSpot contact sync","sidebarTitle":"Contact sync","href":"/integrations/hubspot-contact-sync"},{"title":"HubSpot agent functions","sidebarTitle":"Agent functions","href":"/integrations/hubspot-functions"}]},{"group":"Salesforce","pages":[{"title":"Connect Salesforce","sidebarTitle":"Connect","href":"/integrations/salesforce"},{"title":"Salesforce contact sync","sidebarTitle":"Contact sync","href":"/integrations/salesforce-contact-sync"},{"title":"Salesforce agent functions","sidebarTitle":"Agent functions","href":"/integrations/salesforce-functions"}]},{"group":"Microsoft Dynamics 365","pages":[{"title":"Connect Dynamics 365","sidebarTitle":"Connect","href":"/integrations/microsoft-dynamics"},{"title":"Dynamics 365 contact sync","sidebarTitle":"Contact sync","href":"/integrations/microsoft-dynamics-contact-sync"},{"title":"Dynamics 365 agent functions","sidebarTitle":"Agent functions","href":"/integrations/microsoft-dynamics-functions"}]},{"group":"GoHighLevel","pages":[{"title":"Connect GoHighLevel","sidebarTitle":"Connect","href":"/integrations/gohighlevel"},{"title":"GoHighLevel contact sync","sidebarTitle":"Contact sync","href":"/integrations/gohighlevel-contact-sync"},{"title":"GoHighLevel agent functions","sidebarTitle":"Agent functions","href":"/integrations/gohighlevel-functions"}]},{"group":"Zoho CRM","pages":[{"title":"Connect Zoho CRM","sidebarTitle":"Connect","href":"/integrations/zoho"},{"title":"Zoho contact sync","sidebarTitle":"Contact sync","href":"/integrations/zoho-contact-sync"},{"title":"Zoho agent functions","sidebarTitle":"Agent functions","href":"/integrations/zoho-functions"}]}]},{"group":"Helpdesk","pages":[{"group":"Zendesk","pages":[{"title":"Connect Zendesk","sidebarTitle":"Connect","href":"/integrations/zendesk"},{"title":"Zendesk agent functions","sidebarTitle":"Agent functions","href":"/integrations/zendesk-functions"}]}]},{"group":"Knowledge Base","pages":[{"group":"Google Drive","pages":[{"title":"Connect Google Drive","sidebarTitle":"Connect","href":"/integrations/google-drive"},{"title":"Google Drive knowledge base sync","sidebarTitle":"Knowledge base sync","href":"/integrations/google-drive-knowledge-base"}]},{"group":"Microsoft OneDrive","pages":[{"title":"Connect OneDrive","sidebarTitle":"Connect","href":"/integrations/microsoft-onedrive"},{"title":"OneDrive knowledge base sync","sidebarTitle":"Knowledge base sync","href":"/integrations/microsoft-onedrive-knowledge-base"}]},{"group":"Notion","pages":[{"title":"Connect Notion","sidebarTitle":"Connect","href":"/integrations/notion"},{"title":"Notion knowledge base sync","sidebarTitle":"Knowledge base sync","href":"/integrations/notion-knowledge-base"}]}]},{"group":"Calendar","pages":[{"group":"GoHighLevel","pages":[{"title":"GoHighLevel agent functions","sidebarTitle":"Agent functions","href":"/integrations/gohighlevel-functions"}]},{"group":"Calendly","pages":[{"title":"Connect Calendly","sidebarTitle":"Connect","href":"/integrations/calendly"},{"title":"Calendly agent functions","sidebarTitle":"Agent functions","href":"/integrations/calendly-functions"}]},{"group":"Cal.com","pages":[{"title":"Connect Cal.com","sidebarTitle":"Connect","href":"/integrations/cal-com"},{"title":"Cal.com agent functions","sidebarTitle":"Agent functions","href":"/integrations/cal-com-functions"}]}]}]},{"group":"Marketplace","icon":"store","pages":[{"title":"Trigger Retell calls from HubSpot workflows","href":"/integrations/hubspot-marketplace"},{"title":"Trigger Retell calls from Zoho CRM workflows","href":"/integrations/zoho-marketplace"},{"title":"Trigger Retell calls from Slack","href":"/integrations/slack-marketplace"},{"title":"Trigger Retell calls from Notion","href":"/integrations/notion-marketplace"}]},{"group":"Other Topics","pages":[{"group":"Custom LLM","pages":[{"title":"Custom LLM overview","href":"/integrate-llm/overview"},{"title":"Set up a custom LLM WebSocket server for your Retell agent","href":"/integrate-llm/setup-websocket-server"},{"title":"Connect your LLM","href":"/integrate-llm/integrate-llm"},{"title":"Add function calling","href":"/integrate-llm/integrate-function-calling"},{"title":"Troubleshooting","href":"/integrate-llm/troubleshooting"},{"title":"Best practices","href":"/integrate-llm/llm-best-practice"}]},{"title":"Audio Basics","href":"/knowledge/audio-basics"}]}]},{"tab":"API Reference","icon":"code-xml","groups":[{"group":" ","pages":[{"title":"Retell AI API Reference","href":"/api-references/overview"}]},{"group":"Call","pages":[{"title":"Create Phone Call","openapi":"openapi-final post /v2/create-phone-call","href":"/api-references/create-phone-call"},{"title":"Create Web Call","openapi":"openapi-final post /v3/create-web-call","href":"/api-references/create-web-call"},{"title":"Get Call","openapi":"openapi-final get /v2/get-call/{call_id}","href":"/api-references/get-call"},{"title":"List Calls","openapi":"openapi-final post /v3/list-calls","href":"/api-references/list-calls"},{"title":"Update Call","openapi":"openapi-final patch /v2/update-call/{call_id}","href":"/api-references/update-call"},{"title":"Update Live Call","openapi":"openapi-final patch /v2/update-live-call/{call_id}","href":"/api-references/update-live-call"},{"title":"Monitor Call WebSocket","icon":"https://mintlify.s3.us-west-1.amazonaws.com/retellai/images/icons/wss-badge.svg","href":"/api-references/monitor-call-websocket"},{"title":"Rerun Call Analysis","openapi":"openapi-final put /rerun-call-analysis/{call_id}","href":"/api-references/rerun-call-analysis"},{"title":"Stop Call","openapi":"openapi-final post /v2/stop-call/{call_id}","href":"/api-references/stop-call"},{"title":"Delete Call","openapi":"openapi-final delete /v2/delete-call/{call_id}","href":"/api-references/delete-call"}]},{"group":"Chat","pages":[{"title":"Create Chat","openapi":"openapi-final post /create-chat","href":"/api-references/create-chat"},{"title":"Create Outbound SMS","openapi":"openapi-final post /create-sms-chat","href":"/api-references/create-sms-chat"},{"title":"Get Chat","openapi":"openapi-final get /get-chat/{chat_id}","href":"/api-references/get-chat"},{"title":"Create Chat Completion","openapi":"openapi-final post /create-chat-completion","href":"/api-references/create-chat-completion"},{"title":"List Chats","openapi":"openapi-final post /v3/list-chats","href":"/api-references/list-chats"},{"title":"Update Chat","openapi":"openapi-final patch /update-chat/{chat_id}","href":"/api-references/update-chat"},{"title":"Rerun Chat Analysis","openapi":"openapi-final put /rerun-chat-analysis/{chat_id}","href":"/api-references/rerun-chat-analysis"},{"title":"End Chat","openapi":"openapi-final patch /end-chat/{chat_id}","href":"/api-references/end-chat"},{"title":"Delete Chat","openapi":"openapi-final delete /delete-chat/{chat_id}","href":"/api-references/delete-chat"}]},{"group":"Playground","pages":[{"title":"Agent Playground Completion","openapi":"openapi-final post /agent-playground-completion/{agent_id}","href":"/api-references/agent-playground-completion"}]},{"group":"Phone Number","pages":[{"title":"Create Phone Number","openapi":"openapi-final post /create-phone-number","href":"/api-references/create-phone-number"},{"title":"Get Phone Number","openapi":"openapi-final get /get-phone-number/{phone_number}","href":"/api-references/get-phone-number"},{"title":"List Phone Numbers","openapi":"openapi-final get /v2/list-phone-numbers","href":"/api-references/list-phone-numbers"},{"title":"Update Phone Number","openapi":"openapi-final patch /update-phone-number/{phone_number}","href":"/api-references/update-phone-number"},{"title":"Delete Phone Number","openapi":"openapi-final delete /delete-phone-number/{phone_number}","href":"/api-references/delete-phone-number"}]},{"group":"Voice Agent","pages":[{"title":"Create Voice Agent","openapi":"openapi-final post /create-agent","href":"/api-references/create-agent"},{"title":"Get Voice Agent","openapi":"openapi-final get /get-agent/{agent_id}","href":"/api-references/get-agent"},{"title":"List Voice Agents","openapi":"openapi-final post /v2/list-agents","href":"/api-references/list-agents"},{"title":"Update Voice Agent","openapi":"openapi-final patch /update-agent/{agent_id}","href":"/api-references/update-agent"},{"title":"Delete Agent","openapi":"openapi-final delete /delete-agent/{agent_id}","href":"/api-references/delete-agent"},{"title":"Publish Agent","openapi":"openapi-final post /publish-agent-version/{agent_id}","href":"/api-references/publish-agent"},{"title":"Create Draft Agent Version","openapi":"openapi-final post /create-agent-version/{agent_id}","href":"/api-references/create-agent-version"},{"title":"Delete Agent Version","openapi":"openapi-final delete /delete-agent-version/{agent_id}","href":"/api-references/delete-agent-version"},{"title":"List Agent Versions","openapi":"openapi-final get /list-agent-versions/{agent_id}","href":"/api-references/list-agent-versions"}]},{"group":"Chat Agent","pages":[{"title":"Create Chat Agent","openapi":"openapi-final post /create-chat-agent","href":"/api-references/create-chat-agent"},{"title":"Get Chat Agent","openapi":"openapi-final get /get-chat-agent/{agent_id}","href":"/api-references/get-chat-agent"},{"title":"List Chat Agents","openapi":"openapi-final post /v2/list-agents","href":"/api-references/list-chat-agents"},{"title":"Update Chat Agent","openapi":"openapi-final patch /update-chat-agent/{agent_id}","href":"/api-references/update-chat-agent"},{"title":"Delete Chat Agent","openapi":"openapi-final delete /delete-chat-agent/{agent_id}","href":"/api-references/delete-chat-agent"},{"title":"Publish Chat Agent","openapi":"openapi-final post /publish-agent-version/{agent_id}","href":"/api-references/publish-chat-agent"},{"title":"Create Draft Chat Agent Version","openapi":"openapi-final post /create-agent-version/{agent_id}","href":"/api-references/create-chat-agent-version"},{"title":"Delete Chat Agent Version","openapi":"openapi-final delete /delete-agent-version/{agent_id}","href":"/api-references/delete-chat-agent-version"},{"title":"List Agent Versions","openapi":"openapi-final get /list-agent-versions/{agent_id}","href":"/api-references/list-agent-versions"}]},{"group":"Retell LLM Response Engine (for single / multi prompt agent)","pages":[{"title":"Create Retell LLM","openapi":"openapi-final post /create-retell-llm","href":"/api-references/create-retell-llm"},{"title":"Get Retell LLM","openapi":"openapi-final get /get-retell-llm/{llm_id}","href":"/api-references/get-retell-llm"},{"title":"List Retell LLMs","openapi":"openapi-final get /v2/list-retell-llms","href":"/api-references/list-retell-llms"},{"title":"Update Retell LLM","openapi":"openapi-final patch /update-retell-llm/{llm_id}","href":"/api-references/update-retell-llm"},{"title":"Delete Retell LLM","openapi":"openapi-final delete /delete-retell-llm/{llm_id}","href":"/api-references/delete-retell-llm"}]},{"group":"Conversation Flow Response Engine (for conversation flow agent)","pages":[{"title":"Create Conversation Flow","openapi":"openapi-final post /create-conversation-flow","href":"/api-references/create-conversation-flow"},{"title":"Get Conversation Flow","openapi":"openapi-final get /get-conversation-flow/{conversation_flow_id}","href":"/api-references/get-conversation-flow"},{"title":"List Conversation Flows","openapi":"openapi-final get /v2/list-conversation-flows","href":"/api-references/list-conversation-flows"},{"title":"Update Conversation Flow","openapi":"openapi-final patch /update-conversation-flow/{conversation_flow_id}","href":"/api-references/update-conversation-flow"},{"title":"Delete Conversation Flow","openapi":"openapi-final delete /delete-conversation-flow/{conversation_flow_id}","href":"/api-references/delete-conversation-flow"}]},{"group":"Conversation Flow Subflows","pages":[{"title":"Create Conversation Flow Subflow","openapi":"openapi-final post /create-conversation-flow-component","href":"/api-references/create-conversation-flow-component"},{"title":"Get Conversation Flow Subflow","openapi":"openapi-final get /get-conversation-flow-component/{conversation_flow_component_id}","href":"/api-references/get-conversation-flow-component"},{"title":"List Conversation Flow Subflows","openapi":"openapi-final get /v2/list-conversation-flow-components","href":"/api-references/list-conversation-flow-components"},{"title":"Update Conversation Flow Subflow","openapi":"openapi-final patch /update-conversation-flow-component/{conversation_flow_component_id}","href":"/api-references/update-conversation-flow-component"},{"title":"Delete Conversation Flow Subflow","openapi":"openapi-final delete /delete-conversation-flow-component/{conversation_flow_component_id}","href":"/api-references/delete-conversation-flow-component"}]},{"group":"MCP Tool","pages":[{"title":"Get MCP Tools","openapi":"openapi-final get /get-mcp-tools/{agent_id}","href":"/api-references/get-mcp-tools"}]},{"group":"Knowledge Base","pages":[{"title":"Create Knowledge Base","openapi":"openapi-final post /create-knowledge-base","href":"/api-references/create-knowledge-base"},{"title":"Get Knowledge Base","openapi":"openapi-final get /get-knowledge-base/{knowledge_base_id}","href":"/api-references/get-knowledge-base"},{"title":"List Knowledge Bases","openapi":"openapi-final get /list-knowledge-bases","href":"/api-references/list-knowledge-bases"},{"title":"Delete Knowledge Base","openapi":"openapi-final delete /delete-knowledge-base/{knowledge_base_id}","href":"/api-references/delete-knowledge-base"},{"title":"Add Knowledge Base Sources","openapi":"openapi-final post /add-knowledge-base-sources/{knowledge_base_id}","href":"/api-references/add-knowledge-base-sources"},{"title":"Delete Knowledge Base Source","openapi":"openapi-final delete /delete-knowledge-base-source/{knowledge_base_id}/source/{source_id}","href":"/api-references/delete-knowledge-base-source"}]},{"group":"Voice","pages":[{"title":"Add Voice","openapi":"openapi-final post /add-community-voice","href":"/api-references/add-voice"},{"title":"Clone Voice","openapi":"openapi-final post /clone-voice","href":"/api-references/clone-voice"},{"title":"Search Voice","openapi":"openapi-final post /search-community-voice","href":"/api-references/search-voice"},{"title":"Get Voice","openapi":"openapi-final get /get-voice/{voice_id}","href":"/api-references/get-voice"},{"title":"List Voices","openapi":"openapi-final get /list-voices","href":"/api-references/list-voices"}]},{"group":"Batch call","pages":[{"title":"Create Batch Call","openapi":"openapi-final post /create-batch-call","href":"/api-references/create-batch-call"}]},{"group":"Contact","pages":[{"title":"Create Contact","openapi":"openapi-final post /create-contact","href":"/api-references/create-contact"},{"title":"Get Contact","openapi":"openapi-final get /get-contact/{contact_id}","href":"/api-references/get-contact"},{"title":"Get Contact by Phone","openapi":"openapi-final get /get-contact-by-phone/{phone_number}","href":"/api-references/get-contact-by-phone"},{"title":"List Contacts","openapi":"openapi-final post /list-contacts","href":"/api-references/list-contacts"},{"title":"List Contact Conversations","openapi":"openapi-final get /list-contact-conversations/{contact_id}","href":"/api-references/list-contact-conversations"},{"title":"Update Contact","openapi":"openapi-final patch /update-contact/{contact_id}","href":"/api-references/update-contact"},{"title":"Delete Contact","openapi":"openapi-final delete /delete-contact/{contact_id}","href":"/api-references/delete-contact"},{"title":"Backfill Contact Analysis Data","openapi":"openapi-final post /backfill-contact-analysis-data","href":"/api-references/backfill-contact-analysis-data"},{"title":"Get Backfill Job Status","openapi":"openapi-final get /get-backfill-contact-job-status","href":"/api-references/get-backfill-contact-job-status"}]},{"group":"App","pages":[{"title":"Create App","openapi":"openapi-final post /create-app","href":"/api-references/create-app"},{"title":"Get App","openapi":"openapi-final get /get-app/{app_id}","href":"/api-references/get-app"},{"title":"List Apps","openapi":"openapi-final get /list-apps","href":"/api-references/list-apps"},{"title":"Update App","openapi":"openapi-final patch /update-app/{app_id}","href":"/api-references/update-app"},{"title":"Delete App","openapi":"openapi-final delete /delete-app/{app_id}","href":"/api-references/delete-app"},{"title":"List App Usages","openapi":"openapi-final get /list-app-usages/{app_id}","href":"/api-references/list-app-usages"},{"title":"Test App Auth","openapi":"openapi-final post /test-app-auth/{app_id}","href":"/api-references/test-app-auth"}]},{"group":"CRM","pages":[{"title":"Get CRM Config","openapi":"openapi-final get /get-crm-config","href":"/api-references/get-crm-config"},{"title":"Update CRM Config","openapi":"openapi-final post /update-crm-config","href":"/api-references/update-crm-config"},{"title":"Get CRM Schema","openapi":"openapi-final get /get-crm-schema","href":"/api-references/get-crm-schema"},{"title":"Run Sync Job","openapi":"openapi-final post /run-sync-job","href":"/api-references/run-sync-job"},{"title":"Get Sync Job Status","openapi":"openapi-final get /get-sync-job-status","href":"/api-references/get-sync-job-status"}]},{"group":"Test Case Definitions","pages":[{"title":"Create Test Case Definition","openapi":"openapi-final post /create-test-case-definition","href":"/api-references/create-test-case-definition"},{"title":"Get Test Case Definition","openapi":"openapi-final get /get-test-case-definition/{test_case_definition_id}","href":"/api-references/get-test-case-definition"},{"title":"List Test Case Definitions","openapi":"openapi-final get /v2/list-test-case-definitions","href":"/api-references/list-test-case-definitions"},{"title":"Update Test Case Definition","openapi":"openapi-final put /update-test-case-definition/{test_case_definition_id}","href":"/api-references/update-test-case-definition"},{"title":"Delete Test Case Definition","openapi":"openapi-final delete /delete-test-case-definition/{test_case_definition_id}","href":"/api-references/delete-test-case-definition"}]},{"group":"Batch Tests","pages":[{"title":"Create Batch Test","openapi":"openapi-final post /create-batch-test","href":"/api-references/create-batch-test"},{"title":"Get Batch Test","openapi":"openapi-final get /get-batch-test/{test_case_batch_job_id}","href":"/api-references/get-batch-test"},{"title":"List Batch Tests","openapi":"openapi-final get /v2/list-batch-tests","href":"/api-references/list-batch-tests"}]},{"group":"Test Runs","pages":[{"title":"Get Test Run","openapi":"openapi-final get /get-test-run/{test_case_job_id}","href":"/api-references/get-test-run"},{"title":"List Test Runs","openapi":"openapi-final get /v2/list-test-runs/{test_case_batch_job_id}","href":"/api-references/list-test-runs"}]},{"group":"Account","pages":[{"title":"Get Concurrency","openapi":"openapi-final get /get-concurrency","href":"/api-references/get-concurrency"},{"title":"List Export Requests","openapi":"openapi-final get /v2/list-export-requests","href":"/api-references/list-export-requests"}]},{"group":"Custom Telephony","pages":[{"title":"Import Phone Number","openapi":"openapi-final post /import-phone-number","href":"/api-references/import-phone-number"},{"title":"Register Phone Call","openapi":"openapi-final post /v2/register-phone-call","href":"/api-references/register-phone-call"}]},{"group":"Custom LLM","pages":[{"title":"LLM WebSocket","icon":"https://mintlify.s3.us-west-1.amazonaws.com/retellai/images/icons/wss-badge.svg","href":"/api-references/llm-websocket"}]}]},{"tab":"SDK","icon":"package","pages":[{"title":"Retell SDKs for TypeScript and Python","icon":"package","mode":"wide","href":"/get-started/sdk"},{"title":"Create voice agent with TypeScript SDK","href":"/get-started/create-agent-with-sdk"}]},{"tab":"MCP","icon":"plug-zap","pages":[{"title":"Retell MCP server for AI assistants","icon":"plug-zap","mode":"wide","href":"/get-started/mcp-server"},{"title":"Claude connector","sidebarTitle":"Claude","href":"/get-started/claude"}]},{"tab":"CLI","icon":"terminal","pages":[{"title":"Retell CLI","icon":"terminal","mode":"wide","href":"/get-started/cli"}]},{"tab":"Deprecations","icon":"book-alert","groups":[{"group":" ","pages":[{"title":"Retell deprecations and breaking changes","icon":"bell","tag":"RSS","mode":"center","href":"/deprecation-notice/overview"}]},{"group":"Detailed Deprecation Guide","pages":[{"title":"Deprecated API notice: Legacy model fields","href":"/deprecation-notice/2027/01-31_legacy_model_fields"},{"title":"Multi-prompt agents","href":"/deprecation-notice/2026/12-15_multi_prompt_agents"},{"title":"Claude Sonnet 4.5 model replacement","href":"/deprecation-notice/2026/10-29_model_replacements"},{"title":"GPT-4.1 nano model replacement","href":"/deprecation-notice/2026/10-20_model_replacements"},{"title":"Legacy monthly billing","href":"/deprecation-notice/2026/09-30_legacy_billing"},{"title":"Legacy browser JavaScript SDK","href":"/deprecation-notice/2026/09-30_create_web_call_v2"},{"title":"Legacy SIP endpoint removed","href":"/deprecation-notice/2026/09-30_sip_legacy_endpoint"},{"title":"Cal.com built-in tools","href":"/deprecation-notice/2026/10-31_legacy_calcom_tools"},{"title":"Update Call restricted to ended calls","href":"/deprecation-notice/2026/08-31_update_call_ended_calls_only"},{"group":"Past Deprecations","pages":[{"title":"Cal.com built-in tools","href":"/deprecation-notice/2026/10-31_legacy_calcom_tools"},{"title":"Legacy get-agent-versions endpoints removed","href":"/deprecation-notice/2026/09-15_get_agent_versions"},{"title":"Update Call restricted to ended calls","href":"/deprecation-notice/2026/08-31_update_call_ended_calls_only"},{"title":"Multilingual agent locale array required","href":"/deprecation-notice/2026/07-31_legacy_multilingual_setting"},{"title":"Legacy agent list endpoints removed","href":"/deprecation-notice/2026/07-31_agent_list_endpoints"},{"title":"Legacy MCP server (retell.stlmcp.com) removed","href":"/deprecation-notice/2026/07-20_legacy_mcp_server"},{"title":"Unified publish-agent-version endpoint","href":"/deprecation-notice/2026/07-20_agent_version_endpoints"},{"title":"ElevenLabs Turbo models replaced with Flash","href":"/deprecation-notice/2026/07-12_elevenlabs_turbo_models"},{"title":"Legacy list endpoints removed for v2/v3","href":"/deprecation-notice/2026/06-15_legacy_list_endpoints"},{"title":"Claude Sonnet and Gemini Flash model upgrades","href":"/deprecation-notice/2026/05-25_model_replacements"},{"title":"Conversation node tools replaced by subagent","href":"/deprecation-notice/2026/04-18_conversation_node_tools"},{"title":"OpenAI Realtime and Cartesia Sonic replaced","href":"/deprecation-notice/2026/04-03_model_replacements"},{"title":"Phone number single-agent fields removed","href":"/deprecation-notice/2026/03-31_phone_number_agent_fields"},{"title":"Explicit cold transfer mode selection","href":"/deprecation-notice/2026/01-23_cold_transfer_mode_selection"}]}]}]}]},"title":"Register Call (Deprecated) - Retell AI","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["b0f84f53ff"],"chunks":["Page-D5fEM6aW.js","ApiExamples-D6l_bzE9.js","utils-BmH1XFxk.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","cloneDeep-izs3Hzxb.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","addUniqueKeysToSchema-BAES3tkd.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js"]}