Step 1: Retrieve your API Key in the Auxia console
Open the Auxia console and select the “Manage” tab in the navigation bar. Under “API Integration”, you can find your organization’s API Key that has been created for you. You will use this API key in your requests.
In the next step, you will find our documentation for the Get Treatments API. This API will allow you to fetch all of the details that are needed for rendering the treatments in your app.For an overview of how this works, please visit the “Making your first call” section.
Step 3: Implement the Log Treatment Interactions API
This API enables your team to monitor how your users are engaging with the touch points you distribute through Auxia, like views and clicks.For an overview of how to set this up, please visit the “Tracking interactions” section.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Auxia Docs","description":"Documentation for the Auxia platform","colors":{"primary":"#0069ED","light":"#4D9CFF","dark":"#0050B4"},"logo":{"light":"https://mintcdn.com/auxia/fyABYGcDtDafgHjF/img/auxiaLogo.svg?fit=max\u0026auto=format\u0026n=fyABYGcDtDafgHjF\u0026q=85\u0026s=b8573baac6fdfdc968b11e9899724fac","dark":"https://mintcdn.com/auxia/fyABYGcDtDafgHjF/img/auxiaLogo-dark.svg?fit=max\u0026auto=format\u0026n=fyABYGcDtDafgHjF\u0026q=85\u0026s=d5fe4db495ad432aa4247ffd135081cb","href":"/"},"favicon":"https://mintcdn.com/auxia/3fKMPzXbMJ8IM9iY/images/favicon.png?fit=max\u0026auto=format\u0026n=3fKMPzXbMJ8IM9iY\u0026q=85\u0026s=4b7cfb2963dc8e912c24357b051b469f","navbar":{"links":[{"href":"https://console.auxia.io","label":"Console"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/auxia-io","website":"https://auxia.io"},"links":[{"header":"Docs","items":[{"label":"Docs","href":"/"}]},{"header":"Community","items":[{"label":"Website","href":"https://auxia.io"},{"label":"LinkedIn","href":"https://www.linkedin.com/company/auxia-io"}]},{"header":"More","items":[{"label":"Privacy Policy","href":"https://www.auxia.io/privacy-policy"},{"label":"Terms","href":"https://www.auxia.io/terms"}]}]},"styling":{"eyebrows":"breadcrumbs","latex":false},"interaction":{"drilldown":false},"navigation":{"languages":[{"language":"en","default":true,"href":""},{"language":"ja","href":"ja"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"auxia","hasAudioNarration":false,"actualSubdomain":"auxia","customDomains":["docs.auxia.io"],"gitSource":{"type":"github","owner":"auxia-inc","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6aeaee8452ea88647e5cafdb","collectionId":"8a6f6d7b-884a-4f17-9eda-5b70ea2c17c4","liveDeploymentHistoryId":"6aeaee8452ea88647e5cafdb","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aeaee8452ea88647e5cafdb","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"en","tag":"Auxia Docs","count":115},{"language":"ja","tag":"Auxiaドキュメント","count":91},{"language":"en","tag":"Documentation","count":75},{"language":"ja","tag":"技術仕様","count":51},{"language":"en","tag":"Data Ingestion","count":37},{"language":"en","tag":"Connectors","count":31},{"language":"en","tag":"User Guides","count":27},{"language":"ja","tag":"ユーザーガイド","count":27},{"language":"en","tag":"Console Reference","count":17},{"language":"ja","tag":"コンソールリファレンス","count":17},{"language":"en","tag":"API Reference","count":14},{"language":"ja","tag":"APIリファレンス","count":14},{"language":"en","tag":"Deploying Auxia","count":13},{"language":"ja","tag":"データ取り込み","count":13},{"language":"ja","tag":"Auxiaの導入","count":13},{"language":"en","tag":"Product Concepts","count":12},{"language":"ja","tag":"プロダクトコンセプト","count":12},{"language":"ja","tag":"データ接続","count":12},{"language":"en","tag":"Quick Start Guide","count":10},{"language":"ja","tag":"クイックスタートガイド","count":10}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--ifm-background-color: #ffffff;--ifm-color-emphasis-100: #f5f6f7;--ifm-color-emphasis-200: #ebedf0;--ifm-color-emphasis-300: #dadde1;--ifm-color-emphasis-500: #bec3c9;--ifm-color-emphasis-600: #8d949e;--ifm-color-emphasis-700: #606770}.dark,[data-theme=\"dark\"],html.dark{--ifm-background-color: #1b1b1d;--ifm-color-emphasis-100: #232629;--ifm-color-emphasis-200: #2e3134;--ifm-color-emphasis-300: #3e4245;--ifm-color-emphasis-500: #7a7f85;--ifm-color-emphasis-600: #9ba1a6;--ifm-color-emphasis-700: #c2c6ca}:root{--nest-rail: rgba(17, 24, 39, 0.11)}.dark,[data-theme=\"dark\"],html.dark{--nest-rail: rgba(255, 255, 255, 0.13)}#sidebar,#sidebar-content{width:21.5rem}#sidebar-content ul ul{margin-left:0.4rem;padding-left:0.55rem;border-left:1px solid var(--nest-rail)}#sidebar-content li>button{font-weight:600;letter-spacing:-0.005em}#sidebar-content ul ul li>button{font-weight:550}#sidebar-content ul ul ul li>button{font-weight:500;opacity:0.92}#sidebar-content ul ul li>a{font-weight:450}"}],"page":{"pagePath":"deploying-auxia/deploying-with-auxia-api","slug":"/deploying-auxia/deploying-with-auxia-api","pageMetadata":{"title":"Deploying with Auxia's API","description":"Steps to implement Auxia's APIs in your product","href":"/deploying-auxia/deploying-with-auxia-api"},"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: \"Steps to implement Auxia’s APIs in your product\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`step-1-retrieve-your-api-key-in-the-auxia-console`,children:_jsx(_components.strong,{children:`Step 1: Retrieve your API Key in the Auxia console`})}),`\n`,_jsx(_components.p,{children:`Open the Auxia console and select the “Manage” tab in the navigation bar. Under “API Integration”, you can find your organization’s API Key that has been created for you. You will use this API key in your requests.`}),`\n`,_jsx(Heading,{level:`2`,id:`step-2-implement-the-get-treatments-api`,children:_jsx(_components.strong,{children:`Step 2: Implement the Get Treatments API`})}),`\n`,_jsx(_components.p,{children:`In the next step, you will find our documentation for the Get Treatments API. This API will allow you to fetch all of the details that are needed for rendering the treatments in your app.`}),`\n`,_jsx(_components.p,{children:`For an overview of how this works, please visit the “Making your first call” section.`}),`\n`,_jsx(Heading,{level:`2`,id:`step-3-implement-the-log-treatment-interactions-api`,children:_jsx(_components.strong,{children:`Step 3: Implement the Log Treatment Interactions API`})}),`\n`,_jsx(_components.p,{children:`This API enables your team to monitor how your users are engaging with the touch points you distribute through Auxia, like views and clicks.`}),`\n`,_jsx(_components.p,{children:`For an overview of how to set this up, please visit the “Tracking interactions” 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":"Deploying with Auxia's API","description":"Steps to implement Auxia's APIs in your product","href":"/deploying-auxia/deploying-with-auxia-api"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Step 1: Retrieve your API Key in the Auxia console","slug":"step-1-retrieve-your-api-key-in-the-auxia-console","depth":2,"children":[]},{"title":"Step 2: Implement the Get Treatments API","slug":"step-2-implement-the-get-treatments-api","depth":2,"children":[]},{"title":"Step 3: Implement the Log Treatment Interactions API","slug":"step-3-implement-the-log-treatment-interactions-api","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"auxia","siteName":"Auxia Docs","title":"Deploying with Auxia's API - Auxia Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/deploying-auxia/deploying-with-auxia-api","matchLevel":0},"ja":{"href":"/ja/deploying-auxia/deploying-with-auxia-api","matchLevel":1}}},"lastModified":"2026-08-13T07:24:30.692Z","originalFileLocation":"deploying-auxia/deploying-with-auxia-api.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Steps to implement Auxia\u0026#x27;s APIs in your product\">\u003cmeta data-mint-head name=\"application-name\" content=\"Auxia 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/auxia/0kbdCk03jt0w6XN1/_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/auxia/0kbdCk03jt0w6XN1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/auxia/0kbdCk03jt0w6XN1/_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/auxia/0kbdCk03jt0w6XN1/_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/auxia/0kbdCk03jt0w6XN1/_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/auxia/0kbdCk03jt0w6XN1/_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/auxia/0kbdCk03jt0w6XN1/_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/auxia/0kbdCk03jt0w6XN1/_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/auxia/0kbdCk03jt0w6XN1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Deploying with Auxia\u0026#x27;s API - Auxia Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Steps to implement Auxia\u0026#x27;s APIs in your product\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Auxia Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.auxia.io/deploying-auxia/deploying-with-auxia-api\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://auxia.mintlify.app/_mintlify/api/og/v2?division=Deploying+with+Auxia+API\u0026amp;title=Deploying+with+Auxia%27s+API\u0026amp;description=Steps+to+implement+Auxia%27s+APIs+in+your+product\u0026amp;theme=771c4103f0e81c9f4656390b\u0026amp;signature=cfa537842f4ff2ea63188b6b0187da486f01a56892f7b3f3f8cd13e52df7d7a1\">\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=\"Deploying with Auxia\u0026#x27;s API - Auxia Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Steps to implement Auxia\u0026#x27;s APIs in your product\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://auxia.mintlify.app/_mintlify/api/og/v2?division=Deploying+with+Auxia+API\u0026amp;title=Deploying+with+Auxia%27s+API\u0026amp;description=Steps+to+implement+Auxia%27s+APIs+in+your+product\u0026amp;theme=771c4103f0e81c9f4656390b\u0026amp;signature=cfa537842f4ff2ea63188b6b0187da486f01a56892f7b3f3f8cd13e52df7d7a1\">\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/auxia/0kbdCk03jt0w6XN1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Auxia Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0069ED\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.auxia.io/deploying-auxia/deploying-with-auxia-api\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/deploying-auxia/deploying-with-auxia-api.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.auxia.io/deploying-auxia/deploying-with-auxia-api\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://docs.auxia.io/ja/deploying-auxia/deploying-with-auxia-api\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.auxia.io/deploying-auxia/deploying-with-auxia-api\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.auxia.io/#organization\",\"name\":\"Auxia Docs\",\"url\":\"https://docs.auxia.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/auxia/fyABYGcDtDafgHjF/img/auxiaLogo.svg?fit=max\u0026auto=format\u0026n=fyABYGcDtDafgHjF\u0026q=85\u0026s=b8573baac6fdfdc968b11e9899724fac\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.auxia.io#website\",\"name\":\"Auxia Docs\",\"url\":\"https://docs.auxia.io\",\"publisher\":{\"@id\":\"https://docs.auxia.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.auxia.io/deploying-auxia/deploying-with-auxia-api#webpage\",\"url\":\"https://docs.auxia.io/deploying-auxia/deploying-with-auxia-api\",\"name\":\"Deploying with Auxia's API\",\"description\":\"Steps to implement Auxia's APIs in your product\",\"dateModified\":\"2026-08-13T07:24:30.692Z\",\"isPartOf\":{\"@id\":\"https://docs.auxia.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.auxia.io/deploying-auxia/deploying-with-auxia-api#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.auxia.io/deploying-auxia/deploying-with-auxia-api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Auxia Docs\",\"item\":\"https://docs.auxia.io/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\",\"item\":\"https://docs.auxia.io/getting-started\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Deploying with Auxia's API\",\"item\":\"https://docs.auxia.io/deploying-auxia/deploying-with-auxia-api\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.auxia.io/deploying-auxia/deploying-with-auxia-api#article\",\"headline\":\"Deploying with Auxia's API\",\"name\":\"Deploying with Auxia's API\",\"description\":\"Steps to implement Auxia's APIs in your product\",\"url\":\"https://docs.auxia.io/deploying-auxia/deploying-with-auxia-api\",\"mainEntityOfPage\":{\"@id\":\"https://docs.auxia.io/deploying-auxia/deploying-with-auxia-api#webpage\"},\"dateModified\":\"2026-08-13T07:24:30.692Z\",\"publisher\":{\"@id\":\"https://docs.auxia.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.auxia.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Auxia Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Auxia Docs","nav":{"global":null,"languages":[{"language":"en","default":true,"groups":[{"group":"Auxia Docs","pages":[{"title":"Welcome!","href":""},{"group":"Product Concepts","pages":[{"title":"Product Concepts","sidebarTitle":"Overview","href":"/concepts"},{"title":"Goals","href":"/concepts/goals"},{"title":"Journeys","href":"/concepts/journeys"},{"title":"Treatments","href":"/concepts/treatments"},{"title":"Target Actions","href":"/concepts/target-actions"},{"title":"Guardrails","href":"/concepts/guardrails"},{"title":"Treatment Types","href":"/concepts/treatment-types"},{"title":"Surfaces","href":"/concepts/surfaces"},{"title":"Destinations","href":"/concepts/destinations"},{"title":"Data Fields","href":"/concepts/data-fields"},{"title":"Analytics","href":"/concepts/analytics"},{"title":"Agentic Capabilities","href":"/concepts/ai-insights"}]},{"group":"Documentation","pages":[{"group":"Integration Quick Start","pages":[{"title":"Integration Quick Start","sidebarTitle":"Overview","href":"/getting-started"},{"title":"Step 1: Ingesting your data","href":"/getting-started/step-1-ingesting-your-data"},{"title":"Step 2: Integrating Auxia into your product","href":"/getting-started/step-2-integrating-auxia-into-your-product"},{"title":"Step 3: Defining your goals","href":"/getting-started/step-3-defining-your-model-objective"},{"title":"Step 4: Creating your first treatment","href":"/getting-started/step-4-creating-your-first-treatment"},{"title":"Step 5: Measuring Success","href":"/getting-started/step-5-measuring-success"}]},{"group":"Data Ingestion","pages":[{"title":"Data ingestion overview","sidebarTitle":"Overview","href":"/data-ingestion/overview"},{"title":"How ingestion works","href":"/data-ingestion/concepts/how-ingestion-works"},{"group":"Connectors","pages":[{"title":"Connectors","sidebarTitle":"All connectors","href":"/data-ingestion/data-connections"},{"group":"Google BigQuery","pages":[{"title":"Google BigQuery","sidebarTitle":"Overview","href":"/data-ingestion/data-connections/google-bigquery"},{"title":"Google BigQuery setup guide","sidebarTitle":"Setup guide","href":"/data-ingestion/data-connections/google-bigquery/setup-guide"},{"title":"Troubleshooting Google BigQuery","sidebarTitle":"Troubleshooting","href":"/data-ingestion/data-connections/google-bigquery/troubleshooting"},{"title":"Google BigQuery release notes","sidebarTitle":"Release notes","href":"/data-ingestion/data-connections/google-bigquery/release-notes"}]},{"group":"Google Cloud Storage","pages":[{"title":"Google Cloud Storage","sidebarTitle":"Overview","href":"/data-ingestion/data-connections/google-cloud-storage"},{"title":"Google Cloud Storage setup guide","sidebarTitle":"Setup guide","href":"/data-ingestion/data-connections/google-cloud-storage/setup-guide"},{"title":"Troubleshooting Google Cloud Storage","sidebarTitle":"Troubleshooting","href":"/data-ingestion/data-connections/google-cloud-storage/troubleshooting"},{"title":"Google Cloud Storage release notes","sidebarTitle":"Release notes","href":"/data-ingestion/data-connections/google-cloud-storage/release-notes"}]},{"group":"Amazon S3","pages":[{"title":"Amazon S3","sidebarTitle":"Overview","href":"/data-ingestion/data-connections/amazon-s3"},{"title":"Amazon S3 setup guide","sidebarTitle":"Setup guide","href":"/data-ingestion/data-connections/amazon-s3/setup-guide"},{"title":"Troubleshooting Amazon S3","sidebarTitle":"Troubleshooting","href":"/data-ingestion/data-connections/amazon-s3/troubleshooting"},{"title":"Amazon S3 release notes","sidebarTitle":"Release notes","href":"/data-ingestion/data-connections/amazon-s3/release-notes"}]},{"group":"Amazon Kinesis","pages":[{"title":"Amazon Kinesis","sidebarTitle":"Overview","href":"/data-ingestion/data-connections/amazon-kinesis"},{"title":"Amazon Kinesis setup guide","sidebarTitle":"Setup guide","href":"/data-ingestion/data-connections/amazon-kinesis/setup-guide"}]},{"group":"Snowflake","pages":[{"title":"Snowflake","sidebarTitle":"Overview","href":"/data-ingestion/data-connections/snowflake"},{"title":"Snowflake (Direct Connection)","sidebarTitle":"Setup: Direct connection","href":"/data-ingestion/data-connections/snowflake/direct-connection"},{"title":"Snowflake (GCS Export)","sidebarTitle":"Setup: GCS export","href":"/data-ingestion/data-connections/snowflake/gcs-export"}]},{"group":"Databricks","pages":[{"title":"Databricks","sidebarTitle":"Overview","href":"/data-ingestion/data-connections/databricks"},{"title":"Databricks (Unity Catalog)","sidebarTitle":"Setup: Unity Catalog","href":"/data-ingestion/data-connections/databricks/unity-catalog"},{"title":"Databricks (Delta Transfer)","sidebarTitle":"Setup: Delta Transfer","href":"/data-ingestion/data-connections/databricks/delta-transfer"}]},{"group":"SFTP","pages":[{"title":"SFTP","sidebarTitle":"Overview","href":"/data-ingestion/data-connections/sftp"},{"title":"SFTP setup guide","sidebarTitle":"Setup guide","href":"/data-ingestion/data-connections/sftp/setup-guide"}]},{"group":"Google Cloud Pub/Sub","pages":[{"title":"Google Cloud Pub/Sub","sidebarTitle":"Overview","href":"/data-ingestion/data-connections/gcp-pubsub"},{"title":"Events and User Attributes ingestion via Pub/Sub","sidebarTitle":"Setup: Auxia reads your topic","href":"/data-ingestion/data-connections/gcp-pubsub/events-and-users-attributes-ingestion-via-pubsub"},{"title":"Google Cloud Pub/Sub: publish to an Auxia topic","sidebarTitle":"Setup: Publish to Auxia's topic","href":"/data-ingestion/data-connections/gcp-pubsub/publish-to-auxia"}]},{"group":"Amplitude","pages":[{"title":"Amplitude","sidebarTitle":"Overview","href":"/data-ingestion/data-connections/amplitude"},{"title":"Batch with Export API","sidebarTitle":"Setup: Export API","href":"/data-ingestion/data-connections/amplitude/amplitude-batch-with-export-API"},{"title":"Streaming with Google Pub/Sub","sidebarTitle":"Setup: Pub/Sub streaming","href":"/data-ingestion/data-connections/amplitude/amplitude-streaming-via-google-pubsub"}]},{"group":"Firebase","pages":[{"title":"Firebase","sidebarTitle":"Overview","href":"/data-ingestion/data-connections/firebase"},{"title":"Firebase Event Tracking and BigQuery Integration","sidebarTitle":"Setup guide","href":"/data-ingestion/data-connections/firebase-event-tracking-with-gcp-bigquery-integration"}]}]},{"group":"Reference","pages":[{"title":"What data is needed","href":"/data-ingestion/what-data-is-needed"},{"title":"File source requirements","href":"/data-ingestion/concepts/file-sources"},{"title":"Map your data","sidebarTitle":"Map your data","href":"/data-ingestion/concepts/map-your-data"},{"title":"Monitoring with Data Health","description":"Turn on a new connection, read its status, and know when to act","href":"/data-ingestion/concepts/monitoring"}]}]},{"group":"Deploying Auxia","pages":[{"group":"Deploying with Auxia API","pages":[{"title":"Deploying with Auxia's API","href":"/deploying-auxia/deploying-with-auxia-api"},{"title":"Making Your First Call","description":"How to make your first call with Auxia","href":"/deploying-auxia/deploying-with-auxia-api/making-your-first-call"},{"title":"Surfaces and Types","href":"/deploying-auxia/deploying-with-auxia-api/surfaces-and-types"},{"title":"Contextual Attributes","href":"/deploying-auxia/deploying-with-auxia-api/contextual-attributes"}]},{"group":"Delivery Integrations","pages":[{"title":"Delivery Integrations","sidebarTitle":"Overview","href":"/deploying-auxia/delivery-integrations"},{"title":"Braze","href":"/deploying-auxia/delivery-integrations/braze"},{"group":"Firebase Push Notifications","pages":[{"title":"Overview","href":"/deploying-auxia/delivery-integrations/firebase-push-notifications-integration-manual/overview"},{"title":"Integrate Firebase on the client application","href":"/deploying-auxia/delivery-integrations/firebase-push-notifications-integration-manual/integrate-firebase-on-the-client-application"},{"title":"Enable Auxia to Send Push Notifications","href":"/deploying-auxia/delivery-integrations/firebase-push-notifications-integration-manual/enable-auxia-to-send-notification"},{"title":"Enable Auxia to collect notification events","href":"/deploying-auxia/delivery-integrations/firebase-push-notifications-integration-manual/enable-auxia-to-collect-notification-events"},{"title":"Sample Push Notification Script","href":"/deploying-auxia/delivery-integrations/firebase-push-notifications-integration-manual/sample-push-notifications-script"},{"group":"Sample Flutter Setup","pages":[{"title":"Sample Flutter Set up","href":"/deploying-auxia/delivery-integrations/firebase-push-notifications-integration-manual/sample-flutter-set-up"},{"title":"Sample Flutter Client Implementation","href":"/deploying-auxia/delivery-integrations/firebase-push-notifications-integration-manual/sample-flutter-set-up/sample-flutter-client-implementation"}]}]}]}]},{"group":"API Reference","pages":[{"title":"Get Treatments","href":"/api-reference/get-treatments"},{"title":"Log Events","href":"/api-reference/log-events"},{"title":"Log Treatment Interactions","href":"/api-reference/log-treatment-interactions"},{"title":"Errors","href":"/api-reference/errors"},{"group":"SDK","pages":[{"title":"Web SDK: Render from the Auxia Console","sidebarTitle":"Render from the Auxia Console","href":"/api-reference/sdk/javascript-sdk"},{"title":"Web SDK: Render from Your Own Code","sidebarTitle":"Render from Your Own Code","href":"/api-reference/sdk/render-from-your-code"}]},{"group":"Treatment Management","pages":[{"title":"Treatment Management","sidebarTitle":"Overview","href":"/api-reference/treatment-management"},{"title":"Insert/Update Treatment","href":"/api-reference/treatment-management/insert-update-treatment"},{"title":"Insert/Update Treatment Type","href":"/api-reference/treatment-management/insert-update-treatment-type"},{"title":"Get Treatment","href":"/api-reference/treatment-management/get-treatment"},{"title":"Get All Treatments","href":"/api-reference/treatment-management/get-all-treatments"},{"title":"Get DataFields","href":"/api-reference/treatment-management/get-datafields"},{"title":"Insert DataField","href":"/api-reference/treatment-management/insert-data-field"},{"title":"Insert Surface","href":"/api-reference/treatment-management/insert-surface"}]}]},{"group":"Bulk Upload","pages":[{"title":"Bulk Upload","sidebarTitle":"Overview","href":"/bulk-upload"},{"title":"Generate CSV Template","href":"/bulk-upload/generate-template"},{"title":"CSV Field Reference","href":"/bulk-upload/csv-field-reference"},{"title":"Upload and Validate","href":"/bulk-upload/upload-and-validate"},{"title":"Bulk Upload History","href":"/bulk-upload/bulk-upload-history"}]}]},{"group":"User Guides","pages":[{"group":"Quick Start Guide","pages":[{"title":"Introduction to Auxia Console","sidebarTitle":"Introduction","href":"/guides/quick-start/introduction"},{"title":"First-Time Setup Checklist","sidebarTitle":"First-Time Setup","href":"/guides/quick-start/first-time-setup"},{"title":"Understanding Goals","sidebarTitle":"Understanding Goals","href":"/guides/quick-start/understanding-goals"},{"title":"Creating Your First Journey","sidebarTitle":"Creating First Journey","href":"/guides/quick-start/creating-first-journey"},{"title":"Creating Your First Treatment","sidebarTitle":"Creating First Treatment","href":"/guides/quick-start/creating-first-treatment"},{"title":"QA Testing","sidebarTitle":"QA Testing","href":"/guides/quick-start/qa-testing"},{"title":"Understanding Analytics","sidebarTitle":"Understanding Analytics","href":"/guides/quick-start/understanding-analytics"},{"title":"Using Agent and AI Insights","sidebarTitle":"Using Agent and AI Insights","href":"/guides/quick-start/using-ai-insights"},{"title":"Quick Reference","sidebarTitle":"Quick Reference","href":"/guides/quick-start/quick-reference"},{"group":"Appendices","pages":[{"title":"Glossary","href":"/guides/quick-start/appendices/glossary"}]}]},{"group":"Console Reference","pages":[{"title":"Introduction","sidebarTitle":"Introduction","href":"/guides/comprehensive/introduction"},{"title":"Section 2: Home Dashboard","sidebarTitle":"Home Dashboard","href":"/guides/comprehensive/home-dashboard"},{"title":"Managing Goals","sidebarTitle":"Managing Goals","href":"/guides/comprehensive/goals"},{"title":"Managing Journeys","sidebarTitle":"Managing Journeys","href":"/guides/comprehensive/journeys"},{"title":"Managing Treatments","sidebarTitle":"Managing Treatments","href":"/guides/comprehensive/treatments"},{"title":"Analytics","sidebarTitle":"Analytics","href":"/guides/comprehensive/analytics"},{"title":"Agent and AI Insights","sidebarTitle":"Agent and AI Insights","href":"/guides/comprehensive/ai-insights"},{"title":"Section 8: QA \u0026 Testing","sidebarTitle":"QA \u0026 Testing","href":"/guides/comprehensive/qa-testing"},{"title":"Configuration","sidebarTitle":"Configuration","href":"/guides/comprehensive/configuration"},{"title":"Section 10: Admin (Users \u0026 Roles)","sidebarTitle":"Admin","href":"/guides/comprehensive/admin"},{"group":"SSO Setup","pages":[{"title":"Single Sign-On (SSO) Setup","sidebarTitle":"SSO Overview","href":"/guides/comprehensive/sso"},{"title":"Setting Up SSO with Microsoft Entra ID","sidebarTitle":"Microsoft Entra ID","href":"/guides/comprehensive/sso/microsoft-entra-id"},{"title":"Setting Up SSO with Okta","sidebarTitle":"Okta","href":"/guides/comprehensive/sso/okta"},{"title":"Setting Up SSO with Auth0","sidebarTitle":"Auth0","href":"/guides/comprehensive/sso/auth0"}]},{"group":"Appendices","pages":[{"title":"Appendix A: Glossary","href":"/guides/comprehensive/appendices/glossary"},{"title":"Appendix B: Permissions Reference","href":"/guides/comprehensive/appendices/permissions-reference"},{"title":"Appendix C: Troubleshooting \u0026 FAQ","href":"/guides/comprehensive/appendices/troubleshooting-faq"}]}]}]}]}]},{"language":"ja","pages":[{"title":"ja","href":"/ja/deploying-auxia/deploying-with-auxia-api"}]}]},"basePath":"","title":"Deploying with Auxia's API - Auxia Docs","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":[],"chunks":[]}