Understand how API keys are used to authenticate requests to the UponAI platform.
API keys authenticate your requests to:
REST API endpoints
SDK integrations
Webhook endpoints
Each workspace can have multiple API keys, all sharing the same permission level.
REST API Authentication
Include your API key in the Authorization header of every request:
Authorization: Bearer YOUR_API_KEY
Webhook API Key
For security, UponAI automatically designates one of your API keys for webhook authentication. This designated webhook key:
Signs and verifies webhook requests
Cannot be deleted
Ensures your webhook endpoints only receive legitimate requests
Never share API keys in public repositories or client-side code. If a key is compromised, delete it immediately and create a new one.
{"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.4143","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":"Accounts/keys/api-keys-overview","slug":"/Accounts/keys/api-keys-overview","pageMetadata":{"title":"API Key Overview","description":"Understand how API keys are used to authenticate requests to the UponAI platform.","href":"/Accounts/keys/api-keys-overview"},"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: \"Understand how API keys are used to authenticate requests to the UponAI platform.\"\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={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`API keys authenticate your requests to:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`REST API endpoints`}),`\n`,_jsx(_components.li,{children:`SDK integrations`}),`\n`,_jsx(_components.li,{children:`Webhook endpoints`}),`\n`]}),`\n`,_jsx(_components.p,{children:`Each workspace can have multiple API keys, all sharing the same permission level.`}),`\n`,_jsx(Heading,{level:`2`,id:`rest-api-authentication`,children:`REST API Authentication`}),`\n`,_jsxs(_components.p,{children:[`Include your API key in the `,_jsx(_components.code,{children:`Authorization`}),` header of every request:`]}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Authorization: Bearer YOUR_API_KEY`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`2`,id:`webhook-api-key`,children:`Webhook API Key`}),`\n`,_jsx(_components.p,{children:`For security, UponAI automatically designates one of your API keys for webhook authentication. This designated webhook key:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Signs and verifies webhook requests`}),`\n`,_jsx(_components.li,{children:`Cannot be deleted`}),`\n`,_jsx(_components.li,{children:`Ensures your webhook endpoints only receive legitimate requests`}),`\n`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Never share API keys in public repositories or client-side code. If a key is compromised, delete it immediately and create a new one.`})})]})}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":"API Key Overview","description":"Understand how API keys are used to authenticate requests to the UponAI platform.","href":"/Accounts/keys/api-keys-overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"REST API Authentication","slug":"rest-api-authentication","depth":2,"children":[]},{"title":"Webhook API Key","slug":"webhook-api-key","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"uponai","siteName":"UponAI","title":"API Key Overview - UponAI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-18T15:07:10.212Z","originalFileLocation":"Accounts/keys/api-keys-overview.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=\"Understand how API keys are used to authenticate requests to the UponAI platform.\">\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=\"API Key Overview - UponAI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Understand how API keys are used to authenticate requests to the UponAI platform.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"UponAI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://documentation.uponai.com/Accounts/keys/api-keys-overview\">\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=Keys\u0026amp;title=API+Key+Overview\u0026amp;description=Understand+how+API+keys+are+used+to+authenticate+requests+to+the+UponAI+platform.\u0026amp;theme=339d93954e751f350341c522\u0026amp;signature=35475e5da01ed36a0a49110375cd5b2227aa5c5228861072d842592b7b70728e\">\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=\"API Key Overview - UponAI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Understand how API keys are used to authenticate requests to the UponAI platform.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://uponai.mintlify.site/_mintlify/api/og/v2?division=Keys\u0026amp;title=API+Key+Overview\u0026amp;description=Understand+how+API+keys+are+used+to+authenticate+requests+to+the+UponAI+platform.\u0026amp;theme=339d93954e751f350341c522\u0026amp;signature=35475e5da01ed36a0a49110375cd5b2227aa5c5228861072d842592b7b70728e\">\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/Accounts/keys/api-keys-overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/Accounts/keys/api-keys-overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://documentation.uponai.com/#organization\",\"name\":\"UponAI\",\"url\":\"https://documentation.uponai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/uponai/Z_4kJsgPYLQAiuNH/images/favicon.webp?fit=max\u0026auto=format\u0026n=Z_4kJsgPYLQAiuNH\u0026q=85\u0026s=22fd99ea2484bdf64edc52775ef82144\"}},{\"@type\":\"WebSite\",\"@id\":\"https://documentation.uponai.com#website\",\"name\":\"UponAI\",\"url\":\"https://documentation.uponai.com\",\"publisher\":{\"@id\":\"https://documentation.uponai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://documentation.uponai.com/Accounts/keys/api-keys-overview#webpage\",\"url\":\"https://documentation.uponai.com/Accounts/keys/api-keys-overview\",\"name\":\"API Key Overview\",\"description\":\"Understand how API keys are used to authenticate requests to the UponAI platform.\",\"dateModified\":\"2026-05-18T15:07:10.212Z\",\"isPartOf\":{\"@id\":\"https://documentation.uponai.com#website\"},\"breadcrumb\":{\"@id\":\"https://documentation.uponai.com/Accounts/keys/api-keys-overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://documentation.uponai.com/Accounts/keys/api-keys-overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accounts and Workspace\",\"item\":\"https://documentation.uponai.com/Accounts/workspace\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Key Overview\",\"item\":\"https://documentation.uponai.com/Accounts/keys/api-keys-overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://documentation.uponai.com/Accounts/keys/api-keys-overview#article\",\"headline\":\"API Key Overview\",\"name\":\"API Key Overview\",\"description\":\"Understand how API keys are used to authenticate requests to the UponAI platform.\",\"url\":\"https://documentation.uponai.com/Accounts/keys/api-keys-overview\",\"mainEntityOfPage\":{\"@id\":\"https://documentation.uponai.com/Accounts/keys/api-keys-overview#webpage\"},\"dateModified\":\"2026-05-18T15:07:10.212Z\",\"publisher\":{\"@id\":\"https://documentation.uponai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://documentation.uponai.com#website\"}}]}\u003c/script>\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":"/Accounts/keys/api-keys-overview.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","description":"Resolve payment failures and restore your UponAI service.","href":"/Accounts/billing/fail-payment"}]},{"group":"Keys","pages":[{"title":"API Key Overview","href":"/Accounts/keys/api-keys-overview"},{"title":"Manage API Keys","description":"Create, delete, and configure API keys in your UponAI workspace.","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","pages":[{"title":"API Documentation","href":"/api-reference/calls/create-phone-call"}]}]},"basePath":"","title":"API Key Overview - UponAI","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":[],"chunks":[]}