The Bolna API enables you to programmatically create, configure, and manage Voice AI agents from your own applications. Whether you are building complex workflows, automating customer support, or integrating voice capabilities into your existing products, our REST API provides everything you need.The API uses predictable, resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and authentication.
You must have an active Bolna account to generate and use API keys. If you don’t have one, sign up here.
All Bolna API endpoints require authentication using an API key. You must include this key in the Authorization header of all your HTTP requests using the Bearer scheme.
Log in to the Bolna Dashboard. In the left sidebar, expand the Developers group and select API Keys.
Open Developers → API Keys in the Bolna Dashboard
2
Create a new API Key
Click the Create a new API Key button to generate your unique authentication credentials.
Click 'Create a new API Key' to generate your credentials
3
Save your API Key securely
Your newly generated API key will be displayed in a pop-up modal. Copy this key and save it securely.
Copy and save your API Key - it won't be shown again
For your security, the API key will only be shown once. If you lose your API key, you will need to delete it and generate a new one.
API keys generated for a Subaccount will start with sa-.
Was this page helpful?
⌘I
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Bolna Docs","description":"Quickly build and deploy conversational Voice AI agents","colors":{"primary":"#2563EB","light":"#BAE6FD","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/bolna-54a2d4fe/n6ISBDZpjo2_6G0U/logo/bolna-logo.png?fit=max\u0026auto=format\u0026n=n6ISBDZpjo2_6G0U\u0026q=85\u0026s=1df42427a7bac4c04ba42e35c42aaff5","dark":"https://mintcdn.com/bolna-54a2d4fe/PGaphb2L1IE-6aKF/logo/Bolna-white.png?fit=max\u0026auto=format\u0026n=PGaphb2L1IE-6aKF\u0026q=85\u0026s=8a0baa4c200add0fe463dfde6bcb10d6","href":"https://www.bolna.ai/docs"},"favicon":"https://mintcdn.com/bolna-54a2d4fe/mJ1zPF3eB4Dyupzj/favicon1.ico?fit=max\u0026auto=format\u0026n=mJ1zPF3eB4Dyupzj\u0026q=85\u0026s=2c2d3c96d1d4add97ebe430ade591aa3","api":{"openapi":"api-reference/openapi.yml"},"background":{"decoration":"grid"},"navbar":{"links":[{"icon":"globe","href":"https://status.bolna.ai","label":"Status"},{"icon":"slack","href":"https://www.bolna.ai/join-slack","label":"Ask us on Slack"},{"icon":"gauge","href":"https://platform.bolna.ai/sign-up","label":"Platform"}]},"footer":{"socials":{"website":"https://platform.bolna.ai","github":"https://github.com/bolna-ai/bolna","slack":"https://www.bolna.ai/join-slack"}},"seo":{"metatags":{"og:type":"website","og:site_name":"Bolna AI Documentation","canonical":"https://www.bolna.ai/docs"},"organization":{"id":"https://www.bolna.ai/#organization","name":"Bolna AI","legalName":"Whismurwave Inc.","url":"https://www.bolna.ai","logo":"https://www.bolna.ai/logos/logo-black.png","sameAs":["https://www.linkedin.com/company/bolna-ai/","https://www.ycombinator.com/companies/bolna-ai","https://github.com/bolna-ai","https://x.com/bolna_dev","https://www.youtube.com/@BolnaVoiceAI"]}},"styling":{"codeblocks":"system","latex":false},"integrations":{"ga4":{"measurementId":"G-BJ5QXHE52P"},"gtm":{"tagId":"GTM-53BBWG2J"}},"contextual":{"options":["copy","view","chatgpt","claude","add-mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bolna-54a2d4fe","hasAudioNarration":false,"actualSubdomain":"bolna-54a2d4fe","customDomains":["www.bolna.ai"],"gitSource":{"type":"github","owner":"bolna-ai","repo":"docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae422c54c0541032179f27d","collectionId":"cd9adaf4-bff3-4950-8bb2-efdb6dd4b346","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae422c54c0541032179f27d"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae422c54c0541032179f27d","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Voice Agents","count":155},{"language":"default","tag":"API Reference","count":137},{"language":"default","tag":"Build","count":76},{"language":"default","tag":"Deploy","count":58},{"language":"default","tag":"Integrations","count":58},{"language":"default","tag":"Workflows","count":57},{"language":"default","tag":"Voice agents","count":42},{"language":"default","tag":"Developers","count":41},{"language":"default","tag":"AI models","count":40},{"language":"default","tag":"Telephony","count":36}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@bolna.ai"}},"basePath":"/docs","hasChatPermissions":false,"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":"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":"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":"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":"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":"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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"#banner{background-color:#60a5fa!important}img[src*=Bolna-white],img[src*=bolna-logo]{height:52px!important;width:auto!important;max-height:unset!important;max-width:unset!important}.update-container{flex-direction:column!important;align-items:stretch!important}.update-container>div:first-child{position:static!important;width:auto!important;margin-bottom:.5rem}#content-container,#content-container :is(p, li, td, th, dd, dt, span, div){hyphens:none!important;-webkit-hyphens:none!important}#content-container code:not(pre code){word-break:normal!important;overflow-wrap:break-word!important}"}],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Bolna API documentation","sidebarTitle":"API overview","description":"Use and leverage Bolna Voice AI using APIs through HTTP requests from any language in your applications and workflows.","icon":"code","iconType":"solid","href":"/api-reference/introduction"},"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: \"Use and leverage Bolna Voice AI using APIs through HTTP requests from any language in your applications and workflows.\"\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={a:`a`,code:`code`,hr:`hr`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Frame,Heading,OptimizedImage,Step,Steps,Tip,Warning}=_components;if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`what-is-the-bolna-api`,children:`What is the Bolna API?`}),`\n`,_jsx(_components.p,{children:`The Bolna API enables you to programmatically create, configure, and manage Voice AI agents from your own applications. Whether you are building complex workflows, automating customer support, or integrating voice capabilities into your existing products, our REST API provides everything you need.`}),`\n`,_jsx(_components.p,{children:`The API uses predictable, resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and authentication.`}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`You must have an active Bolna account to generate and use API keys. If you don’t have one, `,_jsx(_components.a,{href:`https://platform.bolna.ai`,children:`sign up here`}),`.`]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`All Bolna API endpoints require authentication using an API key. You must include this key in the `,_jsx(_components.code,{children:`Authorization`}),` header of all your HTTP requests using the `,_jsx(_components.code,{children:`Bearer`}),` scheme.`]}),`\n`,_jsx(Heading,{level:`3`,id:`how-to-generate-an-api-key`,children:`How to generate an API key`}),`\n`,_jsxs(Steps,{children:[_jsxs(Step,{title:`Navigate to API Keys`,children:[_jsxs(_components.p,{children:[`Log in to the `,_jsx(_components.a,{href:`https://platform.bolna.ai`,children:`Bolna Dashboard`}),`. In the left sidebar, expand the `,_jsx(_components.strong,{children:`Developers`}),` group and select `,_jsx(_components.strong,{children:`API Keys`}),`.`]}),_jsx(Frame,{caption:`Open Developers → API Keys in the Bolna Dashboard`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/bolna-54a2d4fe/vO9SaOM8uLqcCkOh/images/api_introduction_1.1.png?fit=max\u0026auto=format\u0026n=vO9SaOM8uLqcCkOh\u0026q=85\u0026s=a2f79446775064b9ad4899455cef1eee`,alt:`Bolna dashboard sidebar showing the Developers group with the API Keys item`,\"data-og-width\":`1512`,width:`1512`,\"data-og-height\":`900`,height:`900`,\"data-path\":`images/api_introduction_1.1.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/bolna-54a2d4fe/vO9SaOM8uLqcCkOh/images/api_introduction_1.1.png?w=280\u0026fit=max\u0026auto=format\u0026n=vO9SaOM8uLqcCkOh\u0026q=85\u0026s=376214bc5c32d396b3dd850a37916d73 280w, https://mintcdn.com/bolna-54a2d4fe/vO9SaOM8uLqcCkOh/images/api_introduction_1.1.png?w=560\u0026fit=max\u0026auto=format\u0026n=vO9SaOM8uLqcCkOh\u0026q=85\u0026s=404ff003c4f038f428d364065c0de938 560w, https://mintcdn.com/bolna-54a2d4fe/vO9SaOM8uLqcCkOh/images/api_introduction_1.1.png?w=840\u0026fit=max\u0026auto=format\u0026n=vO9SaOM8uLqcCkOh\u0026q=85\u0026s=10c7ad789b8ff15dffb279403c0372cd 840w, https://mintcdn.com/bolna-54a2d4fe/vO9SaOM8uLqcCkOh/images/api_introduction_1.1.png?w=1100\u0026fit=max\u0026auto=format\u0026n=vO9SaOM8uLqcCkOh\u0026q=85\u0026s=3404baf23cf6cb9bfabecb41d393273c 1100w, https://mintcdn.com/bolna-54a2d4fe/vO9SaOM8uLqcCkOh/images/api_introduction_1.1.png?w=1650\u0026fit=max\u0026auto=format\u0026n=vO9SaOM8uLqcCkOh\u0026q=85\u0026s=b24500d10dc691683057476c85de0689 1650w, https://mintcdn.com/bolna-54a2d4fe/vO9SaOM8uLqcCkOh/images/api_introduction_1.1.png?w=2500\u0026fit=max\u0026auto=format\u0026n=vO9SaOM8uLqcCkOh\u0026q=85\u0026s=bd7b4236e2d077d14154ccbcf3d0b582 2500w`})})]}),_jsxs(Step,{title:`Create a new API Key`,children:[_jsxs(_components.p,{children:[`Click the `,_jsx(_components.strong,{children:`Create a new API Key`}),` button to generate your unique authentication credentials.`]}),_jsx(Frame,{caption:`Click 'Create a new API Key' to generate your credentials`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/bolna-54a2d4fe/vlPn4lzPQ372t9yX/images/api_introduction_2.1.png?fit=max\u0026auto=format\u0026n=vlPn4lzPQ372t9yX\u0026q=85\u0026s=183c060407452a3947ec0fc4adce7471`,alt:`Developers page with the Create a new API Key button above a table of existing keys listing Key Identifier, masked API Key, Created By, Last Accessed, Created At and a delete icon`,\"data-og-width\":`2488`,width:`2488`,\"data-og-height\":`600`,height:`600`,\"data-path\":`images/api_introduction_2.1.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/bolna-54a2d4fe/vlPn4lzPQ372t9yX/images/api_introduction_2.1.png?w=280\u0026fit=max\u0026auto=format\u0026n=vlPn4lzPQ372t9yX\u0026q=85\u0026s=8f62c1ca9cfb9b9b7b26004f5edb2a70 280w, https://mintcdn.com/bolna-54a2d4fe/vlPn4lzPQ372t9yX/images/api_introduction_2.1.png?w=560\u0026fit=max\u0026auto=format\u0026n=vlPn4lzPQ372t9yX\u0026q=85\u0026s=61ff1bf41248311ad2ebd53c1d356469 560w, https://mintcdn.com/bolna-54a2d4fe/vlPn4lzPQ372t9yX/images/api_introduction_2.1.png?w=840\u0026fit=max\u0026auto=format\u0026n=vlPn4lzPQ372t9yX\u0026q=85\u0026s=5f988d639c95438bbb19e3d447ba1ff1 840w, https://mintcdn.com/bolna-54a2d4fe/vlPn4lzPQ372t9yX/images/api_introduction_2.1.png?w=1100\u0026fit=max\u0026auto=format\u0026n=vlPn4lzPQ372t9yX\u0026q=85\u0026s=6593e3b64e899dd879a729699fde6ab1 1100w, https://mintcdn.com/bolna-54a2d4fe/vlPn4lzPQ372t9yX/images/api_introduction_2.1.png?w=1650\u0026fit=max\u0026auto=format\u0026n=vlPn4lzPQ372t9yX\u0026q=85\u0026s=d2c60345720959dba2867709e1e4a0cf 1650w, https://mintcdn.com/bolna-54a2d4fe/vlPn4lzPQ372t9yX/images/api_introduction_2.1.png?w=2500\u0026fit=max\u0026auto=format\u0026n=vlPn4lzPQ372t9yX\u0026q=85\u0026s=99b45aa4d687e24d6427455f0d74b88d 2500w`})})]}),_jsxs(Step,{title:`Save your API Key securely`,children:[_jsxs(_components.p,{children:[`Your newly generated API key will be displayed in a pop-up modal. `,_jsx(_components.strong,{children:`Copy this key and save it securely.`})]}),_jsx(Frame,{caption:`Copy and save your API Key - it won't be shown again`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/bolna-54a2d4fe/vlPn4lzPQ372t9yX/images/api_introduction_3.1.png?fit=max\u0026auto=format\u0026n=vlPn4lzPQ372t9yX\u0026q=85\u0026s=5e2722014c0d21d0462c36613701d334`,alt:`Your API Key modal with the generated key in a read-only field, a copy button, the auto-generated Key Name and an I have copied and saved the API Key button`,\"data-og-width\":`1065`,width:`1065`,\"data-og-height\":`630`,height:`630`,\"data-path\":`images/api_introduction_3.1.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/bolna-54a2d4fe/vlPn4lzPQ372t9yX/images/api_introduction_3.1.png?w=280\u0026fit=max\u0026auto=format\u0026n=vlPn4lzPQ372t9yX\u0026q=85\u0026s=0696f17923bf839edcb698d734aaf87e 280w, https://mintcdn.com/bolna-54a2d4fe/vlPn4lzPQ372t9yX/images/api_introduction_3.1.png?w=560\u0026fit=max\u0026auto=format\u0026n=vlPn4lzPQ372t9yX\u0026q=85\u0026s=7b81c0fbe660378e0bcac087647af108 560w, https://mintcdn.com/bolna-54a2d4fe/vlPn4lzPQ372t9yX/images/api_introduction_3.1.png?w=840\u0026fit=max\u0026auto=format\u0026n=vlPn4lzPQ372t9yX\u0026q=85\u0026s=6c6083b2d8ffa6f65a9980829fb4fefe 840w, https://mintcdn.com/bolna-54a2d4fe/vlPn4lzPQ372t9yX/images/api_introduction_3.1.png?w=1100\u0026fit=max\u0026auto=format\u0026n=vlPn4lzPQ372t9yX\u0026q=85\u0026s=2512bda0b679447ee77d1c0a66e95ffd 1100w, https://mintcdn.com/bolna-54a2d4fe/vlPn4lzPQ372t9yX/images/api_introduction_3.1.png?w=1650\u0026fit=max\u0026auto=format\u0026n=vlPn4lzPQ372t9yX\u0026q=85\u0026s=5063925ad847ac70c45b02c27abb243c 1650w, https://mintcdn.com/bolna-54a2d4fe/vlPn4lzPQ372t9yX/images/api_introduction_3.1.png?w=2500\u0026fit=max\u0026auto=format\u0026n=vlPn4lzPQ372t9yX\u0026q=85\u0026s=3d84dcd980f75599c716dedfc54a1ad3 2500w`})}),_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`For your security, the API key will only be shown once.`}),` If you lose your API key, you will need to delete it and generate a new one.`]})}),_jsx(Tip,{children:_jsxs(_components.p,{children:[`API keys generated for a `,_jsx(_components.strong,{children:`Subaccount`}),` will start with `,_jsx(_components.code,{children:`sa-`}),`.`]})})]})]}),`\n`,_jsx(_components.hr,{})]})}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":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Bolna API documentation","sidebarTitle":"API overview","description":"Use and leverage Bolna Voice AI using APIs through HTTP requests from any language in your applications and workflows.","icon":"code","iconType":"solid","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"What is the Bolna API?","slug":"what-is-the-bolna-api","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[{"title":"How to generate an API key","slug":"how-to-generate-an-api-key","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/bolna-54a2d4fe/9e81444dbfd8a835/custom.js","/docs/_mintlify/custom/bolna-54a2d4fe/786be19ebac8ab86/faq-schema.js"],"subdomain":"bolna-54a2d4fe","siteName":"Bolna Docs","title":"Bolna API documentation - Bolna Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T06:49:35.968Z","originalFileLocation":"api-reference/introduction.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=\"Use and leverage Bolna Voice AI using APIs through HTTP requests from any language in your applications and workflows.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Bolna Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/bolna-54a2d4fe/eeJFp-o5babnY7O-/_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=\"/docs/mintlify-assets/_mintlify/favicons/bolna-54a2d4fe/eeJFp-o5babnY7O-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/bolna-54a2d4fe/eeJFp-o5babnY7O-/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/bolna-54a2d4fe/eeJFp-o5babnY7O-/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/bolna-54a2d4fe/eeJFp-o5babnY7O-/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/bolna-54a2d4fe/eeJFp-o5babnY7O-/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/bolna-54a2d4fe/eeJFp-o5babnY7O-/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/bolna-54a2d4fe/eeJFp-o5babnY7O-/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/bolna-54a2d4fe/eeJFp-o5babnY7O-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Bolna API documentation - Bolna Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Use and leverage Bolna Voice AI using APIs through HTTP requests from any language in your applications and workflows.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bolna AI Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.bolna.ai/docs/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bolna-54a2d4fe.mintlify.app/_mintlify/api/og/v2?division=Get+started\u0026amp;title=Bolna+API+documentation\u0026amp;description=Use+and+leverage+Bolna+Voice+AI+using+APIs+through+HTTP+requests+from+any+language+in+your+applications+and+workflows.\u0026amp;theme=8729f64680990b11db2d65b5\u0026amp;signature=8239a00806495cca80307cbfc5797ab8129767cbf430e58148ab7a3744ce9532\">\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=\"Bolna API documentation - Bolna Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Use and leverage Bolna Voice AI using APIs through HTTP requests from any language in your applications and workflows.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bolna-54a2d4fe.mintlify.app/_mintlify/api/og/v2?division=Get+started\u0026amp;title=Bolna+API+documentation\u0026amp;description=Use+and+leverage+Bolna+Voice+AI+using+APIs+through+HTTP+requests+from+any+language+in+your+applications+and+workflows.\u0026amp;theme=8729f64680990b11db2d65b5\u0026amp;signature=8239a00806495cca80307cbfc5797ab8129767cbf430e58148ab7a3744ce9532\">\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=\"/docs/mintlify-assets/_mintlify/favicons/bolna-54a2d4fe/eeJFp-o5babnY7O-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bolna Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.bolna.ai/docs/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.bolna.ai/#organization\",\"name\":\"Bolna AI\",\"legalName\":\"Whismurwave Inc.\",\"url\":\"https://www.bolna.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://www.bolna.ai/logos/logo-black.png\"},\"sameAs\":[\"https://www.linkedin.com/company/bolna-ai/\",\"https://www.ycombinator.com/companies/bolna-ai\",\"https://github.com/bolna-ai\",\"https://x.com/bolna_dev\",\"https://www.youtube.com/@BolnaVoiceAI\"]},{\"@type\":\"WebSite\",\"@id\":\"https://www.bolna.ai/docs#website\",\"name\":\"Bolna Docs\",\"url\":\"https://www.bolna.ai/docs\",\"publisher\":{\"@id\":\"https://www.bolna.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.bolna.ai/docs/api-reference/introduction#webpage\",\"url\":\"https://www.bolna.ai/docs/api-reference/introduction\",\"name\":\"Bolna API documentation\",\"description\":\"Use and leverage Bolna Voice AI using APIs through HTTP requests from any language in your applications and workflows.\",\"dateModified\":\"2026-10-05T06:49:35.968Z\",\"isPartOf\":{\"@id\":\"https://www.bolna.ai/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.bolna.ai/docs/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.bolna.ai/docs/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Bolna Docs\",\"item\":\"https://www.bolna.ai/docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Bolna API documentation\",\"item\":\"https://www.bolna.ai/docs/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://www.bolna.ai/docs/api-reference/introduction#article\",\"headline\":\"Bolna API documentation\",\"name\":\"Bolna API documentation\",\"description\":\"Use and leverage Bolna Voice AI using APIs through HTTP requests from any language in your applications and workflows.\",\"url\":\"https://www.bolna.ai/docs/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://www.bolna.ai/docs/api-reference/introduction#webpage\"},\"dateModified\":\"2026-10-05T06:49:35.968Z\",\"publisher\":{\"@id\":\"https://www.bolna.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://www.bolna.ai/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Bolna Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Bolna Docs","nav":{"global":null,"tabs":[{"tab":"Overview","icon":"book","pages":[{"title":"Overview","href":""}]},{"tab":"Voice Agents","icon":"waveform-lines","pages":[{"title":"Voice Agents","href":"/agents/overview"}]},{"tab":"Integrations","icon":"plug","pages":[{"title":"Integrations","href":"/integrations"}]},{"tab":"API Reference","icon":"terminal","groups":[{"group":"Get started","icon":"play","pages":[{"title":"Bolna API documentation","sidebarTitle":"API overview","icon":"code","iconType":"solid","href":"/api-reference/introduction"},{"title":"API authentication","description":"Authenticate Bolna API requests with a Bearer API key in the Authorization header, and generate your API key from the Bolna dashboard.","icon":"key","href":"/api-reference/authentication"},{"title":"Pagination for Bolna APIs","sidebarTitle":"Pagination","icon":"ellipsis","iconType":"solid","href":"/api-reference/pagination"},{"title":"Rate limiting for Bolna APIs","sidebarTitle":"Rate limits","icon":"gauge-max","iconType":"solid","href":"/api-reference/rate-limiting"},{"title":"Errors \u0026 status codes","sidebarTitle":"API errors","icon":"triangle-exclamation","href":"/api-reference/errors"},{"title":"Limits \u0026 quotas","sidebarTitle":"Account limits","icon":"gauge","href":"/api-reference/limits"}]},{"group":"Voice agents","icon":"robot","pages":[{"group":"Agents","icon":"robot","root":{"title":"Bolna voice AI agent APIs overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/agent/v2/overview"},"expanded":false,"pages":[{"title":"Retrieve voice AI agent details API","sidebarTitle":"Get agent","openapi":"GET /v2/agent/{agent_id}","href":"/api-reference/agent/v2/get"},{"title":"Create voice AI agent API","sidebarTitle":"Create agent","openapi":"POST /v2/agent","href":"/api-reference/agent/v2/create"},{"title":"Update voice AI agent API","sidebarTitle":"Update agent","openapi":"PUT /v2/agent/{agent_id}","href":"/api-reference/agent/v2/update"},{"title":"Patch update to voice AI agent API","sidebarTitle":"Patch update agent","openapi":"PATCH /v2/agent/{agent_id}","href":"/api-reference/agent/v2/patch_update"},{"title":"Get pronunciation status API","sidebarTitle":"Get pronunciation status","openapi":"GET /v2/agent/{agent_id}/pronunciation-dictionary-status","href":"/api-reference/agent/v2/get_pronunciation_status"},{"title":"Agent rich text prompt API","sidebarTitle":"Rich text prompts","icon":"pen-to-square","href":"/api-reference/agent/v2/rich-text-prompts"},{"title":"List all voice AI agents API","sidebarTitle":"List agents","openapi":"GET /v2/agent/all","href":"/api-reference/agent/v2/get_all"},{"title":"Retrieve voice AI agent execution API","sidebarTitle":"Get agent execution","openapi":"GET /agent/{agent_id}/execution/{execution_id}","href":"/api-reference/agent/v2/get_agent_execution"},{"title":"Delete voice AI agent API","sidebarTitle":"Delete agent","openapi":"DELETE /v2/agent/{agent_id}","href":"/api-reference/agent/v2/delete"},{"title":"Stop agent queued calls API","sidebarTitle":"Stop agent calls","openapi":"POST /v2/agent/{agent_id}/stop","href":"/api-reference/agent/v2/stop"}]},{"group":"Calls","icon":"phone","root":{"title":"Calling APIs overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/calls/overview"},"expanded":false,"pages":[{"title":"Make voice AI call API","sidebarTitle":"Make phone call","openapi":"POST /call","href":"/api-reference/calls/make"},{"title":"Stop a previously initiated voice AI call API","sidebarTitle":"Stop phone call","openapi":"POST /call/{execution_id}/stop","href":"/api-reference/calls/stop_call"}]},{"group":"Executions","icon":"list","root":{"title":"Executions APIs overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/executions/overview"},"expanded":false,"pages":[{"title":"Retrieve voice AI execution API","sidebarTitle":"Get execution","openapi":"GET /executions/{execution_id}","href":"/api-reference/executions/get_execution"},{"title":"Retrieve voice AI execution raw logs API","sidebarTitle":"Get raw logs","openapi":"GET /executions/{execution_id}/log","href":"/api-reference/executions/get_execution_raw_logs"},{"title":"Retrieve voice AI execution debug bundle API","sidebarTitle":"Get debug bundle","openapi":"GET /executions/{execution_id}/debug","href":"/api-reference/executions/get_execution_debug"},{"title":"Get batch executions API","sidebarTitle":"Get batch executions","openapi":"GET /batches/{batch_id}/executions","href":"/api-reference/executions/get_batch_executions"},{"title":"Get all voice AI agent executions API","sidebarTitle":"Get agent executions","openapi":"GET /v2/agent/{agent_id}/executions","href":"/api-reference/executions/get_executions"}]},{"group":"Batches","icon":"layer-group","root":{"title":"Batch APIs overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/batches/overview"},"expanded":false,"pages":[{"title":"Create batch API","sidebarTitle":"Create batch","openapi":"POST /batches","href":"/api-reference/batches/create"},{"title":"Schedule batch API","sidebarTitle":"Schedule batch","openapi":"POST /batches/{batch_id}/schedule","href":"/api-reference/batches/schedule"},{"title":"Get batch API","sidebarTitle":"Get batch","openapi":"GET /batches/{batch_id}","href":"/api-reference/batches/get_batch"},{"title":"List all batches API","sidebarTitle":"List all batches","openapi":"GET /batches/{agent_id}/all","href":"/api-reference/batches/get_batches"},{"title":"List batch executions API","sidebarTitle":"Batch executions","openapi":"GET /batches/{batch_id}/executions","href":"/api-reference/batches/executions"},{"title":"List batch executions API (v2)","sidebarTitle":"Batch executions (v2)","openapi":"GET /v2/batches/{batch_id}/executions","href":"/api-reference/batches/executions_v2"},{"title":"Stop batch API","sidebarTitle":"Stop batch","openapi":"POST /batches/{batch_id}/stop","href":"/api-reference/batches/stop"},{"title":"Delete batch API","sidebarTitle":"Delete a batch","openapi":"DELETE /batches/{batch_id}","href":"/api-reference/batches/delete"}]},{"group":"Knowledge bases","icon":"book","root":{"title":"Knowledge bases overview","sidebarTitle":"Knowledge bases","icon":"book-open","href":"/api-reference/knowledgebase/overview"},"expanded":false,"pages":[{"title":"Create knowledge base API","sidebarTitle":"Create knowledge base","openapi":"POST /knowledgebase","href":"/api-reference/knowledgebase/create"},{"title":"Get knowledge base API","sidebarTitle":"Get knowledge base","openapi":"GET /knowledgebase/{rag_id}","href":"/api-reference/knowledgebase/get_knowledgebase"},{"title":"List all knowledge bases API","sidebarTitle":"List knowledge bases","openapi":"GET /knowledgebase/all","href":"/api-reference/knowledgebase/get_knowledgebases"},{"title":"Delete knowledge base API","sidebarTitle":"Delete knowledge base","openapi":"DELETE /knowledgebase/{rag_id}","href":"/api-reference/knowledgebase/delete"}]},{"group":"Voices","icon":"microphone-lines","root":{"title":"Voice APIs overview","sidebarTitle":"Overview","icon":"microphone-lines","iconType":"solid","href":"/api-reference/voice/overview"},"expanded":false,"pages":[{"title":"List TTS providers and models","sidebarTitle":"List providers","openapi":"GET /api/v1/voice-config/tts","href":"/api-reference/voice/get_providers"},{"title":"List voices","sidebarTitle":"List voices","openapi":"GET /api/v1/voice-config/tts/voices","href":"/api-reference/voice/get_all"}]},{"group":"Dispositions","icon":"tags","root":{"title":"Dispositions API overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/dispositions/overview"},"expanded":false,"pages":[{"title":"List dispositions API","sidebarTitle":"List dispositions","openapi":"GET /dispositions/","href":"/api-reference/dispositions/list"},{"title":"Get disposition API","sidebarTitle":"Get disposition","openapi":"GET /dispositions/{disposition_id}","href":"/api-reference/dispositions/get"},{"title":"Create disposition API","sidebarTitle":"Create disposition","openapi":"POST /dispositions/","href":"/api-reference/dispositions/create"},{"title":"Bulk create dispositions API","sidebarTitle":"Bulk create","openapi":"POST /dispositions/bulk","href":"/api-reference/dispositions/bulk-create"},{"title":"Update disposition API","sidebarTitle":"Update disposition","openapi":"PUT /dispositions/{disposition_id}","href":"/api-reference/dispositions/update"},{"title":"Delete disposition API","sidebarTitle":"Delete disposition","openapi":"DELETE /dispositions/{disposition_id}","href":"/api-reference/dispositions/delete"},{"title":"Test dispositions API","sidebarTitle":"Test dispositions","openapi":"POST /v2/agent/{agent_id}/dispositions/test","href":"/api-reference/dispositions/test"}]},{"group":"Extraction categories","icon":"filter","root":{"title":"Extraction categories API overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/extraction-categories/overview"},"expanded":false,"pages":[{"title":"List extraction categories API","sidebarTitle":"List categories","openapi":"GET /agent/{agent_id}/extraction-categories","href":"/api-reference/extraction-categories/list"},{"title":"Create extraction category API","sidebarTitle":"Create category","openapi":"POST /agent/{agent_id}/extraction-categories","href":"/api-reference/extraction-categories/create"},{"title":"Update extraction category API","sidebarTitle":"Update category","openapi":"PATCH /extraction-categories/{category_id}","href":"/api-reference/extraction-categories/update"},{"title":"Delete extraction category API","sidebarTitle":"Delete category","openapi":"DELETE /extraction-categories/{category_id}","href":"/api-reference/extraction-categories/delete"}]}]},{"group":"Telephony","icon":"tower-cell","pages":[{"group":"Phone numbers","icon":"hashtag","root":{"title":"Phone numbers APIs overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/phone-numbers/overview"},"expanded":false,"pages":[{"title":"Search phone numbers API ","sidebarTitle":"Search phone numbers","openapi":"GET /phone-numbers/search","href":"/api-reference/phone-numbers/search"},{"title":"Buy phone numbers API ","sidebarTitle":"Buy phone numbers","openapi":"POST /phone-numbers/buy","href":"/api-reference/phone-numbers/buy"},{"title":"List phone numbers API ","sidebarTitle":"List phone numbers","openapi":"GET /phone-numbers/all","href":"/api-reference/phone-numbers/get_all"},{"title":"Move phone number API","sidebarTitle":"Move phone number","openapi":"POST /phone-numbers/move","href":"/api-reference/phone-numbers/move"},{"title":"Delete phone numbers API ","sidebarTitle":"Delete phone numbers","openapi":"DELETE /phone-numbers/{phone_number_id}","href":"/api-reference/phone-numbers/delete"}]},{"group":"Compliance","icon":"file-certificate","root":{"title":"Compliance APIs overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/compliance/overview"},"expanded":false,"pages":[{"title":"List compliance applications API","sidebarTitle":"List applications","openapi":"GET /compliance/list","href":"/api-reference/compliance/list"},{"title":"Create compliance application API","sidebarTitle":"Create application","openapi":"POST /compliance/create","href":"/api-reference/compliance/create"},{"title":"Get compliance application API","sidebarTitle":"Get application","openapi":"GET /compliance/{compliance_id}","href":"/api-reference/compliance/get"},{"title":"Delete compliance application API","sidebarTitle":"Delete application","openapi":"DELETE /compliance/{compliance_id}","href":"/api-reference/compliance/delete"}]},{"group":"Inbound","icon":"phone-arrow-down-left","root":{"title":"Inbound Bolna voice AI agent APIs overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/inbound/overview"},"expanded":false,"pages":[{"title":"Set inbound agent API","sidebarTitle":"Set inbound agent","openapi":"POST /inbound/setup","href":"/api-reference/inbound/agent"},{"title":"Remove inbound agent API","sidebarTitle":"Unlink inbound agent","openapi":"POST /inbound/unlink","href":"/api-reference/inbound/unlink"}]},{"group":"SIP trunks","icon":"network-wired","root":{"title":"SIP trunks API overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/trunks/overview"},"expanded":false,"pages":[{"title":"List SIP trunks API","sidebarTitle":"List trunks","openapi":"GET /trunk/trunks","href":"/api-reference/trunks/list"},{"title":"Create SIP trunk API","sidebarTitle":"Create trunk","openapi":"POST /trunk/trunks","href":"/api-reference/trunks/create"},{"title":"Get SIP trunk API","sidebarTitle":"Get trunk","openapi":"GET /trunk/trunks/{trunk_id}","href":"/api-reference/trunks/get"},{"title":"Update SIP trunk API","sidebarTitle":"Update trunk","openapi":"PATCH /trunk/trunks/{trunk_id}","href":"/api-reference/trunks/update"},{"title":"Delete SIP trunk API","sidebarTitle":"Delete trunk","openapi":"DELETE /trunk/trunks/{trunk_id}","href":"/api-reference/trunks/delete"},{"title":"Add gateway to SIP trunk API","sidebarTitle":"Add gateway","openapi":"POST /trunk/trunks/{trunk_id}/gateways","href":"/api-reference/trunks/add_gateway"},{"title":"Remove gateway from SIP trunk API","sidebarTitle":"Remove gateway","openapi":"DELETE /trunk/trunks/{trunk_id}/gateways/{gateway_id}","href":"/api-reference/trunks/remove_gateway"},{"title":"Add carrier IP to SIP trunk API","sidebarTitle":"Add carrier IP","openapi":"POST /trunk/trunks/{trunk_id}/ip-acls","href":"/api-reference/trunks/add_carrier_ip"},{"title":"Remove carrier IP from SIP trunk API","sidebarTitle":"Remove carrier IP","openapi":"DELETE /trunk/trunks/{trunk_id}/ip-acls/{acl_id}","href":"/api-reference/trunks/remove_carrier_ip"},{"title":"Add number to SIP trunk API","sidebarTitle":"Add number","openapi":"POST /trunk/trunks/{trunk_id}/numbers","href":"/api-reference/trunks/add_number"},{"title":"Remove number from SIP trunk API","sidebarTitle":"Remove number","openapi":"DELETE /trunk/trunks/{trunk_id}/numbers/{number_id}","href":"/api-reference/trunks/remove_number"},{"title":"Assign agent to SIP trunk number API","sidebarTitle":"Assign agent","openapi":"PATCH /trunk/numbers/{number_id}","href":"/api-reference/trunks/assign_agent"},{"title":"List SIP trunk calls API","sidebarTitle":"List calls","openapi":"GET /trunk/trunks/{trunk_id}/calls","href":"/api-reference/trunks/list_calls"},{"title":"Get SIP trunk connection details API","sidebarTitle":"Connection details","openapi":"GET /trunk/pop","href":"/api-reference/trunks/connection_details"}]},{"group":"SIP trunks (legacy)","icon":"box-archive","root":{"title":"SIP trunk API reference","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/sip-trunks/overview"},"expanded":false,"pages":[{"title":"Create SIP trunk","sidebarTitle":"Create trunk","openapi":"POST /sip-trunks/trunks","href":"/api-reference/sip-trunks/create"},{"title":"List SIP trunks","sidebarTitle":"List trunks","openapi":"GET /sip-trunks/trunks","href":"/api-reference/sip-trunks/get_all"},{"title":"Get SIP trunk","sidebarTitle":"Get trunk","openapi":"GET /sip-trunks/trunks/{trunk_id}","href":"/api-reference/sip-trunks/get"},{"title":"Update SIP trunk","sidebarTitle":"Update trunk","openapi":"PATCH /sip-trunks/trunks/{trunk_id}","href":"/api-reference/sip-trunks/update"},{"title":"Delete SIP trunk","sidebarTitle":"Delete trunk","openapi":"DELETE /sip-trunks/trunks/{trunk_id}","href":"/api-reference/sip-trunks/delete"},{"title":"Add phone number to trunk","sidebarTitle":"Add number","openapi":"POST /sip-trunks/trunks/{trunk_id}/numbers","href":"/api-reference/sip-trunks/add_number"},{"title":"List phone numbers on trunk","sidebarTitle":"List numbers","openapi":"GET /sip-trunks/trunks/{trunk_id}/numbers","href":"/api-reference/sip-trunks/list_numbers"},{"title":"Remove phone number from trunk","sidebarTitle":"Remove number","openapi":"DELETE /sip-trunks/trunks/{trunk_id}/numbers/{phone_number_id}","href":"/api-reference/sip-trunks/remove_number"}]},{"group":"Violations","icon":"ban","root":{"title":"Violations APIs overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/violations/overview"},"expanded":false,"pages":[{"title":"List violations API","sidebarTitle":"List violations","openapi":"GET /violations/list","href":"/api-reference/violations/list"},{"title":"Submit violation API","sidebarTitle":"Submit violation","openapi":"POST /violations/submit","href":"/api-reference/violations/submit"}]}]},{"group":"Workflows","icon":"diagram-project","pages":[{"group":"Workflows","icon":"diagram-project","root":{"title":"Workflow APIs overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/workflows/overview"},"expanded":false,"pages":[{"title":"Create workflow API","sidebarTitle":"Create workflow","openapi":"POST /workflows","href":"/api-reference/workflows/create"},{"title":"List workflows API","sidebarTitle":"List workflows","openapi":"GET /workflows","href":"/api-reference/workflows/list"},{"title":"Get workflow API","sidebarTitle":"Get workflow","openapi":"GET /workflows/{workflow_id}","href":"/api-reference/workflows/get"},{"title":"Update workflow API","sidebarTitle":"Update workflow","openapi":"PATCH /workflows/{workflow_id}","href":"/api-reference/workflows/update"},{"title":"Delete workflow API","sidebarTitle":"Delete workflow","openapi":"DELETE /workflows/{workflow_id}","href":"/api-reference/workflows/delete"},{"title":"Get workflow draft API","sidebarTitle":"Get draft","openapi":"GET /workflows/{workflow_id}/draft","href":"/api-reference/workflows/get-draft"},{"title":"Save workflow draft API","sidebarTitle":"Save draft","openapi":"PUT /workflows/{workflow_id}/draft","href":"/api-reference/workflows/save-draft"},{"title":"Validate workflow API","sidebarTitle":"Validate draft","openapi":"POST /workflows/{workflow_id}/validate","href":"/api-reference/workflows/validate"},{"title":"Publish workflow API","sidebarTitle":"Publish","openapi":"POST /workflows/{workflow_id}/publish","href":"/api-reference/workflows/publish"},{"title":"Get workflow version API","sidebarTitle":"Get published version","openapi":"GET /workflows/{workflow_id}/versions/{version}","href":"/api-reference/workflows/get-version"},{"title":"Run workflow API","sidebarTitle":"Run one contact","openapi":"POST /workflows/{workflow_id}/run","href":"/api-reference/workflows/run"},{"title":"Test workflow webhook API","sidebarTitle":"Test webhook","openapi":"POST /workflows/{workflow_id}/webhook:test","href":"/api-reference/workflow-webhooks/test"},{"title":"Get callback URL API","sidebarTitle":"Get callback URL","openapi":"GET /workflows/{workflow_id}/nodes/{node_id}/callback","href":"/api-reference/workflows/get-callback"},{"title":"Rotate callback URL API","sidebarTitle":"Rotate callback URL","openapi":"POST /workflows/{workflow_id}/nodes/{node_id}/callback:rotate","href":"/api-reference/workflows/rotate-callback"},{"title":"Get last callback API","sidebarTitle":"Get last callback","openapi":"GET /workflows/{workflow_id}/nodes/{node_id}/callback:last","href":"/api-reference/workflows/get-last-callback"},{"title":"Workflow node types API","sidebarTitle":"Node-type catalog","openapi":"GET /workflow-node-types","href":"/api-reference/workflows/node-types"}]},{"group":"Campaigns","icon":"bullhorn","root":{"title":"Workflow campaign APIs overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/workflow-campaigns/overview"},"expanded":false,"pages":[{"title":"Create workflow campaign API","sidebarTitle":"Create campaign","openapi":"POST /workflow-campaigns","href":"/api-reference/workflow-campaigns/create"},{"title":"List workflow campaigns API","sidebarTitle":"List campaigns","openapi":"GET /workflow-campaigns","href":"/api-reference/workflow-campaigns/list"},{"title":"Get workflow campaign API","sidebarTitle":"Get campaign","openapi":"GET /workflow-campaigns/{campaign_id}","href":"/api-reference/workflow-campaigns/get"},{"title":"Upload campaign entries API","sidebarTitle":"Upload entries","openapi":"POST /workflow-campaigns/{campaign_id}/entries","href":"/api-reference/workflow-campaigns/upload-entries"},{"title":"List campaign entries API","sidebarTitle":"List entries","openapi":"GET /workflow-campaigns/{campaign_id}/entries","href":"/api-reference/workflow-campaigns/list-entries"},{"title":"Campaign entries template API","sidebarTitle":"CSV template","openapi":"GET /workflow-campaigns/{campaign_id}/entries/template","href":"/api-reference/workflow-campaigns/entries-template"},{"title":"Start workflow campaign API","sidebarTitle":"Start campaign","openapi":"POST /workflow-campaigns/{campaign_id}:start","href":"/api-reference/workflow-campaigns/start"},{"title":"Pause workflow campaign API","sidebarTitle":"Pause campaign","openapi":"POST /workflow-campaigns/{campaign_id}:pause","href":"/api-reference/workflow-campaigns/pause"},{"title":"Resume workflow campaign API","sidebarTitle":"Resume campaign","openapi":"POST /workflow-campaigns/{campaign_id}:resume","href":"/api-reference/workflow-campaigns/resume"},{"title":"Abort workflow campaign API","sidebarTitle":"Abort campaign","openapi":"POST /workflow-campaigns/{campaign_id}:abort","href":"/api-reference/workflow-campaigns/abort"},{"title":"List campaign executions API","sidebarTitle":"List executions","openapi":"GET /workflow-campaigns/{campaign_id}/executions","href":"/api-reference/workflow-campaigns/list-executions"},{"title":"Workflow campaign report API","sidebarTitle":"Campaign report","openapi":"GET /workflow-campaigns/{campaign_id}/report","href":"/api-reference/workflow-campaigns/report"},{"title":"Delete workflow campaign API","sidebarTitle":"Delete campaign","openapi":"DELETE /workflow-campaigns/{campaign_id}","href":"/api-reference/workflow-campaigns/delete"}]},{"group":"Executions","icon":"list","root":{"title":"Workflow execution APIs overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/workflow-executions/overview"},"expanded":false,"pages":[{"title":"Get workflow execution API","sidebarTitle":"Get execution","openapi":"GET /workflow-executions/{execution_id}","href":"/api-reference/workflow-executions/get"},{"title":"Cancel workflow execution API","sidebarTitle":"Cancel execution","openapi":"POST /workflow-executions/{execution_id}:cancel","href":"/api-reference/workflow-executions/cancel"},{"title":"Resend execution webhook API","sidebarTitle":"Resend webhook","openapi":"POST /workflow-executions/{execution_id}/webhook:resend","href":"/api-reference/workflow-webhooks/resend"}]}]},{"group":"Account","icon":"user-gear","pages":[{"group":"User","icon":"user","root":{"title":"User APIs overview","sidebarTitle":"User APIs overview","icon":"book-open","href":"/api-reference/user/overview"},"expanded":false,"pages":[{"title":"User information","sidebarTitle":"Get user details","openapi":"GET /user/me","href":"/api-reference/user/info"},{"title":"Add a new custom LLM model","sidebarTitle":"Add a custom model","openapi":"POST /user/model/custom","href":"/api-reference/user/add_model"},{"title":"List your custom LLM models","sidebarTitle":"List custom models","openapi":"GET /user/model/custom","href":"/api-reference/user/list_custom_models"},{"title":"Delete a custom LLM model","sidebarTitle":"Delete custom model","openapi":"DELETE /user/model/custom/{model_id}","href":"/api-reference/user/delete_model"},{"title":"Add a custom TTS voice","sidebarTitle":"Add a custom TTS","openapi":"POST /user/tts/custom","href":"/api-reference/user/add_custom_tts"},{"title":"List your custom TTS voices","sidebarTitle":"List custom TTS","openapi":"GET /user/tts/custom","href":"/api-reference/user/list_custom_tts"},{"title":"Delete a custom TTS voice","sidebarTitle":"Delete custom TTS","openapi":"DELETE /user/tts/custom/{custom_tts_id}","href":"/api-reference/user/delete_custom_tts"}]},{"group":"Providers","icon":"plug","root":{"title":"Providers APIs overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/providers/overview"},"expanded":false,"pages":[{"title":"Add a new provider API","sidebarTitle":"Add a new provider","openapi":"POST /providers","href":"/api-reference/providers/add"},{"title":"List providers API ","sidebarTitle":"List providers","openapi":"GET /providers","href":"/api-reference/providers/get"},{"title":"Remove a provider API","sidebarTitle":"Remove a provider","openapi":"DELETE /providers/{provider_key_name}","href":"/api-reference/providers/remove"}]},{"group":"Sub-accounts","icon":"sitemap","root":{"title":"Sub accounts APIs overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/sub-accounts/overview"},"expanded":false,"pages":[{"title":"Create a new sub-account API","sidebarTitle":"Create sub-account","openapi":"POST /sub-accounts/create","href":"/api-reference/sub-accounts/create"},{"title":"List all sub-accounts API","sidebarTitle":"List sub-accounts","openapi":"GET /sub-accounts/all","href":"/api-reference/sub-accounts/get_all"},{"title":"Patch update a sub-account","sidebarTitle":"Patch sub-account","openapi":"PATCH /sub-accounts/{sub_account_id}","href":"/api-reference/sub-accounts/patch_update"},{"title":"Track sub-account usage API","sidebarTitle":"Sub-account usage","openapi":"GET /sub-accounts/{sub_account_id}/usage","href":"/api-reference/sub-accounts/usage"},{"title":"Get all sub-accounts usage API","sidebarTitle":"All sub-account usage","openapi":"GET /sub-accounts/all/usage","href":"/api-reference/sub-accounts/all_usage"},{"title":"Deleting a sub-account","sidebarTitle":"Delete sub-account","openapi":"DELETE /sub-accounts/{sub_account_id}","href":"/api-reference/sub-accounts/delete"}]}]},{"group":"Legacy","icon":"box-archive","pages":[{"group":"Agent v1","icon":"box-archive","root":{"title":"Bolna voice AI agent APIs overview (deprecated)","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/agent/overview"},"expanded":false,"pages":[{"title":"Create voice AI agent API (deprecated)","sidebarTitle":"Create agent","openapi":"POST /agent","href":"/api-reference/agent/create"},{"title":"Retrieve voice AI agent details API (deprecated)","sidebarTitle":"Get agent","openapi":"GET /agent/{agent_id}","href":"/api-reference/agent/get"},{"title":"Update voice AI agent API (deprecated)","sidebarTitle":"Update agent","openapi":"PUT /agent/{agent_id}","href":"/api-reference/agent/update"},{"title":"Patch update to voice AI agent API (deprecated)","sidebarTitle":"Patch update agent","openapi":"PATCH /agent/{agent_id}","href":"/api-reference/agent/patch_update"},{"title":"List all voice AI agents API (deprecated)","sidebarTitle":"List agents","openapi":"GET /agent/all","href":"/api-reference/agent/get_all"},{"title":"Get all agent executions API (v1, deprecated)","sidebarTitle":"Get all executions","openapi":"GET /agent/{agent_id}/executions","href":"/api-reference/agent/get_all_agent_executions"}]}]}]},{"tab":"Developers","icon":"toolbox","pages":[{"title":"Developers","href":"/developer-resources/overview"}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog/october-2026"}]}]},"basePath":"","title":"Bolna API documentation - Bolna Docs","buildId":"dpl_6cCEiK8XNNvaLBBkWzcBhdE9QfLC","deploymentId":"dpl_6cCEiK8XNNvaLBBkWzcBhdE9QfLC","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-Bj1PpgeO.js","DynamicMarkdown-Bas9A7wq.js","zoom-image-lightbox-B-WKhCOL.js","lightbox-handle-r17bVUz3.js"]}