All the endpoints are protected by OAuth 2.0 and require a valid Bearer token. You can get your access token by following the steps described in the Authentication section.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Soca AI Docs","colors":{"primary":"#000000","light":"#F5F5F5","dark":"#1A1A1A"},"logo":{"light":"https://mintcdn.com/socaai/VtL_-zdMp9gq-Mem/logo/soca_dark.PNG?fit=max\u0026auto=format\u0026n=VtL_-zdMp9gq-Mem\u0026q=85\u0026s=bd3dcffe9d143ade76ef3289e54621d3","dark":"https://mintcdn.com/socaai/VtL_-zdMp9gq-Mem/logo/soca_light3.svg?fit=max\u0026auto=format\u0026n=VtL_-zdMp9gq-Mem\u0026q=85\u0026s=d5637badee006699846ed6483c16f4ad"},"favicon":"https://mintcdn.com/socaai/koH5r0Fiwom_Iuhw/favicon.svg?fit=max\u0026auto=format\u0026n=koH5r0Fiwom_Iuhw\u0026q=85\u0026s=7062fdaa7b8e2411cc88a7b8c5fe430a","navbar":{"links":[{"href":"mailto:support@soca.ai","label":"Support"}],"primary":{"type":"button","label":"Platform","href":"https://platform.soca.ai/"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"socaai","hasAudioNarration":false,"actualSubdomain":"socaai","customDomains":["docs.soca.ai"],"gitSource":{"type":"github","owner":"jimzblues13","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a66d7e97208e4fdad1f4c59","collectionId":"e7020a27-0e8c-4440-8c59-c7d7ebbb4a48","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a66d7e97208e4fdad1f4c59"},"entitlements":{},"buildId":"6a66d7e97208e4fdad1f4c59:success","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Build","count":11},{"language":"default","tag":"API Documentation","count":8},{"language":"default","tag":"Studio","count":5},{"language":"default","tag":"General","count":5},{"language":"default","tag":"Sessions","count":4},{"language":"default","tag":"Tools","count":4},{"language":"default","tag":"Getting Started","count":3},{"language":"default","tag":"Monitor","count":3},{"language":"default","tag":"Organization","count":3},{"language":"default","tag":"Whatsapp","count":2}]},"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":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Introduction","description":null,"href":"/api-reference/introduction"},"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`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{Card,CardGroup,CodeBlock,Heading}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Discover how to get more from `,_jsx(_components.strong,{children:`Soca AI`}),` with our `,_jsx(_components.strong,{children:`API Docs`}),`.`]}),`\n`,_jsx(CardGroup,{cols:2,children:_jsx(Card,{title:`Authentication`,color:`FBBC04`,icon:`key`,href:`https://docs.soca.ai/api-reference/credentials`,children:_jsx(_components.p,{children:`Learn how to get your API credentials`})})}),`\n`,_jsx(Heading,{level:`2`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://api.soca.ai`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`All the endpoints are protected by `,_jsx(_components.a,{href:`https://oauth.net/2/`,children:`OAuth 2.0`}),` and require a valid Bearer token. You can get your access token by following the steps described in the\\xA0`,_jsx(_components.strong,{children:`Authentication`}),` section.`]})]})}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":null,"href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base URL","slug":"base-url","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/socaai/8b96f900927206b1/components/VoiceWebSocketDocs.js"],"subdomain":"socaai","siteName":"Soca AI Docs","title":"Introduction - Soca AI Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-27T04:00:50.708Z","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=\"application-name\" content=\"Soca 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/socaai/nPskBwgSYGxuNjIo/_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/socaai/nPskBwgSYGxuNjIo/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/socaai/nPskBwgSYGxuNjIo/_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/socaai/nPskBwgSYGxuNjIo/_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/socaai/nPskBwgSYGxuNjIo/_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/socaai/nPskBwgSYGxuNjIo/_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/socaai/nPskBwgSYGxuNjIo/_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/socaai/nPskBwgSYGxuNjIo/_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/socaai/nPskBwgSYGxuNjIo/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Soca AI Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Soca AI Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.soca.ai/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://socaai.mintlify.app/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Introduction\u0026amp;theme=de2fd5b411d110100f4f9711\u0026amp;signature=f4ff061534cd55d749d26ef68878495aebd5f72593a4cd8a7b79da47900e67e3\">\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 - Soca AI Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://socaai.mintlify.app/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Introduction\u0026amp;theme=de2fd5b411d110100f4f9711\u0026amp;signature=f4ff061534cd55d749d26ef68878495aebd5f72593a4cd8a7b79da47900e67e3\">\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/socaai/nPskBwgSYGxuNjIo/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Soca AI Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.soca.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\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.soca.ai/#organization\",\"name\":\"Soca AI Docs\",\"url\":\"https://docs.soca.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/socaai/VtL_-zdMp9gq-Mem/logo/soca_dark.PNG?fit=max\u0026auto=format\u0026n=VtL_-zdMp9gq-Mem\u0026q=85\u0026s=bd3dcffe9d143ade76ef3289e54621d3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.soca.ai#website\",\"name\":\"Soca AI Docs\",\"url\":\"https://docs.soca.ai\",\"publisher\":{\"@id\":\"https://docs.soca.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.soca.ai/api-reference/introduction#webpage\",\"url\":\"https://docs.soca.ai/api-reference/introduction\",\"name\":\"Introduction\",\"dateModified\":\"2026-07-27T04:00:50.708Z\",\"isPartOf\":{\"@id\":\"https://docs.soca.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.soca.ai/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.soca.ai/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Soca AI Docs\",\"item\":\"https://docs.soca.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.soca.ai/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.soca.ai/api-reference/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"url\":\"https://docs.soca.ai/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.soca.ai/api-reference/introduction#webpage\"},\"dateModified\":\"2026-07-27T04:00:50.708Z\",\"publisher\":{\"@id\":\"https://docs.soca.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.soca.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Soca AI Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Soca AI Docs","nav":{"global":null,"groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Platform Overview","href":"/platform_overview"},{"title":"Tutorials","description":"Learn how to build AI agent.","href":"/tutorials"}]},{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"How can I get my credentials?","description":null,"href":"/api-reference/credentials"},{"group":"Chats","pages":[{"title":"Send Message","openapi":"POST /chat/{agent_id}","href":"/api-reference/chats/post"}]},{"group":"Sessions","pages":[{"title":"Create Session","openapi":"POST /session/{agent_id}","href":"/api-reference/sessions/create_session"},{"title":"List Session","openapi":"GET /session/{agent_id}","href":"/api-reference/sessions/list_session"},{"title":"Detail Session","openapi":"GET /session/chat/{agent_id}/{session_id}","href":"/api-reference/sessions/detail_session"},{"title":"Delete Session","openapi":"DELETE /session/{agent_id}/{session_id}","href":"/api-reference/sessions/delete_session"}]},{"group":"WSS Voice Stream","pages":[{"title":"Voice Stream Websocket","href":"/api-reference/voice/voice-stream"}]}]},{"group":"General","pages":[{"group":"How it Works","pages":[{"title":"Our Platform","href":"/general/our_platform"},{"title":"Multimodal","href":"/general/multimodal"}]},{"group":"Enterprise","pages":[{"title":"Enterprise Services","href":"/general/enterprise"},{"title":"On-Prem Deployments","href":"/general/onprem_deployment"}]},{"title":"Support","href":"/general/support"}]},{"group":"Build","pages":[{"group":"Studio","pages":[{"title":"Conversation Node","href":"/build/studio/conversation_node"},{"title":"Global Prompt Node","href":"/build/studio/global_prompt"},{"title":"Knowledge Based","href":"/build/studio/knowledge"},{"title":"Conditions Node","href":"/build/studio/conditions"},{"title":"Sub Agent","href":"/build/studio/sub_agent"}]},{"group":"Tools","pages":[{"title":"Shopify","href":"/build/tools/shopify"},{"title":"Virtual Try-On","href":"/build/tools/virtual_try_on"},{"title":"Webhook","href":"/build/tools/webhook"},{"title":"HTTP Request","href":"/build/tools/fetch_url"}]},{"title":"Contact Management","href":"/build/contact"},{"title":"Widget","href":"/build/widget"}]},{"group":"Monitor","pages":[{"title":"Inbox","href":"/monitor/inbox"},{"title":"Broadcast","href":"/monitor/broadcast"},{"title":"Follow Up","href":"/monitor/follow_up"}]},{"group":"Whatsapp","pages":[{"title":"Try Sandbox","href":"/channel/whatsapp/try_sandbox"},{"title":"Setup Account","href":"/channel/whatsapp/setup_account"}]},{"group":"Organization","pages":[{"title":"General","href":"/organization/general"},{"title":"Members","href":"/organization/members"},{"title":"Billing","href":"/organization/billing"}]}]},"title":"Introduction - Soca AI Docs","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":[],"chunks":[]}
