{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Assistable.ai Docs","colors":{"primary":"#1767DC","light":"#A4BAD4","dark":"#1056BB"},"logo":{"light":"https://mintcdn.com/assistable/sK9jHmr6K-LRkuUW/logo/assistable-lockup-light.svg?fit=max\u0026auto=format\u0026n=sK9jHmr6K-LRkuUW\u0026q=85\u0026s=244fbfd8c1d230c5c2df3632bae34ad8","dark":"https://mintcdn.com/assistable/sK9jHmr6K-LRkuUW/logo/assistable-lockup-dark.svg?fit=max\u0026auto=format\u0026n=sK9jHmr6K-LRkuUW\u0026q=85\u0026s=e7b6edc7b80a190eb97a568e7bd62ca8"},"favicon":"https://mintcdn.com/assistable/sK9jHmr6K-LRkuUW/logo/assistable-symbol.png?fit=max\u0026auto=format\u0026n=sK9jHmr6K-LRkuUW\u0026q=85\u0026s=16dcbab69dfcdeba68d3320f43545c58","appearance":{"default":"light"},"navbar":{"links":[{"href":"https://assistable.ai","label":"Homepage"},{"href":"https://help.assistable.ai","label":"Support"},{"href":"https://assistable.ai/roadmap","label":"Roadmap"}],"primary":{"type":"button","label":"Dashboard","href":"https://createassistants.com/dashboard"}},"footer":{"socials":{"youtube":"https://www.youtube.com/@assistable-ai","facebook":"https://facebook.com/people/Assistableai/61561378413576","instagram":"https://instagram.com/assistable.ai","linkedin":"https://linkedin.com/company/assistable-ai"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Videos \u0026 How-tos","icon":"video","href":"https://www.youtube.com/@assistable-ai"},{"anchor":"Community","icon":"house","href":"https://skool.com/assistable"},{"anchor":"Roadmap","icon":"arrow-progress","href":"https://assistable.ai/roadmap"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"assistable","hasAudioNarration":false,"actualSubdomain":"assistable","customDomains":["docs.assistable.ai"],"gitSource":{"type":"github","owner":"assistableai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae370a1878abd4f8baed6a4","collectionId":"8237ae73-6b71-43e3-9842-15cb10fed94f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae370a1878abd4f8baed6a4"},"entitlements":{},"buildId":"6ae370a1878abd4f8baed6a4","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":136},{"language":"default","tag":"Direct","count":118},{"language":"default","tag":"v1","count":103},{"language":"default","tag":"v3","count":102},{"language":"default","tag":"Documentation","count":94},{"language":"default","tag":"Guides","count":93},{"language":"default","tag":"Build","count":39},{"language":"default","tag":"Build assistants","count":31},{"language":"default","tag":"Flow Builder","count":27},{"language":"default","tag":"Manage \u0026 troubleshoot","count":23}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Introduction","description":"Example section for showcasing API endpoints","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: \"Example section for showcasing API endpoints\"\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{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Warning}=_components;if(!Warning)_missingMdxReference(`Warning`,true);return _jsx(Warning,{children:_jsx(_components.p,{children:`Under construction`})})}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":"Introduction","description":"Example section for showcasing API endpoints","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"assistable","siteName":"Assistable.ai Docs","title":"Introduction - Assistable.ai Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-09-02T15:38:26.484Z","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=\"light\"}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=\"Example section for showcasing API endpoints\">\u003cmeta data-mint-head name=\"application-name\" content=\"Assistable.ai Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/assistable/XTFO61JDdsOq78Ws/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/assistable/XTFO61JDdsOq78Ws/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/assistable/XTFO61JDdsOq78Ws/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/assistable/XTFO61JDdsOq78Ws/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/assistable/XTFO61JDdsOq78Ws/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/assistable/XTFO61JDdsOq78Ws/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/assistable/XTFO61JDdsOq78Ws/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/assistable/XTFO61JDdsOq78Ws/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/assistable/XTFO61JDdsOq78Ws/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Assistable.ai Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Example section for showcasing API endpoints\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Assistable.ai Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.assistable.ai/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://assistable.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Introduction\u0026amp;description=Example+section+for+showcasing+API+endpoints\u0026amp;theme=015b00a67889fa388928d10f\u0026amp;signature=bea61ea0423cace8ef3e18f63cb5f944824062375a58a26cff44ffabddcca52b\">\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=\"Introduction - Assistable.ai Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Example section for showcasing API endpoints\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://assistable.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Introduction\u0026amp;description=Example+section+for+showcasing+API+endpoints\u0026amp;theme=015b00a67889fa388928d10f\u0026amp;signature=bea61ea0423cace8ef3e18f63cb5f944824062375a58a26cff44ffabddcca52b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/assistable/XTFO61JDdsOq78Ws/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Assistable.ai Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1767DC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.assistable.ai/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Assistable.ai Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Assistable.ai Docs","nav":{"global":{"anchors":[{"anchor":"Videos \u0026 How-tos","icon":"video","href":"https://www.youtube.com/@assistable-ai"},{"anchor":"Community","icon":"house","href":"https://skool.com/assistable"},{"anchor":"Roadmap","icon":"arrow-progress","href":"https://assistable.ai/roadmap"}]},"dropdowns":[{"dropdown":"v3","icon":"code","tabs":[{"tab":"Guides","groups":[{"group":"Start here","pages":[{"title":"Guides","href":"/v3/guides/overview"},{"title":"Start with Assistable","icon":"hand-wave","href":"/v3/guides/getting-started/introduction"},{"title":"Build and test your first assistant","icon":"bolt","href":"/v3/guides/getting-started/first-assistant"},{"title":"Understand accounts and access","icon":"sitemap","href":"/v3/guides/getting-started/accounts-and-access"},{"title":"Set up your workspace and client accounts","href":"/v3/guides/getting-started/workspace-setup"}]},{"group":"Build assistants","pages":[{"group":"Assistants \u0026 knowledge","expanded":false,"pages":[{"title":"Create an assistant","icon":"microphone","href":"/v3/guides/assistants/create"},{"title":"Write and test assistant instructions","icon":"lightbulb","href":"/v3/guides/assistants/write-instructions"},{"title":"Assistant and CRM variable reference","href":"/v3/guides/assistants/variables"},{"title":"Add and test business knowledge","icon":"book","href":"/v3/guides/knowledge/add-sources"},{"title":"Understand knowledge retrieval","icon":"database","href":"/v3/guides/knowledge/retrieval"}]},{"group":"Tools \u0026 customer workflows","expanded":false,"pages":[{"title":"Add, copy, and remove tools","href":"/v3/guides/tools/manage"},{"title":"Connect a custom API tool","href":"/v3/guides/tools/custom-api"},{"title":"Choose a calendar and test appointment booking","href":"/v3/guides/workflows/book-appointments"},{"title":"Save contact details during a conversation","href":"/v3/guides/workflows/save-contact-details"},{"title":"Update a contact name during a conversation","href":"/v3/guides/workflows/correct-contact-name"},{"title":"Save a customer address","href":"/v3/guides/workflows/save-address"},{"title":"Save conversation answers to GHL custom fields","href":"/v3/guides/workflows/extract-custom-fields"},{"title":"Check automatic contact-field updates","href":"/v3/guides/workflows/verify-extracted-fields"},{"title":"Send an email from a conversation","href":"/v3/guides/workflows/send-email"},{"title":"Create a follow-up task for a support request","href":"/v3/guides/workflows/create-support-task"},{"title":"Let an assistant search the web","href":"/v3/guides/tools/search-web"},{"title":"Read a public web page during a conversation","href":"/v3/guides/tools/read-web-page"}]},{"group":"Flow Builder","expanded":false,"pages":[{"title":"Build your first flow","icon":"diagram-project","href":"/v3/guides/flows/first-flow"},{"title":"Configure flow model access","icon":"key","href":"/v3/guides/flows/model-access"},{"title":"Write a conversation node","icon":"message","href":"/v3/guides/flows/conversation-node"},{"title":"Route a flow with conditions","icon":"code-branch","href":"/v3/guides/flows/conditions"},{"title":"Use variables in a flow","icon":"brackets-curly","href":"/v3/guides/flows/variables"},{"title":"Collect and set flow values","icon":"database","href":"/v3/guides/flows/collect-values"},{"title":"Run a tool from a flow","icon":"wrench","href":"/v3/guides/flows/run-tools"},{"title":"Call an API from a flow","icon":"server","href":"/v3/guides/flows/api-requests"},{"title":"Improve flow prompts with AI","icon":"wand-magic-sparkles","href":"/v3/guides/flows/improve-prompts"},{"title":"Understand flow execution","icon":"bolt","href":"/v3/guides/flows/execution"},{"title":"Test a flow before publishing","icon":"flask-vial","href":"/v3/guides/flows/test"},{"title":"Use a flow on phone calls","icon":"phone","href":"/v3/guides/flows/phone-calls"},{"title":"Use a flow in a website widget","icon":"window-maximize","href":"/v3/guides/flows/website-widget"},{"sidebarTitle":"Example: appointment enquiry flow","title":"Create and test a short conversation flow","href":"/v3/guides/flows/appointment-enquiry-example"}]}]},{"group":"Connect channels","pages":[{"group":"Voice \u0026 phone calls","expanded":false,"pages":[{"title":"Buy a phone number","href":"/v3/guides/calling/buy-number"},{"title":"Test incoming calls","href":"/v3/guides/calling/incoming-calls"},{"title":"Place an outbound call","href":"/v3/guides/calling/outbound-calls"},{"title":"Set call limits and voicemail behavior","icon":"sliders","href":"/v3/guides/voice/call-settings"},{"title":"Choose what happens at voicemail","icon":"voicemail","href":"/v3/guides/voice/voicemail"},{"title":"Transfer a caller to your team","icon":"phone-arrow-right","href":"/v3/guides/voice/transfer-calls"},{"title":"Clone a voice from a recording","icon":"clone","href":"/v3/guides/voice/clone-voice"},{"title":"Check a number’s reputation and call activity","href":"/v3/guides/calling/number-health"}]},{"group":"Chat \u0026 website widgets","expanded":false,"pages":[{"title":"Activate and pause GHL chat","icon":"comments","href":"/v3/guides/chat/activate-ghl-chat"},{"title":"Route incoming messages with active tags","href":"/v3/guides/chat/active-tags"},{"title":"Pause GHL chat for a contact","icon":"power-off","href":"/v3/guides/chat/pause-contact"},{"title":"Use the AI Replying indicator","icon":"tag","href":"/v3/guides/chat/replying-indicator"},{"title":"Start a requested phone call from chat","href":"/v3/guides/chat/start-requested-call"},{"title":"Install a text chat widget","href":"/v3/guides/widgets/install-chat"},{"sidebarTitle":"Set up Chat Widget V2","title":"Add website chat and browser voice","icon":"browser","href":"/v3/guides/widgets/chat-widget-v2"},{"title":"Install a voice orb","href":"/v3/guides/widgets/install-voice-orb"},{"title":"Build a website assistant demo","icon":"wand-magic-sparkles","href":"/v3/guides/widgets/website-demo"}]},{"group":"GoHighLevel","expanded":false,"pages":[{"sidebarTitle":"Choose a GHL connection method","title":"GoHighLevel connection walkthrough","href":"/v3/guides/ghl/connection-options"},{"title":"Connect GoHighLevel","href":"/v3/guides/ghl/connect"},{"title":"Connect one GoHighLevel location","href":"/v3/guides/ghl/connect-location"},{"title":"Add Assistable to the GoHighLevel menu","href":"/v3/guides/ghl/menu-link"},{"title":"Provision a GoHighLevel account through the API","href":"/v3/guides/ghl/provision-via-api"}]}]},{"group":"Manage \u0026 troubleshoot","pages":[{"group":"Call results \u0026 follow-up","expanded":false,"pages":[{"title":"Use call dispositions in GoHighLevel workflows","href":"/v3/guides/call-results/dispositions"},{"title":"Save call results to a CRM contact","href":"/v3/guides/call-results/save-to-crm"},{"title":"Receive call-start and post-call webhooks","href":"/v3/guides/call-results/webhooks"},{"title":"Send a summary after a call finishes","href":"/v3/guides/call-results/send-summary"},{"title":"Retrieve a call transcript for a workflow","href":"/v3/guides/call-results/retrieve-transcript"}]},{"group":"Accounts \u0026 access","expanded":false,"pages":[{"title":"Manage a client account","href":"/v3/guides/accounts/manage-clients"},{"title":"Invite and manage account users","href":"/v3/guides/accounts/invite-users"},{"title":"Configure account navigation permissions","href":"/v3/guides/accounts/navigation-permissions"},{"title":"Lock entry to a client portal","href":"/v3/guides/accounts/portal-lock"},{"title":"Set defaults for new accounts","href":"/v3/guides/accounts/default-settings"},{"title":"Update your workspace branding","href":"/v3/guides/accounts/branding"},{"title":"Set up a branded portal domain","href":"/v3/guides/accounts/branded-domain"}]},{"group":"Billing \u0026 payments","expanded":false,"pages":[{"title":"Fund the workspace wallet","href":"/v3/guides/billing/workspace-wallet"},{"title":"Connect Stripe for client rebilling","href":"/v3/guides/billing/connect-stripe"},{"title":"Fund a client account wallet","href":"/v3/guides/billing/client-wallet"},{"title":"Review billing, payments and wallet activity","href":"/v3/guides/billing/review-activity"}]},{"group":"Troubleshooting","expanded":false,"pages":[{"title":"Diagnose a first call or chat reply","href":"/v3/guides/troubleshooting/first-call-or-chat"},{"title":"Troubleshoot a GoHighLevel connection","href":"/v3/guides/troubleshooting/ghl-connection"},{"title":"Diagnose slow or missing GHL chat replies","href":"/v3/guides/troubleshooting/chat-replies"},{"title":"Diagnose a failed phone call","href":"/v3/guides/troubleshooting/failed-calls"},{"title":"Investigate blocked outbound calls","href":"/v3/guides/troubleshooting/blocked-calls"},{"title":"Diagnose an appointment that did not book","href":"/v3/guides/troubleshooting/booking"},{"title":"Fix missing or inaccurate knowledge answers","href":"/v3/guides/troubleshooting/knowledge"}]}]},{"group":"Guides","pages":[{"title":"OpenAI GPT Live Voices","href":"/v3/openai-gpt-live-voices"}]}]},{"tab":"Developer docs","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/v3/introduction"},{"title":"Authentication","href":"/v3/authentication"},{"title":"Rate limits","href":"/v3/rate-limits"},{"title":"Errors","href":"/v3/errors"},{"title":"Export \u0026 Test","href":"/v3/export"}]},{"group":"SDKs \u0026 Tools","pages":[{"title":"TypeScript SDK","icon":"js","href":"/v3/typescript-sdk"},{"title":"Python SDK","icon":"python","href":"/v3/python-sdk"},{"title":"MCP Server","icon":"plug","href":"/v3/mcp-server"},{"title":"Give your AI agent a phone","icon":"phone","href":"/v3/agent-phone"},{"title":"CLI","icon":"terminal","href":"/v3/cli"}]},{"group":"Guides","pages":[{"title":"How Billing Works on Assistable","href":"/v3/billing-guide"},{"title":"Voice Settings","href":"/v3/voice-settings"},{"title":"Platform Tools","href":"/v3/platform-tools"},{"title":"Voice Enabled Chat Widget","href":"/v3/voice-enabled-chat-widget"},{"title":"Voice Studio and Multi-Provider Speech","href":"/v3/voice-studio"},{"title":"Zapier (Beta)","href":"/v3/zapier"}]}]},{"tab":"API Reference","groups":[{"group":"Assistants","pages":[{"title":"List assistants","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/assistants","href":"/api-reference/assistants/list-assistants"},{"title":"Create an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistants","href":"/api-reference/assistants/create-an-assistant"},{"title":"Get an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/assistants/{id}","href":"/api-reference/assistants/get-an-assistant"},{"title":"Delete (soft) an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/assistants/{id}","href":"/api-reference/assistants/delete-soft-an-assistant"},{"title":"Update an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/assistants/{id}","href":"/api-reference/assistants/update-an-assistant"},{"title":"Archive an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistants/{id}/archive","href":"/api-reference/assistants/archive-an-assistant"},{"title":"Unarchive an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistants/{id}/unarchive","href":"/api-reference/assistants/unarchive-an-assistant"},{"title":"Duplicate an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistants/{id}/duplicate","href":"/api-reference/assistants/duplicate-an-assistant"},{"title":"List assistant versions","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/assistants/{id}/versions","href":"/api-reference/assistants/list-assistant-versions"},{"title":"Revert an assistant to a version","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistants/{id}/versions/{version_id}/revert","href":"/api-reference/assistants/revert-an-assistant-to-a-version"},{"title":"List assistant notes","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/assistants/{id}/notes","href":"/api-reference/assistants/list-assistant-notes"},{"title":"Add a note to an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistants/{id}/notes","href":"/api-reference/assistants/add-a-note-to-an-assistant"},{"title":"Delete an assistant note","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/assistants/{id}/notes/{note_id}","href":"/api-reference/assistants/delete-an-assistant-note"}]},{"group":"Voices","pages":[{"title":"List voices","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/voices","href":"/api-reference/voices/list-voices"},{"title":"Distinct voice filter options","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/voices/filter-options","href":"/api-reference/voices/distinct-voice-filter-options"},{"title":"Voice library stats","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/voices/stats","href":"/api-reference/voices/voice-library-stats"},{"title":"Get a voice","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/voices/{id}","href":"/api-reference/voices/get-a-voice"},{"title":"Toggle whether a custom voice can be copied","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/voices/{id}/allow-copy","href":"/api-reference/voices/toggle-whether-a-custom-voice-can-be-copied"}]},{"group":"Assistant folders","pages":[{"title":"List assistant folders","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/assistant-folders","href":"/api-reference/assistant-folders/list-assistant-folders"},{"title":"Create an assistant folder","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistant-folders","href":"/api-reference/assistant-folders/create-an-assistant-folder"},{"title":"Delete (archive) an assistant folder","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/assistant-folders/{id}","href":"/api-reference/assistant-folders/delete-archive-an-assistant-folder"},{"title":"Update an assistant folder","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/assistant-folders/{id}","href":"/api-reference/assistant-folders/update-an-assistant-folder"},{"title":"Assign assistants to a folder","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistant-folders/{id}/assign","href":"/api-reference/assistant-folders/assign-assistants-to-a-folder"},{"title":"Remove assistants from a folder","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistant-folders/{id}/remove","href":"/api-reference/assistant-folders/remove-assistants-from-a-folder"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/contacts/{id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Delete (archive) a contact","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/contacts/{id}","href":"/api-reference/contacts/delete-archive-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/contacts/{id}","href":"/api-reference/contacts/update-a-contact"},{"title":"Permanently delete a contact","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/contacts/{id}/permanent-delete","href":"/api-reference/contacts/permanently-delete-a-contact"},{"title":"List contact notes","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/contacts/{id}/notes","href":"/api-reference/contacts/list-contact-notes"},{"title":"Add a note to a contact","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/contacts/{id}/notes","href":"/api-reference/contacts/add-a-note-to-a-contact"},{"title":"Delete a contact note","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/contacts/{id}/notes/{note_id}","href":"/api-reference/contacts/delete-a-contact-note"},{"title":"List contact interactions","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/contacts/{id}/interactions","href":"/api-reference/contacts/list-contact-interactions"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/tags","href":"/api-reference/tags/list-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/tags","href":"/api-reference/tags/create-a-tag"},{"title":"Get a tag","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/tags/{id}","href":"/api-reference/tags/get-a-tag"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/tags/{id}","href":"/api-reference/tags/delete-a-tag"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/tags/{id}","href":"/api-reference/tags/update-a-tag"},{"title":"Permanently delete a tag","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/tags/{id}/permanent-delete","href":"/api-reference/tags/permanently-delete-a-tag"}]},{"group":"Phone numbers","pages":[{"title":"List owned phone numbers","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/phone-numbers","href":"/api-reference/phone-numbers/list-owned-phone-numbers"},{"title":"Get a phone number","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/phone-numbers/{id}","href":"/api-reference/phone-numbers/get-a-phone-number"},{"title":"Update a phone number","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/phone-numbers/{id}","href":"/api-reference/phone-numbers/update-a-phone-number"},{"title":"Assign a phone number to an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/phone-numbers/{id}/assign","href":"/api-reference/phone-numbers/assign-a-phone-number-to-an-assistant"}]},{"group":"Number pools","pages":[{"title":"List number pools","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/number-pools","href":"/api-reference/number-pools/list-number-pools"},{"title":"Create a number pool","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/number-pools","href":"/api-reference/number-pools/create-a-number-pool"},{"title":"Get a number pool","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/number-pools/{id}","href":"/api-reference/number-pools/get-a-number-pool"},{"title":"Delete a number pool","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/number-pools/{id}","href":"/api-reference/number-pools/delete-a-number-pool"},{"title":"Update a number pool","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/number-pools/{id}","href":"/api-reference/number-pools/update-a-number-pool"},{"title":"Add phone numbers to a pool","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/number-pools/{id}/add-numbers","href":"/api-reference/number-pools/add-phone-numbers-to-a-pool"},{"title":"Remove phone numbers from a pool","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/number-pools/{id}/remove-numbers","href":"/api-reference/number-pools/remove-phone-numbers-from-a-pool"}]},{"group":"Appointments","pages":[{"title":"List appointments in a date range","deprecated":null,"version":null,"openapi":"/v3/openapi.json get /v3/appointments","href":"/api-reference/appointments/list-appointments-in-a-date-range"},{"title":"Create an appointment","deprecated":null,"version":null,"openapi":"/v3/openapi.json post /v3/appointments","href":"/api-reference/appointments/create-an-appointment"},{"title":"Get an appointment","deprecated":null,"version":null,"openapi":"/v3/openapi.json get /v3/appointments/{id}","href":"/api-reference/appointments/get-an-appointment"},{"title":"Update an appointment","deprecated":null,"version":null,"openapi":"/v3/openapi.json patch /v3/appointments/{id}","href":"/api-reference/appointments/update-an-appointment"}]},{"group":"Tools","pages":[{"title":"List tools","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/tools","href":"/api-reference/tools/list-tools"},{"title":"Create a tool","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/tools","href":"/api-reference/tools/create-a-tool"},{"title":"List distinct tool categories","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/tools/categories","href":"/api-reference/tools/list-distinct-tool-categories"},{"title":"Get a tool (with parameters + headers)","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/tools/{id}","href":"/api-reference/tools/get-a-tool-with-parameters-+-headers"},{"title":"Delete (soft) a tool","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/tools/{id}","href":"/api-reference/tools/delete-soft-a-tool"},{"title":"Update a tool","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/tools/{id}","href":"/api-reference/tools/update-a-tool"},{"title":"Copy a tool into this subaccount","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/tools/{id}/copy","href":"/api-reference/tools/copy-a-tool-into-this-subaccount"},{"title":"Assign a tool to an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/tools/{id}/assign","href":"/api-reference/tools/assign-a-tool-to-an-assistant"},{"title":"Remove a tool from an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/tools/{id}/remove","href":"/api-reference/tools/remove-a-tool-from-an-assistant"},{"title":"List an assistant's tools","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/assistants/{id}/tools","href":"/api-reference/tools/list-an-assistants-tools"}]},{"group":"Knowledge base","pages":[{"title":"List knowledge bases","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/knowledge-bases","href":"/api-reference/knowledge-base/list-knowledge-bases"},{"title":"Create a knowledge base","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases","href":"/api-reference/knowledge-base/create-a-knowledge-base"},{"title":"Get a knowledge base (with sources)","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/knowledge-bases/{id}","href":"/api-reference/knowledge-base/get-a-knowledge-base-with-sources"},{"title":"Archive a knowledge base","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/knowledge-bases/{id}","href":"/api-reference/knowledge-base/archive-a-knowledge-base"},{"title":"Update a knowledge base","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/knowledge-bases/{id}","href":"/api-reference/knowledge-base/update-a-knowledge-base"},{"title":"Add a text source","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/sources/text","href":"/api-reference/knowledge-base/add-a-text-source"},{"title":"Add an FAQ source","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/sources/faq","href":"/api-reference/knowledge-base/add-an-faq-source"},{"title":"Add a URL source","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/sources/url","href":"/api-reference/knowledge-base/add-a-url-source"},{"title":"Add a file source","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/sources/file","href":"/api-reference/knowledge-base/add-a-file-source"},{"title":"Delete a source","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/knowledge-bases/{id}/sources/{source_id}","href":"/api-reference/knowledge-base/delete-a-source"},{"title":"Rename a source","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/knowledge-bases/{id}/sources/{source_id}","href":"/api-reference/knowledge-base/rename-a-source"},{"title":"List query trainings","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/knowledge-bases/{id}/query-trainings","href":"/api-reference/knowledge-base/list-query-trainings"},{"title":"Create a query training","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/query-trainings","href":"/api-reference/knowledge-base/create-a-query-training"},{"title":"Delete a query training","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/knowledge-bases/{id}/query-trainings/{training_id}","href":"/api-reference/knowledge-base/delete-a-query-training"},{"title":"Update a query training","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/knowledge-bases/{id}/query-trainings/{training_id}","href":"/api-reference/knowledge-base/update-a-query-training"},{"title":"Toggle a query training active flag","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/query-trainings/{training_id}/toggle","href":"/api-reference/knowledge-base/toggle-a-query-training-active-flag"},{"title":"Assign a knowledge base to an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/assign","href":"/api-reference/knowledge-base/assign-a-knowledge-base-to-an-assistant"},{"title":"Remove a knowledge base from an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/remove","href":"/api-reference/knowledge-base/remove-a-knowledge-base-from-an-assistant"},{"title":"Enable voice for a knowledge base","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/voice/enable","href":"/api-reference/knowledge-base/enable-voice-for-a-knowledge-base"},{"title":"Disable voice for a knowledge base","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/voice/disable","href":"/api-reference/knowledge-base/disable-voice-for-a-knowledge-base"},{"title":"List an assistant's knowledge base ids","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/assistants/{id}/knowledge-bases","href":"/api-reference/knowledge-base/list-an-assistants-knowledge-base-ids"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Conversation stats for the subaccount","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/conversations/stats","href":"/api-reference/conversations/conversation-stats-for-the-subaccount"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/conversations/{id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"Delete (soft) a conversation","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/conversations/{id}","href":"/api-reference/conversations/delete-soft-a-conversation"},{"title":"Update a conversation","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/conversations/{id}","href":"/api-reference/conversations/update-a-conversation"},{"title":"List calls for a conversation","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/conversations/{id}/calls","href":"/api-reference/conversations/list-calls-for-a-conversation"}]},{"group":"Messages","pages":[{"title":"List messages in a conversation","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/conversations/{id}/messages","href":"/api-reference/messages/list-messages-in-a-conversation"},{"title":"Create a message","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/messages","href":"/api-reference/messages/create-a-message"}]},{"group":"Chat","pages":[{"title":"Run an AI chat completion on a conversation","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/chat/completions","href":"/api-reference/chat/run-an-ai-chat-completion-on-a-conversation"}]},{"group":"Calls","pages":[{"title":"List call history","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/calls","href":"/api-reference/calls/list-call-history"},{"title":"Place an AI voice call","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/calls","href":"/api-reference/calls/place-an-ai-voice-call"},{"title":"Call stats for the subaccount","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/calls/stats","href":"/api-reference/calls/call-stats-for-the-subaccount"},{"title":"Get a call (rich detail)","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/calls/{id}","href":"/api-reference/calls/get-a-call-rich-detail"}]},{"group":"Flows","pages":[{"title":"Create a flow","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/flows","href":"/api-reference/flows/create-a-flow"}]},{"group":"Alerts","pages":[{"title":"List alerts","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/alerts","href":"/api-reference/alerts/list-alerts"},{"title":"Get an alert","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/alerts/{id}","href":"/api-reference/alerts/get-an-alert"},{"title":"Update an alert's resolution status or note","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/alerts/{id}","href":"/api-reference/alerts/update-an-alerts-resolution-status-or-note"}]},{"group":"Monitor Rules","pages":[{"title":"List monitor rules","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/monitor-rules","href":"/api-reference/monitor-rules/list-monitor-rules"},{"title":"Create a monitor rule","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/monitor-rules","href":"/api-reference/monitor-rules/create-a-monitor-rule"},{"title":"Get a monitor rule","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/monitor-rules/{id}","href":"/api-reference/monitor-rules/get-a-monitor-rule"},{"title":"Delete a monitor rule","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/monitor-rules/{id}","href":"/api-reference/monitor-rules/delete-a-monitor-rule"},{"title":"Update a monitor rule","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/monitor-rules/{id}","href":"/api-reference/monitor-rules/update-a-monitor-rule"}]},{"group":"Subaccounts","pages":[{"title":"List subaccounts","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/subaccounts","href":"/api-reference/subaccounts/list-subaccounts"},{"title":"Create a subaccount — CreateAssistants Direct (name), or provision from a GoHighLevel Location ID (location_id)","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/subaccounts","href":"/api-reference/subaccounts/create-a-subaccount-—-createassistants-direct-name-or-provision-from-a-gohighlevel-location-id-location_id"},{"title":"Get a subaccount","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/subaccounts/{id}","href":"/api-reference/subaccounts/get-a-subaccount"},{"title":"List subaccount users","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/subaccounts/{id}/users","href":"/api-reference/subaccounts/list-subaccount-users"},{"title":"Add a user to a subaccount","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/subaccounts/{id}/users","href":"/api-reference/subaccounts/add-a-user-to-a-subaccount"},{"title":"Remove a user from a subaccount","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/subaccounts/{id}/users/{userId}","href":"/api-reference/subaccounts/remove-a-user-from-a-subaccount"},{"title":"Update a subaccount user's role","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/subaccounts/{id}/users/{userId}","href":"/api-reference/subaccounts/update-a-subaccount-users-role"},{"title":"Get a subaccount's wallet balances","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/subaccounts/{id}/wallet","href":"/api-reference/subaccounts/get-a-subaccounts-wallet-balances"},{"title":"Credit a subaccount or workspace wallet","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/subaccounts/{id}/wallet/credit","href":"/api-reference/subaccounts/credit-a-subaccount-or-workspace-wallet"},{"title":"Debit a subaccount or workspace wallet","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/subaccounts/{id}/wallet/debit","href":"/api-reference/subaccounts/debit-a-subaccount-or-workspace-wallet"}]}]}]},{"dropdown":"v1","icon":"book-open","tabs":[{"tab":"Documentation","groups":[{"group":"Get Started","pages":[{"title":"Introduction","icon":"hand-wave","href":"/get-started/introduction"},{"title":"Quickstart","icon":"bolt","href":"/get-started/quickstart"},{"title":"Platform Overview","icon":"sitemap","href":"/get-started/platform-overview"}]},{"group":"Build","pages":[{"group":"Voice AI","icon":"microphone","pages":[{"title":"Creating an AI Voice Assistant","icon":"microphone","href":"/build/voice-ai/creating-assistants"},{"title":"Voice Cloning","icon":"clone","href":"/build/voice-ai/voice-cloning"},{"title":"Call Settings","icon":"sliders","href":"/build/voice-ai/call-settings"},{"title":"Voicemail Handling","icon":"voicemail","href":"/build/voice-ai/voicemail-handling"},{"title":"Call Transfers","icon":"phone-arrow-right","href":"/build/voice-ai/call-transfers"},{"title":"Call Forwarding","icon":"phone-missed","href":"/build/voice-ai/call-forwarding"}]},{"group":"Chat AI","icon":"comments","pages":[{"title":"Chat AI Overview","icon":"comments","href":"/build/chat-ai/overview"},{"title":"AI Chat Widget","icon":"browser","href":"/build/chat-ai/chat-widget"},{"title":"AI Replying Tag","icon":"tag","href":"/build/chat-ai/ai-replying-tag"},{"title":"Global Kill Switch (ai_off)","icon":"power-off","href":"/build/chat-ai/kill-switch"}]},{"group":"Prompting \u0026 Knowledge","icon":"brain","pages":[{"title":"Prompt Engineering Tips","icon":"lightbulb","href":"/build/prompting/prompt-tips"},{"title":"Knowledge Base","icon":"book","href":"/build/prompting/knowledgebase"},{"title":"RAG and Knowledge Bases","icon":"database","href":"/build/prompting/rag-databases"},{"title":"Self-Selling Orb Demo","icon":"wand-magic-sparkles","href":"/build/prompting/self-selling-orb"}]},{"group":"Custom Tools","icon":"wrench","pages":[{"title":"Custom Tools Overview","icon":"wrench","href":"/build/custom-tools/overview"},{"title":"Managing Tools","icon":"gear","href":"/build/custom-tools/managing-tools"},{"title":"Save Address","icon":"location-dot","href":"/build/custom-tools/save-address"},{"title":"Update Contact in GoHighLevel","icon":"user-pen","href":"/build/custom-tools/update-contact"},{"title":"Search the Web","icon":"magnifying-glass","href":"/build/custom-tools/search-web"},{"title":"Scrape Website","icon":"globe","href":"/build/custom-tools/scrape-website"},{"title":"Screenshot Website","icon":"camera","href":"/build/custom-tools/screenshot-website"},{"title":"Submit Support Ticket","icon":"ticket","href":"/build/custom-tools/submit-ticket"},{"title":"Send Conversation Summary","icon":"file-lines","href":"/build/custom-tools/send-summary"},{"title":"Calculate Distance","icon":"route","href":"/build/custom-tools/calculate-distance"},{"title":"Call from SMS","icon":"phone-arrow-up-right","href":"/build/custom-tools/call-from-sms"},{"title":"Custom Multi-Calendar Routing","icon":"calendars","href":"/build/custom-tools/multi-calendar-booking"}]},{"group":"Flow Builder","icon":"diagram-project","pages":[{"title":"Getting Started with Flow Builder","icon":"diagram-project","href":"/build/flow-builder/getting-started"},{"title":"Conversation Node","icon":"message","href":"/build/flow-builder/conversation-node"},{"title":"Logic Node","icon":"code-branch","href":"/build/flow-builder/logic-node"},{"title":"Tool \u0026 Function Nodes","icon":"wrench","href":"/build/flow-builder/tool-function-nodes"},{"title":"Extraction \u0026 Variable Nodes","icon":"database","href":"/build/flow-builder/extraction-variable-nodes"},{"title":"Request Node (API Calls)","icon":"server","href":"/build/flow-builder/request-node"},{"title":"Variables \u0026 Dynamic Data","icon":"brackets-curly","href":"/build/flow-builder/variables"},{"title":"Node Builder (AI Generate)","icon":"wand-magic-sparkles","href":"/build/flow-builder/node-builder-ai"},{"title":"Testing Your Agent","icon":"flask-vial","href":"/build/flow-builder/testing"},{"title":"Engine \u0026 Streaming","icon":"bolt","href":"/build/flow-builder/streaming"},{"title":"Embedding the Chat Widget","icon":"window-maximize","href":"/build/flow-builder/embedding-widget"},{"title":"Connecting Voice (Telnyx)","icon":"phone","href":"/build/flow-builder/voice-connection"},{"title":"LLM Provider and API Key Setup","icon":"key","href":"/build/flow-builder/api-key"}]}]},{"group":"Deploy","pages":[{"group":"Telephony","icon":"phone","pages":[{"title":"Buy Phone Numbers","icon":"phone-plus","href":"/deploy/telephony/buy-numbers"},{"title":"Import Twilio Numbers","icon":"phone","href":"/deploy/telephony/import-twilio"},{"title":"Import Telnyx Numbers","icon":"phone","href":"/deploy/telephony/import-telnyx"},{"title":"Import Vonage Numbers","icon":"phone","href":"/deploy/telephony/import-vonage"},{"title":"Inbound Calls","icon":"phone-arrow-down-left","href":"/deploy/telephony/inbound-calls"},{"title":"Outbound Calls","icon":"phone-arrow-up-right","href":"/deploy/telephony/outbound-calls"},{"title":"Active Tags for Phone Numbers","icon":"tags","href":"/deploy/telephony/active-tags"}]},{"group":"Web Widgets","icon":"globe","pages":[{"title":"Voice Orb Widget","icon":"circle","href":"/deploy/widgets/orb-widget"},{"title":"Chat Widget","icon":"message","href":"/deploy/widgets/chat-widget"}]},{"group":"Webhooks","icon":"webhook","pages":[{"title":"Pre-Call \u0026 Post-Call Webhooks","icon":"webhook","href":"/deploy/webhooks/pre-post-call"}]}]},{"group":"Monitor","pages":[{"title":"Call Tagging","icon":"tags","href":"/monitor/call-tagging"},{"title":"AI Call Error Tags","icon":"triangle-exclamation","href":"/monitor/error-tags"},{"title":"CRM Transcripts","icon":"file-lines","href":"/monitor/crm-transcripts"},{"title":"Do Not Call Screening","icon":"shield-check","href":"/monitor/dnc-compliance"},{"title":"Number Intelligence","icon":"chart-simple","href":"/monitor/number-intelligence"}]},{"group":"Platform","pages":[{"title":"Workspace Setup","icon":"building","href":"/platform/workspace-setup"},{"title":"White Labeling","icon":"palette","href":"/platform/white-labeling"},{"title":"Branding","icon":"paintbrush","href":"/platform/branding"},{"title":"Sub-Account Management","icon":"users","href":"/platform/sub-account-management"},{"title":"Provisioning API","icon":"cloud-arrow-up","href":"/platform/subaccount-provisioning-api"},{"title":"Rebilling","icon":"money-bill","href":"/platform/rebilling"},{"title":"Stripe Integration","icon":"stripe-s","href":"/platform/stripe-integration"},{"title":"Billing Portal","icon":"credit-card","href":"/platform/billing-portal"},{"title":"Agency Wallet","icon":"wallet","href":"/platform/agency-wallet"},{"title":"Subaccount Wallet","icon":"piggy-bank","href":"/platform/subaccount-wallet"},{"title":"Snapshots","icon":"camera","href":"/platform/snapshots"},{"title":"User Management","icon":"user-plus","href":"/platform/user-management"},{"title":"Subaccount Limits","icon":"gauge","href":"/platform/subaccount-limits"},{"title":"Permissions","icon":"lock","href":"/platform/permissions"},{"title":"Restrictions","icon":"ban","href":"/platform/restrictions"}]},{"group":"How-To Guides","pages":[{"title":"Calendar Booking and Multi-Calendar Routing","icon":"calendar-days","href":"/how-to-guides/multi-calendar-booking"},{"title":"Send Emails from Chat","icon":"envelope","href":"/how-to-guides/send-emails-from-chat"},{"title":"Send SMS During Calls","icon":"message-sms","href":"/how-to-guides/send-sms-during-calls"},{"title":"Connect AI to Google Sheets","icon":"table","href":"/how-to-guides/google-sheets"},{"title":"Data Extraction","icon":"database","href":"/how-to-guides/data-extraction"},{"title":"Auto-Populate Custom Fields","icon":"wand-magic-sparkles","href":"/how-to-guides/auto-populate-fields"},{"title":"Update Contact Name After Call","icon":"user-pen","href":"/how-to-guides/update-contact-name"},{"title":"Flow Builder Guide","icon":"diagram-project","href":"/how-to-guides/flow-builder-guide"},{"title":"No-Show Follow-Up Automation","icon":"calendar-xmark","href":"/how-to-guides/no-show-followup"},{"title":"Transcript Workflows","icon":"scroll","href":"/how-to-guides/transcript-workflows"},{"title":"Appointment Deposits","icon":"money-check-dollar","href":"/how-to-guides/appointment-deposits"}]},{"group":"Troubleshooting","pages":[{"title":"Common Issues \u0026 Solutions","icon":"circle-question","href":"/troubleshooting/common-issues"},{"title":"Calendar Debugging","icon":"calendar-check","href":"/troubleshooting/calendar-debugging"},{"title":"Knowledge Base Optimization","icon":"book-sparkles","href":"/troubleshooting/knowledge-base-optimization"},{"title":"OAuth Configuration","icon":"key","href":"/troubleshooting/oauth-configuration"},{"title":"Chat Response Optimization","icon":"gauge-high","href":"/troubleshooting/chat-response-optimization"},{"title":"Dial Failed Errors","icon":"phone-xmark","href":"/troubleshooting/dial-failed"}]},{"group":"Integrations","pages":[{"title":"Connecting to GHL (Video)","icon":"video","href":"/integrations/ghl-connection-video"},{"title":"GHL Custom Menu Link","icon":"link","href":"/integrations/ghl-menu-link"},{"title":"GHL Direct Connection","icon":"plug","href":"/integrations/ghl-direct-connection"},{"title":"GHL OAuth Connection","icon":"key","href":"/integrations/ghl-oauth"}]},{"group":"Variables Reference","pages":[{"title":"Available Variables Reference","icon":"brackets-curly","href":"/variables/available-variables"}]}]},{"tab":"API Reference","groups":[{"group":"Assistants","pages":[{"group":"API Reference","pages":[{"title":"Create Assistant","deprecated":null,"version":null,"openapi":"/api-reference/assistant-api.json post /v2/create-assistant","href":"/api-reference/create-assistant"},{"title":"Get Assistant","deprecated":null,"version":null,"openapi":"/api-reference/assistant-api.json get /v2/get-assistant","href":"/api-reference/get-assistant"},{"title":"Update Assistant","deprecated":null,"version":null,"openapi":"/api-reference/assistant-api.json put /v2/update-assistant","href":"/api-reference/update-assistant"},{"title":"Archive Assistant","deprecated":null,"version":null,"openapi":"/api-reference/assistant-api.json delete /v2/delete-assistant","href":"/api-reference/archive-assistant"},{"title":"Create Flow","deprecated":null,"version":null,"openapi":"/api-reference/assistant-api.json post /v2/create-flow","href":"/api-reference/create-flow"}]}]},{"group":"Calling","pages":[{"group":"API Reference","pages":[{"title":"Make AI Call (GHL-Safe)","deprecated":null,"version":null,"openapi":"/api-reference/calling-api.json post /v2/ghl/make-call","href":"/api-reference/make-ai-call-ghl-safe"}]}]},{"group":"Chat","pages":[{"group":"API Reference","pages":[{"title":"Agent Chat Completion (GHL-Safe)","deprecated":null,"version":null,"openapi":"/api-reference/chat-api.json post /v2/ghl-chat-completion","href":"/api-reference/agent-chat-completion-ghl-safe"},{"title":"Create Message","deprecated":null,"version":null,"openapi":"/api-reference/chat-api.json post /v2/create-message","href":"/api-reference/create-message"},{"title":"Get Messages","deprecated":null,"version":null,"openapi":"/api-reference/chat-api.json get /v2/get-conversation","href":"/api-reference/get-messages"}]}]}]}]},{"dropdown":"Direct","icon":"bolt","tabs":[{"tab":"Guides","groups":[{"group":"Assistable Direct","pages":[{"title":"Assistable Direct","href":"/direct/overview"},{"title":"Provisioning","href":"/direct/provisioning"},{"title":"Webhook ingestion","href":"/direct/webhooks"},{"title":"Wallets","href":"/direct/wallets"}]}]},{"tab":"API Reference","groups":[{"group":"Assistants","pages":[{"title":"List assistants","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/assistants","href":"/api-reference/assistants/list-assistants"},{"title":"Create an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistants","href":"/api-reference/assistants/create-an-assistant"},{"title":"Get an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/assistants/{id}","href":"/api-reference/assistants/get-an-assistant"},{"title":"Delete (soft) an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/assistants/{id}","href":"/api-reference/assistants/delete-soft-an-assistant"},{"title":"Update an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/assistants/{id}","href":"/api-reference/assistants/update-an-assistant"},{"title":"Archive an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistants/{id}/archive","href":"/api-reference/assistants/archive-an-assistant"},{"title":"Unarchive an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistants/{id}/unarchive","href":"/api-reference/assistants/unarchive-an-assistant"},{"title":"Duplicate an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistants/{id}/duplicate","href":"/api-reference/assistants/duplicate-an-assistant"},{"title":"List assistant versions","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/assistants/{id}/versions","href":"/api-reference/assistants/list-assistant-versions"},{"title":"Revert an assistant to a version","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistants/{id}/versions/{version_id}/revert","href":"/api-reference/assistants/revert-an-assistant-to-a-version"},{"title":"List assistant notes","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/assistants/{id}/notes","href":"/api-reference/assistants/list-assistant-notes"},{"title":"Add a note to an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistants/{id}/notes","href":"/api-reference/assistants/add-a-note-to-an-assistant"},{"title":"Delete an assistant note","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/assistants/{id}/notes/{note_id}","href":"/api-reference/assistants/delete-an-assistant-note"}]},{"group":"Voices","pages":[{"title":"List voices","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/voices","href":"/api-reference/voices/list-voices"},{"title":"Distinct voice filter options","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/voices/filter-options","href":"/api-reference/voices/distinct-voice-filter-options"},{"title":"Voice library stats","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/voices/stats","href":"/api-reference/voices/voice-library-stats"},{"title":"Get a voice","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/voices/{id}","href":"/api-reference/voices/get-a-voice"},{"title":"Toggle whether a custom voice can be copied","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/voices/{id}/allow-copy","href":"/api-reference/voices/toggle-whether-a-custom-voice-can-be-copied"}]},{"group":"Assistant folders","pages":[{"title":"List assistant folders","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/assistant-folders","href":"/api-reference/assistant-folders/list-assistant-folders"},{"title":"Create an assistant folder","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistant-folders","href":"/api-reference/assistant-folders/create-an-assistant-folder"},{"title":"Delete (archive) an assistant folder","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/assistant-folders/{id}","href":"/api-reference/assistant-folders/delete-archive-an-assistant-folder"},{"title":"Update an assistant folder","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/assistant-folders/{id}","href":"/api-reference/assistant-folders/update-an-assistant-folder"},{"title":"Assign assistants to a folder","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistant-folders/{id}/assign","href":"/api-reference/assistant-folders/assign-assistants-to-a-folder"},{"title":"Remove assistants from a folder","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/assistant-folders/{id}/remove","href":"/api-reference/assistant-folders/remove-assistants-from-a-folder"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/contacts/{id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Delete (archive) a contact","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/contacts/{id}","href":"/api-reference/contacts/delete-archive-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/contacts/{id}","href":"/api-reference/contacts/update-a-contact"},{"title":"Permanently delete a contact","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/contacts/{id}/permanent-delete","href":"/api-reference/contacts/permanently-delete-a-contact"},{"title":"List contact notes","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/contacts/{id}/notes","href":"/api-reference/contacts/list-contact-notes"},{"title":"Add a note to a contact","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/contacts/{id}/notes","href":"/api-reference/contacts/add-a-note-to-a-contact"},{"title":"Delete a contact note","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/contacts/{id}/notes/{note_id}","href":"/api-reference/contacts/delete-a-contact-note"},{"title":"List contact interactions","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/contacts/{id}/interactions","href":"/api-reference/contacts/list-contact-interactions"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/tags","href":"/api-reference/tags/list-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/tags","href":"/api-reference/tags/create-a-tag"},{"title":"Get a tag","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/tags/{id}","href":"/api-reference/tags/get-a-tag"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/tags/{id}","href":"/api-reference/tags/delete-a-tag"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/tags/{id}","href":"/api-reference/tags/update-a-tag"},{"title":"Permanently delete a tag","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/tags/{id}/permanent-delete","href":"/api-reference/tags/permanently-delete-a-tag"}]},{"group":"Phone numbers","pages":[{"title":"List owned phone numbers","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/phone-numbers","href":"/api-reference/phone-numbers/list-owned-phone-numbers"},{"title":"Get a phone number","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/phone-numbers/{id}","href":"/api-reference/phone-numbers/get-a-phone-number"},{"title":"Update a phone number","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/phone-numbers/{id}","href":"/api-reference/phone-numbers/update-a-phone-number"},{"title":"Assign a phone number to an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/phone-numbers/{id}/assign","href":"/api-reference/phone-numbers/assign-a-phone-number-to-an-assistant"}]},{"group":"Number pools","pages":[{"title":"List number pools","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/number-pools","href":"/api-reference/number-pools/list-number-pools"},{"title":"Create a number pool","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/number-pools","href":"/api-reference/number-pools/create-a-number-pool"},{"title":"Get a number pool","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/number-pools/{id}","href":"/api-reference/number-pools/get-a-number-pool"},{"title":"Delete a number pool","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/number-pools/{id}","href":"/api-reference/number-pools/delete-a-number-pool"},{"title":"Update a number pool","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/number-pools/{id}","href":"/api-reference/number-pools/update-a-number-pool"},{"title":"Add phone numbers to a pool","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/number-pools/{id}/add-numbers","href":"/api-reference/number-pools/add-phone-numbers-to-a-pool"},{"title":"Remove phone numbers from a pool","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/number-pools/{id}/remove-numbers","href":"/api-reference/number-pools/remove-phone-numbers-from-a-pool"}]},{"group":"Tools","pages":[{"title":"List tools","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/tools","href":"/api-reference/tools/list-tools"},{"title":"Create a tool","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/tools","href":"/api-reference/tools/create-a-tool"},{"title":"List distinct tool categories","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/tools/categories","href":"/api-reference/tools/list-distinct-tool-categories"},{"title":"Get a tool (with parameters + headers)","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/tools/{id}","href":"/api-reference/tools/get-a-tool-with-parameters-+-headers"},{"title":"Delete (soft) a tool","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/tools/{id}","href":"/api-reference/tools/delete-soft-a-tool"},{"title":"Update a tool","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/tools/{id}","href":"/api-reference/tools/update-a-tool"},{"title":"Copy a tool into this subaccount","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/tools/{id}/copy","href":"/api-reference/tools/copy-a-tool-into-this-subaccount"},{"title":"Assign a tool to an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/tools/{id}/assign","href":"/api-reference/tools/assign-a-tool-to-an-assistant"},{"title":"Remove a tool from an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/tools/{id}/remove","href":"/api-reference/tools/remove-a-tool-from-an-assistant"},{"title":"List an assistant's tools","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/assistants/{id}/tools","href":"/api-reference/tools/list-an-assistants-tools"}]},{"group":"Knowledge base","pages":[{"title":"List knowledge bases","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/knowledge-bases","href":"/api-reference/knowledge-base/list-knowledge-bases"},{"title":"Create a knowledge base","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases","href":"/api-reference/knowledge-base/create-a-knowledge-base"},{"title":"Get a knowledge base (with sources)","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/knowledge-bases/{id}","href":"/api-reference/knowledge-base/get-a-knowledge-base-with-sources"},{"title":"Archive a knowledge base","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/knowledge-bases/{id}","href":"/api-reference/knowledge-base/archive-a-knowledge-base"},{"title":"Update a knowledge base","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/knowledge-bases/{id}","href":"/api-reference/knowledge-base/update-a-knowledge-base"},{"title":"Add a text source","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/sources/text","href":"/api-reference/knowledge-base/add-a-text-source"},{"title":"Add an FAQ source","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/sources/faq","href":"/api-reference/knowledge-base/add-an-faq-source"},{"title":"Add a URL source","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/sources/url","href":"/api-reference/knowledge-base/add-a-url-source"},{"title":"Add a file source","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/sources/file","href":"/api-reference/knowledge-base/add-a-file-source"},{"title":"Delete a source","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/knowledge-bases/{id}/sources/{source_id}","href":"/api-reference/knowledge-base/delete-a-source"},{"title":"Rename a source","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/knowledge-bases/{id}/sources/{source_id}","href":"/api-reference/knowledge-base/rename-a-source"},{"title":"List query trainings","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/knowledge-bases/{id}/query-trainings","href":"/api-reference/knowledge-base/list-query-trainings"},{"title":"Create a query training","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/query-trainings","href":"/api-reference/knowledge-base/create-a-query-training"},{"title":"Delete a query training","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/knowledge-bases/{id}/query-trainings/{training_id}","href":"/api-reference/knowledge-base/delete-a-query-training"},{"title":"Update a query training","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/knowledge-bases/{id}/query-trainings/{training_id}","href":"/api-reference/knowledge-base/update-a-query-training"},{"title":"Toggle a query training active flag","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/query-trainings/{training_id}/toggle","href":"/api-reference/knowledge-base/toggle-a-query-training-active-flag"},{"title":"Assign a knowledge base to an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/assign","href":"/api-reference/knowledge-base/assign-a-knowledge-base-to-an-assistant"},{"title":"Remove a knowledge base from an assistant","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/remove","href":"/api-reference/knowledge-base/remove-a-knowledge-base-from-an-assistant"},{"title":"Enable voice for a knowledge base","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/voice/enable","href":"/api-reference/knowledge-base/enable-voice-for-a-knowledge-base"},{"title":"Disable voice for a knowledge base","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/knowledge-bases/{id}/voice/disable","href":"/api-reference/knowledge-base/disable-voice-for-a-knowledge-base"},{"title":"List an assistant's knowledge base ids","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/assistants/{id}/knowledge-bases","href":"/api-reference/knowledge-base/list-an-assistants-knowledge-base-ids"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Conversation stats for the subaccount","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/conversations/stats","href":"/api-reference/conversations/conversation-stats-for-the-subaccount"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/conversations/{id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"Delete (soft) a conversation","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/conversations/{id}","href":"/api-reference/conversations/delete-soft-a-conversation"},{"title":"Update a conversation","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/conversations/{id}","href":"/api-reference/conversations/update-a-conversation"},{"title":"List calls for a conversation","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/conversations/{id}/calls","href":"/api-reference/conversations/list-calls-for-a-conversation"}]},{"group":"Messages","pages":[{"title":"List messages in a conversation","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/conversations/{id}/messages","href":"/api-reference/messages/list-messages-in-a-conversation"},{"title":"Create a message","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/messages","href":"/api-reference/messages/create-a-message"}]},{"group":"Chat","pages":[{"title":"Run an AI chat completion on a conversation","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/chat/completions","href":"/api-reference/chat/run-an-ai-chat-completion-on-a-conversation"}]},{"group":"Calls","pages":[{"title":"List call history","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/calls","href":"/api-reference/calls/list-call-history"},{"title":"Place an AI voice call","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/calls","href":"/api-reference/calls/place-an-ai-voice-call"},{"title":"Call stats for the subaccount","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/calls/stats","href":"/api-reference/calls/call-stats-for-the-subaccount"},{"title":"Get a call (rich detail)","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/calls/{id}","href":"/api-reference/calls/get-a-call-rich-detail"}]},{"group":"Flows","pages":[{"title":"Create a flow","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/flows","href":"/api-reference/flows/create-a-flow"}]},{"group":"Alerts","pages":[{"title":"List alerts","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/alerts","href":"/api-reference/alerts/list-alerts"},{"title":"Get an alert","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/alerts/{id}","href":"/api-reference/alerts/get-an-alert"},{"title":"Update an alert's resolution status or note","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/alerts/{id}","href":"/api-reference/alerts/update-an-alerts-resolution-status-or-note"}]},{"group":"Monitor Rules","pages":[{"title":"List monitor rules","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/monitor-rules","href":"/api-reference/monitor-rules/list-monitor-rules"},{"title":"Create a monitor rule","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/monitor-rules","href":"/api-reference/monitor-rules/create-a-monitor-rule"},{"title":"Get a monitor rule","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/monitor-rules/{id}","href":"/api-reference/monitor-rules/get-a-monitor-rule"},{"title":"Delete a monitor rule","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/monitor-rules/{id}","href":"/api-reference/monitor-rules/delete-a-monitor-rule"},{"title":"Update a monitor rule","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/monitor-rules/{id}","href":"/api-reference/monitor-rules/update-a-monitor-rule"}]},{"group":"Subaccounts","pages":[{"title":"List subaccounts","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/subaccounts","href":"/api-reference/subaccounts/list-subaccounts"},{"title":"Create a subaccount — CreateAssistants Direct (name), or provision from a GoHighLevel Location ID (location_id)","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/subaccounts","href":"/api-reference/subaccounts/create-a-subaccount-—-createassistants-direct-name-or-provision-from-a-gohighlevel-location-id-location_id"},{"title":"Get a subaccount","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/subaccounts/{id}","href":"/api-reference/subaccounts/get-a-subaccount"},{"title":"List subaccount users","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/subaccounts/{id}/users","href":"/api-reference/subaccounts/list-subaccount-users"},{"title":"Add a user to a subaccount","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/subaccounts/{id}/users","href":"/api-reference/subaccounts/add-a-user-to-a-subaccount"},{"title":"Remove a user from a subaccount","deprecated":null,"version":null,"openapi":"/direct/openapi.json delete /v3/subaccounts/{id}/users/{userId}","href":"/api-reference/subaccounts/remove-a-user-from-a-subaccount"},{"title":"Update a subaccount user's role","deprecated":null,"version":null,"openapi":"/direct/openapi.json patch /v3/subaccounts/{id}/users/{userId}","href":"/api-reference/subaccounts/update-a-subaccount-users-role"},{"title":"Get a subaccount's wallet balances","deprecated":null,"version":null,"openapi":"/direct/openapi.json get /v3/subaccounts/{id}/wallet","href":"/api-reference/subaccounts/get-a-subaccounts-wallet-balances"},{"title":"Credit a subaccount or workspace wallet","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/subaccounts/{id}/wallet/credit","href":"/api-reference/subaccounts/credit-a-subaccount-or-workspace-wallet"},{"title":"Debit a subaccount or workspace wallet","deprecated":null,"version":null,"openapi":"/direct/openapi.json post /v3/subaccounts/{id}/wallet/debit","href":"/api-reference/subaccounts/debit-a-subaccount-or-workspace-wallet"}]}]}]},{"dropdown":"Changelog","icon":"megaphone","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Introduction - Assistable.ai Docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":[],"chunks":[]}
