Welcome to UponAI! This guide will help you build your first agent quickly.
Building your first agent (broad overview)
Login to your account provided for you
Create a new Agent
Navigate to the Agents tab
Select Manage Agents
Click Create from Template
Choose from one of our templates and create your agent
Test Your Agent
Click Start Test Call to see your agent in action.
Next Steps
Check out our in-depth guides to learn how to customize and implement your agent.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"UponAI","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/uponai/Z_4kJsgPYLQAiuNH/images/favicon.webp?fit=max\u0026auto=format\u0026n=Z_4kJsgPYLQAiuNH\u0026q=85\u0026s=22fd99ea2484bdf64edc52775ef82144","dark":"https://mintcdn.com/uponai/Z_4kJsgPYLQAiuNH/images/favicon.webp?fit=max\u0026auto=format\u0026n=Z_4kJsgPYLQAiuNH\u0026q=85\u0026s=22fd99ea2484bdf64edc52775ef82144"},"favicon":"https://mintlify.s3.us-west-1.amazonaws.com/uponai/favicon.svg","navbar":{"links":[{"href":"mailto:support@uponai.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.mintlify.com"}},"footer":{"socials":{"facebook":"https://www.facebook.com/profile.php?id=61573890866561","instagram":"https://www.instagram.com/_uponai_","linkedin":"https://www.linkedin.com/company/uponai?viewAsMember=true","x-twitter":"https://x.com/_UponAI_"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"uponai","hasAudioNarration":false,"actualSubdomain":"uponai","customDomains":["documentation.uponai.com"],"gitSource":{"type":"github","owner":"uponai8192","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae92a31f2a30ac762f68141:success","clientVersion":"0.0.4131","searchFilterCounts":[{"language":"default","tag":"Documentation","count":154},{"language":"default","tag":"Build","count":64},{"language":"default","tag":"API Documentation","count":59},{"language":"default","tag":"Deploy","count":27},{"language":"default","tag":"Setup conversation flow agent","count":22},{"language":"default","tag":"Setup single / multi prompt agent","count":16},{"language":"default","tag":"Accounts and Workspace","count":14},{"language":"default","tag":"Step 2: Add nodes","count":14},{"language":"default","tag":"Reliability \u0026 Debugging","count":12},{"language":"default","tag":"Step 3: Add function calling","count":12}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"index","slug":"/","pageMetadata":{"title":"Getting Started","description":"Welcome to UponAI! This guide will help you build your first agent quickly.","icon":"rocket","href":"/index"},"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: \"Welcome to UponAI! This guide will help you build your first agent quickly.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={li:`li`,ol:`ol`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`building-your-first-agent-broad-overview`,children:`Building your first agent (broad overview)`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsx(_components.li,{children:`Login to your account provided for you`}),`\n`,_jsx(_components.li,{children:`Create a new Agent`}),`\n`,_jsxs(_components.li,{children:[`Navigate to the `,_jsx(_components.strong,{children:`Agents`}),` tab`]}),`\n`,_jsxs(_components.li,{children:[`Select `,_jsx(_components.strong,{children:`Manage Agents`})]}),`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Create from Template`})]}),`\n`,_jsx(_components.li,{children:`Choose from one of our templates and create your agent`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`test-your-agent`,children:`Test Your Agent`}),`\n`,_jsxs(_components.p,{children:[`Click `,_jsx(_components.strong,{children:`Start Test Call`}),` to see your agent in action.`]}),`\n`,_jsx(Heading,{level:`2`,id:`next-steps`,children:`Next Steps`}),`\n`,_jsx(_components.p,{children:`Check out our in-depth guides to learn how to customize and implement your agent.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Getting Started","description":"Welcome to UponAI! This guide will help you build your first agent quickly.","icon":"rocket","href":"/index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Building your first agent (broad overview)","slug":"building-your-first-agent-broad-overview","depth":2,"children":[]},{"title":"Test Your Agent","slug":"test-your-agent","depth":2,"children":[]},{"title":"Next Steps","slug":"next-steps","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"uponai","siteName":"UponAI","title":"Getting Started - UponAI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-14T20:41:54.400Z","originalFileLocation":"index.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=\"Welcome to UponAI! This guide will help you build your first agent quickly.\">\u003cmeta data-mint-head name=\"application-name\" content=\"UponAI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/svg+xml\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/uponai/favicon.svg\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/uponai/favicon.svg\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/uponai/favicon.svg\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/svg+xml\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/uponai/favicon.svg\">\u003cmeta data-mint-head property=\"og:title\" content=\"Getting Started - UponAI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Welcome to UponAI! This guide will help you build your first agent quickly.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"UponAI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://documentation.uponai.com\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://uponai.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Getting+Started\u0026amp;description=Welcome+to+UponAI%21+This+guide+will+help+you+build+your+first+agent+quickly.\u0026amp;theme=339d93954e751f350341c522\u0026amp;signature=276b5f73ae0f15b5672cf053c3ccf6e475364aaf155070c858a88dc45647179a\">\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=\"Getting Started - UponAI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Welcome to UponAI! This guide will help you build your first agent quickly.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://uponai.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Getting+Started\u0026amp;description=Welcome+to+UponAI%21+This+guide+will+help+you+build+your+first+agent+quickly.\u0026amp;theme=339d93954e751f350341c522\u0026amp;signature=276b5f73ae0f15b5672cf053c3ccf6e475364aaf155070c858a88dc45647179a\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/uponai/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"UponAI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://documentation.uponai.com\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/index.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"UponAI\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"UponAI\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/index.md","siteName":"UponAI","nav":{"global":null,"tabs":[{"tab":"Documentation","groups":[{"group":"Begin Your AI Journey","pages":[{"title":"Introduction","href":"/getting-started"},{"title":"Build Your First Phone Agent in 5 Minutes","href":"/getting-started/quick-start"},{"title":"SDKs","href":"/getting-started/sdk"},{"title":"MCP Server","href":"/getting-started/mcp-server"}]},{"group":"Build","pages":[{"group":"Setup single / multi prompt agent","pages":[{"group":"Step 1: Write the prompt","pages":[{"title":"Single/Multi Prompt Agent Overview","href":"/build/prompt-overview"},{"title":"Write a Single Prompt","href":"/build/write-single-prompt"},{"title":"Build a Multi-Prompt Agent","href":"/build/build-multi-prompt"}]},{"title":"Step 2: Configure the Basic Settings","href":"/build/configure-basic-settings"},{"group":"Step 3: Add function calling","pages":[{"title":"Function Calling Overview","href":"/build/function-calling-overview"},{"title":"End Call","href":"/build/end-call"},{"title":"Transfer Call","href":"/build/transfer-call"},{"title":"Send SMS","href":"/build/send-sms"},{"title":"Check Calendar Availability","href":"/build/check-calendar-availability"},{"title":"Book Calendar","href":"/build/book-calendar"},{"title":"Press Digit (IVR Navigation)","href":"/build/press-digit"},{"title":"Integrate Any System with Custom Functions","href":"/build/custom-function"},{"title":"Code Tool","href":"/build/code-tool"},{"title":"Extract Dynamic Variables","href":"/build/extract-dynamic-variables"},{"title":"Agent Transfer","href":"/build/agent-transfer"},{"title":"MCP","href":"/build/mcp"}]}]},{"group":"Setup conversation flow agent","pages":[{"title":"Conversation Flow Overview","href":"/build/conversation-flow/overview"},{"title":"Step 1: Configure Global Settings","href":"/build/conversation-flow/global-setting"},{"group":"Step 2: Add nodes","pages":[{"title":"Step 2: Add Nodes","href":"/build/conversation-flow/node"},{"title":"Conversation Node","href":"/build/conversation-flow/conversation-node"},{"title":"End Node","href":"/build/conversation-flow/end-node"},{"title":"Call Transfer Node","href":"/build/conversation-flow/call-transfer-node"},{"title":"Extract Dynamic Variable Node","href":"/build/conversation-flow/extract-dv-node"},{"title":"Function Node","href":"/build/conversation-flow/function-node"},{"title":"Code Node","href":"/build/conversation-flow/code-node"},{"title":"Press Digit Node","href":"/build/conversation-flow/press-digit-node"},{"title":"SMS Node","href":"/build/conversation-flow/sms-node"},{"title":"Logic Split Node","href":"/build/conversation-flow/logic-split-node"},{"title":"Subagent Node","href":"/build/conversation-flow/subagent-node"},{"title":"MCP Node","href":"/build/conversation-flow/mcp-node"},{"title":"Agent Transfer Node","href":"/build/conversation-flow/transfer-agent-node"},{"title":"Global Node","href":"/build/conversation-flow/global-node"}]},{"title":"Step 3: Add Transition Conditions","href":"/build/conversation-flow/transition-condition"},{"title":"Components","href":"/build/conversation-flow/components"},{"title":"Flex Mode","href":"/build/conversation-flow/flex-mode"},{"group":"Advanced features","pages":[{"title":"Fine-tune Examples","href":"/build/conversation-flow/finetune-examples"},{"title":"Custom Functions","href":"/build/conversation-flow/custom-function"}]},{"title":"Debug Guide","href":"/build/conversation-flow/debug-guide"}]},{"group":"Language \u0026 Chat","pages":[{"title":"Set Language for Your Agent","href":"/build/set-language"},{"title":"Configure a Multilingual Agent","href":"/build/configure-multilingual"},{"title":"Create Chat Agent","href":"/build/create-chat-agent"}]},{"group":"Understand User Speech","pages":[{"title":"Speech Recognition Provider Comparison","href":"/build/asr-provider-comparison"},{"title":"Balance Transcription Accuracy and Latency","href":"/build/transcription-mode"},{"title":"Handle Background Speech and Noise","href":"/build/handle-background-noise"}]},{"group":"Generate Better Responses from LLM","pages":[{"title":"Agent Handbook","href":"/build/agent-handbook"},{"title":"Prompt Engineering Guide","href":"/build/prompt-engineering-guide"},{"title":"Prompt Guide and Examples for Specific Situations","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/choose-custom-voice"},{"title":"Platform Voices","href":"/build/platform-voices"},{"title":"TTS Provider Comparison","href":"/build/tts-provider-comparison"},{"title":"Add Custom Pronunciation","href":"/build/add-pronunciation"},{"title":"Add Backchannel","href":"/build/add-backchannel"},{"title":"Make Agent Hold and Respond Nothing","href":"/build/no-response"},{"title":"Add Pause or Read Slowly","href":"/build/add-pause"},{"title":"Setup 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 and Parse Custom SIP Headers","href":"/build/sip-headers"}]},{"group":"Provide Context to the Agent","pages":[{"title":"Knowledge Base","href":"/build/knowledge-base"},{"title":"Dynamic Variables","href":"/build/dynamic-variables"}]},{"title":"Guardrails","href":"/build/guardrails"},{"title":"AI Agent Settings","href":"/build/advanced-customization"},{"title":"Understanding Functions","href":"/build/functions"}]},{"group":"Test","pages":[{"title":"Testing Overview","href":"/Test/test-overview"},{"group":"LLM Playground","pages":[{"title":"LLM Playground","href":"/Test/llm-playground"},{"title":"Debug Agent Responses","href":"/Test/llm-playground-debug"}]},{"group":"LLM Simulation Testing","pages":[{"title":"LLM Simulation Testing","href":"/Test/llm-simulation-testing"},{"title":"Batch Test Simulation","href":"/Test/batch-test-simulation"}]},{"group":"Audio Testing","pages":[{"title":"Phone Call Testing","href":"/Test/test-phone"},{"title":"Web Call Testing","href":"/Test/test-web"}]}]},{"group":"Deploy","pages":[{"title":"Purchase Phone Number","href":"/Deploy/purchase-number"},{"title":"A/B Testing","href":"/Deploy/ab-testing"},{"group":"Connect to custom telephony via SIP","pages":[{"title":"Custom Telephony","href":"/Deploy/custom-telephony"},{"title":"Connect Twilio via SIP Trunking","href":"/Deploy/twilio"},{"title":"Connect Telnyx via SIP Trunking","href":"/Deploy/telnyx"},{"title":"Connect Vonage via SIP Trunking","href":"/Deploy/vonage"},{"title":"Connect Amazon Connect","href":"/Deploy/amazon-connect"},{"title":"Connect Avaya via SIP Trunking","href":"/Deploy/avaya"},{"title":"Connect Five9","href":"/Deploy/five9"},{"title":"Connect Genesys via SIP Trunking","href":"/Deploy/genesys"}]},{"group":"Make \u0026 receive phone calls","pages":[{"title":"Receive Calls","href":"/Deploy/inbound-call"},{"title":"Outbound Calls","href":"/Deploy/outbound-call"}]},{"title":"International Calling and Fees","href":"/Deploy/international-call"},{"title":"Create Chat Completion","href":"/Deploy/create-chat-completion"},{"title":"Website Widget","href":"/Deploy/chat-widget"},{"title":"Send \u0026 Receive SMS","href":"/Deploy/enable-sms"},{"title":"Create Batch Calls","href":"/Deploy/make-batch-call"},{"title":"Setup Versioning for Agents","href":"/Deploy/agent-versioning"},{"title":"Compare Agent Versions","href":"/Deploy/version-comparison"},{"group":"Increase call pickup rate","pages":[{"title":"Spam Likely Overview","href":"/Deploy/call-pickup-rate/spam-likely"},{"title":"Add a Business Profile","href":"/Deploy/call-pickup-rate/business-profile"},{"title":"Apply for Verified Phone Number","href":"/Deploy/call-pickup-rate/verified-phone"},{"title":"Apply for Branded Call","href":"/Deploy/call-pickup-rate/branded-call"},{"title":"Handle Application Rejection","href":"/Deploy/call-pickup-rate/handle-rejection"},{"title":"Stop the Service","href":"/Deploy/call-pickup-rate/stop-service"}]},{"title":"Connect to Web Call","href":"/Deploy/web-call"},{"title":"Understand Concurrency \u0026 Limits","href":"/Deploy/concurrency"}]},{"group":"Monitor","pages":[{"title":"Monitor Sessions via Dashboard","href":"/Monitor/session-history"},{"title":"Get Analytics Insight","href":"/Monitor/analytics-dashboard"},{"title":"Alerting","href":"/Monitor/alerting"},{"group":"Webhooks","pages":[{"title":"Webhook Overview","href":"/Monitor/webhook-overview"},{"title":"Register \u0026 Handle Webhooks","href":"/Monitor/register-webhook"},{"title":"Secure the Webhook","href":"/Monitor/secure-webhook"},{"title":"Inbound Call Webhook","href":"/Monitor/inbound-webhook"}]},{"group":"Post Call Analysis","pages":[{"title":"Post Call Analysis Overview","href":"/Monitor/post-call-analysis/overview"},{"title":"Define the Information You Want to Extract","href":"/Monitor/post-call-analysis/define-fields"},{"title":"Consume the Analysis Data","href":"/Monitor/post-call-analysis/consume-data"},{"title":"Rerun Post-Call/Chat Analysis","href":"/Monitor/post-call-analysis/rerun-analysis"}]}]},{"group":"Reliability \u0026 Debugging","pages":[{"title":"Reliability Overview","href":"/Reliability/reliability-overview"},{"group":"Latency","pages":[{"title":"Check Actual Latency","href":"/Reliability/latency/check-actual-latency"},{"title":"Check Estimated Latency","href":"/Reliability/latency/check-estimated-latency"},{"title":"Troubleshoot High Latency","href":"/Reliability/latency/troubleshoot-latency"}]},{"group":"Fix Agent Behaviors","pages":[{"title":"Debug Wrong Response","href":"/Reliability/fix-behaviors/wrong-response"},{"title":"Increase Transcription Accuracy","href":"/Reliability/fix-behaviors/wrong-transcript"}]},{"group":"Debug","pages":[{"title":"Debug Call Disconnection","href":"/Reliability/debug/debug-call-disconnect"},{"title":"Debug Call Transfer Failure","href":"/Reliability/debug/debug-call-transfer"},{"title":"Debug Outbound Connection Issues","href":"/Reliability/debug/debug-outbound-call"},{"title":"Debug SIP Calls Using PCAP","href":"/Reliability/debug/debug-calls-pcap"}]},{"title":"Prevent Abuse","href":"/Reliability/prevent-abuse"},{"title":"Fraud Protection","href":"/Reliability/fraud-protection"}]},{"group":"Accounts and Workspace","pages":[{"title":"Workspace","href":"/Accounts/workspace"},{"title":"Account","href":"/Accounts/account"},{"title":"Access Control","href":"/Accounts/access-control"},{"title":"KYC Verification","href":"/Accounts/kyc"},{"group":"Billing","pages":[{"title":"Billing Overview","href":"/Accounts/billing/billing-overview"},{"title":"Billing Exceptions","href":"/Accounts/billing/billing-exceptions"},{"title":"Add Payment Method","href":"/Accounts/billing/add-payment"},{"title":"Handle Failed Payments","href":"/Accounts/billing/fail-payment"}]},{"group":"Keys","pages":[{"title":"API Key Overview","href":"/Accounts/keys/api-keys-overview"},{"title":"Manage API Keys","href":"/Accounts/keys/manage-api-keys"},{"title":"Public Keys","href":"/Accounts/keys/public-keys"}]},{"group":"Privacy","pages":[{"title":"Data Storage Settings","href":"/Accounts/privacy/data-storage"},{"title":"Data Retention Policy","href":"/Accounts/privacy/data-retention"},{"title":"Secure URLs","href":"/Accounts/privacy/signed-secure-url"}]}]},{"group":"Other Topics","pages":[{"group":"Custom LLM","pages":[{"title":"Custom LLM Overview","href":"/custom-llm/overview"},{"title":"Setup WebSocket Server","href":"/custom-llm/setup-websocket-server"},{"title":"Integrate LLM","href":"/custom-llm/integrate-llm"},{"title":"Integrate Function Calling","href":"/custom-llm/integrate-function-calling"},{"title":"Troubleshooting Guide","href":"/custom-llm/troubleshooting"},{"title":"Custom LLM Best Practices","href":"/custom-llm/llm-best-practices"}]},{"title":"Audio Basics","href":"/audio-basics"}]},{"group":"Integrations","pages":[{"title":"HubSpot Integration","href":"/Integrations/hubspot"}]},{"group":"AI Quality Assurance","pages":[{"title":"AI Quality Assurance","href":"/ai-qa/overview"},{"group":"Create QA","pages":[{"title":"Get Started","href":"/ai-qa/get-started"},{"title":"Define 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/ai-qa-metrics"},{"title":"Address Metric Issues","href":"/ai-qa/address-metric-issues"}]}]},{"tab":"API Documentation","groups":[{"group":"Calls","pages":[{"title":"Create phone call","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/calls/initiate","href":"/api-reference/calls/create-phone-call"},{"title":"Create web call","deprecated":null,"version":null,"openapi":"/openapi.json post /api/calls/web","href":"/api-reference/calls/create-web-call"},{"title":"List calls","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/calls","href":"/api-reference/calls/list-calls"},{"title":"Fetch call history","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/calls/history","href":"/api-reference/calls/fetch-call-history"},{"title":"Get call","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/calls/{callId}","href":"/api-reference/calls/get-call"},{"title":"Update call","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/calls/{callId}","href":"/api-reference/calls/update-call"}]},{"group":"LLM Models","pages":[{"title":"List LLMs","deprecated":null,"version":null,"openapi":"/openapi.json get /api/llms","href":"/api-reference/llm-models/list-llms"},{"title":"Create LLM","deprecated":null,"version":null,"openapi":"/openapi.json post /api/llms","href":"/api-reference/llm-models/create-llm"},{"title":"Get LLM","deprecated":null,"version":null,"openapi":"/openapi.json get /api/llms/{llmId}","href":"/api-reference/llm-models/get-llm"},{"title":"Delete LLM","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/llms/{llmId}","href":"/api-reference/llm-models/delete-llm"},{"title":"Update LLM","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/llms/{llmId}","href":"/api-reference/llm-models/update-llm"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/openapi.json get /api/agents","href":"/api-reference/agents/list-agents"},{"title":"Create agent","deprecated":null,"version":null,"openapi":"/openapi.json post /api/agents","href":"/api-reference/agents/create-agent"},{"title":"Get agent","deprecated":null,"version":null,"openapi":"/openapi.json get /api/agents/{agentId}","href":"/api-reference/agents/get-agent"},{"title":"Delete agent","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/agents/{agentId}","href":"/api-reference/agents/delete-agent"},{"title":"Update agent","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/agents/{agentId}","href":"/api-reference/agents/update-agent"},{"title":"List agent versions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/agents/{agentId}/versions","href":"/api-reference/agents/list-agent-versions"}]},{"group":"Chat Agents","pages":[{"title":"List chat agents","deprecated":null,"version":null,"openapi":"/openapi.json get /api/chat-agents","href":"/api-reference/chat-agents/list-chat-agents"},{"title":"Create chat agent","deprecated":null,"version":null,"openapi":"/openapi.json post /api/chat-agents","href":"/api-reference/chat-agents/create-chat-agent"},{"title":"Get chat agent","deprecated":null,"version":null,"openapi":"/openapi.json get /api/chat-agents/{agentId}","href":"/api-reference/chat-agents/get-chat-agent"},{"title":"Delete chat agent","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/chat-agents/{agentId}","href":"/api-reference/chat-agents/delete-chat-agent"},{"title":"Update chat agent","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/chat-agents/{agentId}","href":"/api-reference/chat-agents/update-chat-agent"},{"title":"List chat agent versions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/chat-agents/{agentId}/versions","href":"/api-reference/chat-agents/list-chat-agent-versions"},{"title":"Publish chat agent draft","deprecated":null,"version":null,"openapi":"/openapi.json post /api/chat-agents/{agentId}/publish","href":"/api-reference/chat-agents/publish-chat-agent-draft"}]},{"group":"Chats","pages":[{"title":"List chats","deprecated":null,"version":null,"openapi":"/openapi.json get /api/chats","href":"/api-reference/chats/list-chats"},{"title":"Create chat","deprecated":null,"version":null,"openapi":"/openapi.json post /api/chats","href":"/api-reference/chats/create-chat"},{"title":"Create outbound SMS chat","deprecated":null,"version":null,"openapi":"/openapi.json post /api/chats/outbound-sms","href":"/api-reference/chats/create-outbound-sms-chat"},{"title":"Get chat","deprecated":null,"version":null,"openapi":"/openapi.json get /api/chats/{chatId}","href":"/api-reference/chats/get-chat"},{"title":"Update chat","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/chats/{chatId}","href":"/api-reference/chats/update-chat"},{"title":"Create chat completion","deprecated":null,"version":null,"openapi":"/openapi.json post /api/chats/{chatId}/completions","href":"/api-reference/chats/create-chat-completion"},{"title":"End chat","deprecated":null,"version":null,"openapi":"/openapi.json post /api/chats/{chatId}/end","href":"/api-reference/chats/end-chat"}]},{"group":"Conversation Flows","pages":[{"title":"List conversation flows","deprecated":null,"version":null,"openapi":"/openapi.json get /api/conversation-flows","href":"/api-reference/conversation-flows/list-conversation-flows"},{"title":"Create conversation flow","deprecated":null,"version":null,"openapi":"/openapi.json post /api/conversation-flows","href":"/api-reference/conversation-flows/create-conversation-flow"},{"title":"Get conversation flow","deprecated":null,"version":null,"openapi":"/openapi.json get /api/conversation-flows/{conversationFlowId}","href":"/api-reference/conversation-flows/get-conversation-flow"},{"title":"Delete conversation flow","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/conversation-flows/{conversationFlowId}","href":"/api-reference/conversation-flows/delete-conversation-flow"},{"title":"Update conversation flow","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/conversation-flows/{conversationFlowId}","href":"/api-reference/conversation-flows/update-conversation-flow"}]},{"group":"Knowledge Bases","pages":[{"title":"List knowledge bases","deprecated":null,"version":null,"openapi":"/openapi.json get /api/knowledge-bases","href":"/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"Create knowledge base","deprecated":null,"version":null,"openapi":"/openapi.json post /api/knowledge-bases","href":"/api-reference/knowledge-bases/create-knowledge-base"},{"title":"Get knowledge base","deprecated":null,"version":null,"openapi":"/openapi.json get /api/knowledge-bases/{knowledgeBaseId}","href":"/api-reference/knowledge-bases/get-knowledge-base"},{"title":"Delete knowledge base","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/knowledge-bases/{knowledgeBaseId}","href":"/api-reference/knowledge-bases/delete-knowledge-base"},{"title":"Add knowledge base sources","deprecated":null,"version":null,"openapi":"/openapi.json post /api/knowledge-bases/{knowledgeBaseId}/sources","href":"/api-reference/knowledge-bases/add-knowledge-base-sources"},{"title":"Delete knowledge base source","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/knowledge-bases/{knowledgeBaseId}/sources/{sourceId}","href":"/api-reference/knowledge-bases/delete-knowledge-base-source"}]},{"group":"Voices","pages":[{"title":"List voices","deprecated":null,"version":null,"openapi":"/openapi.json get /api/voices","href":"/api-reference/voices/list-voices"},{"title":"Search community voices","deprecated":null,"version":null,"openapi":"/openapi.json post /api/voices/search","href":"/api-reference/voices/search-community-voices"},{"title":"Add community voice","deprecated":null,"version":null,"openapi":"/openapi.json post /api/voices/community","href":"/api-reference/voices/add-community-voice"},{"title":"Clone voice","deprecated":null,"version":null,"openapi":"/openapi.json post /api/voices/clone","href":"/api-reference/voices/clone-voice"},{"title":"Get voice","deprecated":null,"version":null,"openapi":"/openapi.json get /api/voices/{voiceId}","href":"/api-reference/voices/get-voice"},{"title":"Stream voice sample","deprecated":null,"version":null,"openapi":"/openapi.json get /api/voices/{voiceId}/sample","href":"/api-reference/voices/stream-voice-sample"}]},{"group":"Test Case Definitions","pages":[{"title":"List test case definitions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/test-case-definitions","href":"/api-reference/test-case-definitions/list-test-case-definitions"},{"title":"Create test case definition","deprecated":null,"version":null,"openapi":"/openapi.json post /api/test-case-definitions","href":"/api-reference/test-case-definitions/create-test-case-definition"},{"title":"Get test case definition","deprecated":null,"version":null,"openapi":"/openapi.json get /api/test-case-definitions/{testCaseDefinitionId}","href":"/api-reference/test-case-definitions/get-test-case-definition"},{"title":"Update test case definition","deprecated":null,"version":null,"openapi":"/openapi.json put /api/test-case-definitions/{testCaseDefinitionId}","href":"/api-reference/test-case-definitions/update-test-case-definition"},{"title":"Delete test case definition","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/test-case-definitions/{testCaseDefinitionId}","href":"/api-reference/test-case-definitions/delete-test-case-definition"}]},{"group":"Test Runs","pages":[{"title":"Get test run","deprecated":null,"version":null,"openapi":"/openapi.json get /api/test-runs/{testCaseJobId}","href":"/api-reference/test-runs/get-test-run"},{"title":"List test runs by batch","deprecated":null,"version":null,"openapi":"/openapi.json get /api/test-runs/batches/{testCaseBatchJobId}","href":"/api-reference/test-runs/list-test-runs-by-batch"}]},{"group":"Account","pages":[{"title":"Get concurrency","deprecated":null,"version":null,"openapi":"/openapi.json get /api/concurrency","href":"/api-reference/account/get-concurrency"},{"title":"List workspaces","deprecated":null,"version":null,"openapi":"/openapi.json get /api/workspaces","href":"/api-reference/account/list-workspaces"}]},{"group":"Phone Numbers","pages":[{"title":"List phone numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /api/numbers/{accountSid}","href":"/api-reference/phone-numbers/list-phone-numbers"},{"title":"Update phone number assignment","deprecated":null,"version":null,"openapi":"/openapi.json put /api/numbers/{number}/agent","href":"/api-reference/phone-numbers/update-phone-number-assignment"}]}]}]},"basePath":"","title":"Getting Started - UponAI","buildId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","deploymentId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","dynamics":[],"chunks":[]}