Our Chat API allows a user to have a conversation with your AI agent via a simple API call. The messages array should contain the conversation between the user and the AI agent. You can send the entire conversation within the API request. Each message object has a role (user or assistant) and content. In the example below you can see a short conversation between a user and an AI agent. The message from the user has the role: user and all replies from the My AskAI have the role: assistant.
If your AI agent doesn’t know the answer, the API will also return an additional field to confirm an answer wasn’t found as well as 3 suggested questions the user can retry (these have a very high likelihood of being answered correctly): "unknown_answer": "yes","suggestedQuestions": ["Example question", ...]
You can also pass in "insights": true to generate insights in your Dashboard from any API usage. When Insights is enabled in the API a conversation_id is also returned with each request. This can be included in subsequent API requests to keep the requests link to 1 conversation. However, you still need to always pass in the message history as the API is stateless.
If human handover guidance is triggered the API response will include: "human_handover": true
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"My AskAI","colors":{"primary":"#EA3609","light":"#EA3609","dark":"#EA3609"},"logo":{"light":"https://mintcdn.com/myaskai/jQMqT5axxz3I9e3g/logo/wordmark.png?fit=max\u0026auto=format\u0026n=jQMqT5axxz3I9e3g\u0026q=85\u0026s=0e97cb4465dfed1d78e1ae94d7647f33","dark":"https://mintcdn.com/myaskai/jQMqT5axxz3I9e3g/logo/wordmark-white.png?fit=max\u0026auto=format\u0026n=jQMqT5axxz3I9e3g\u0026q=85\u0026s=cc323ab1480ed82737841a47a458ae38"},"favicon":"https://mintcdn.com/myaskai/rqZPZCBQmxu6qsJ1/favicon.png?fit=max\u0026auto=format\u0026n=rqZPZCBQmxu6qsJ1\u0026q=85\u0026s=f6457e9373cf3b11d91cab813f903094","navbar":{"primary":{"type":"button","label":"Create free AI agent","href":"https://myaskai.com/"}},"footer":{"socials":{"x":"https://twitter.com/usemyaskai","linkedin":"https://www.linkedin.com/company/myaskai","youtube":"https://www.youtube.com/@usemyaskai"}},"search":{"prompt":"Search..."},"fonts":{"family":"Inter"},"integrations":{"intercom":{"appId":"s8su4f08"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"myaskai","hasAudioNarration":false,"actualSubdomain":"myaskai","customDomains":["support.myaskai.com"],"gitSource":{"type":"github","owner":"arainey2022","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"collectionId":"3e311603-71f5-4fdb-a9a2-2a42fce58c19","liveDeploymentHistoryId":"6ad011f3d897f557f493997f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad011f3d897f557f493997f"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ad011f3d897f557f493997f","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Features","count":58},{"language":"default","tag":"FAQ","count":26},{"language":"default","tag":"General","count":26},{"language":"default","tag":"Channels","count":25},{"language":"default","tag":"Account Management","count":22},{"language":"default","tag":"Start here","count":19},{"language":"default","tag":"Playbooks","count":10},{"language":"default","tag":"Billing","count":9},{"language":"default","tag":"Security + Privacy","count":9},{"language":"default","tag":"Privacy","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-documentation/chat-api","slug":"/api-documentation/chat-api","pageMetadata":{"title":"Chat API","openapi":"api-documentation/chat.yaml POST /ask-ai-chat","description":null,"href":"/api-documentation/chat-api"},"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`,strong:`strong`,..._provideComponents(),...props.components},{Info,Warning}=_components;if(!Info)_missingMdxReference(`Info`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Our Chat API allows a user to have a conversation with your AI agent via a simple API call. `}),`\n`,_jsxs(_components.p,{children:[`The `,_jsx(_components.strong,{children:`messages`}),` array should contain the conversation between the user and the AI agent. You can send the entire conversation within the API request. `]}),`\n`,_jsxs(_components.p,{children:[`Each message object has a `,_jsx(_components.strong,{children:`role`}),` (user or assistant) and `,_jsx(_components.strong,{children:`content`}),`. `]}),`\n`,_jsx(_components.p,{children:`In the example below you can see a short conversation between a user and an AI agent. `}),`\n`,_jsxs(_components.p,{children:[`The message from the user has the `,_jsx(_components.strong,{children:`role: user`}),` and all replies from the My AskAI have the `,_jsx(_components.strong,{children:`role: assistant`}),`.`]}),`\n`,_jsxs(Warning,{children:[_jsx(_components.p,{children:`If your AI agent doesn’t know the answer, the API will also return an additional field to confirm an answer wasn’t found as well as 3 suggested questions the user can retry (these have a very high likelihood of being answered correctly): `}),_jsx(_components.p,{children:_jsx(_components.code,{children:`\"unknown_answer\": \"yes\",`})}),_jsx(_components.p,{children:_jsx(_components.code,{children:`\"suggestedQuestions\": [\"Example question\", ...]`})})]}),`\n`,_jsxs(Info,{children:[_jsxs(_components.p,{children:[`You can also pass in `,_jsx(_components.code,{children:`\"insights\": true`}),` to generate insights in your Dashboard from any API usage. `]}),_jsxs(_components.p,{children:[`When Insights is enabled in the API a `,_jsx(_components.code,{children:`conversation_id`}),` is also returned with each request. This can be included in subsequent API requests to keep the requests link to 1 conversation. However, you still need to always pass in the message history as the API is stateless.`]})]}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`If human handover `,_jsx(_components.a,{href:`/features/improve/guidance`,children:`guidance`}),` is triggered the API response will include: `,_jsx(_components.code,{children:`\"human_handover\": true`})]})})]})}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":"Chat API","openapi":"api-documentation/chat.yaml POST /ask-ai-chat","description":null,"href":"/api-documentation/chat-api"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Chat with AskAI","requestBody":"67b00f32-ad67-4eb5-b356-bae463b08674","responses":{"200":"b41fd095-a861-45f2-801c-056bdb53c1ac"},"method":"post","type":"path","servers":["f60ca608-8840-4a4f-83cd-4765104313c5"],"security":[],"path":"/ask-ai-chat","baseUrlOptions":["https://myaskai.com/api/1.1/wf"],"title":"Chat with AskAI","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"AskAI ID","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"api_key":{"type":"string","description":"AskAI API Key","isRequired":true,"uniqueKey":"api_key","typeLabel":"string"},"messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"Role in the conversation (user or assistant)","uniqueKey":"messages.items.[INDEX].role","typeLabel":"string"},"content":{"type":"string","description":"Content of the message","uniqueKey":"messages.items.[INDEX].content","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"messages","typeLabel":"object[]"}},"required":["id","api_key","messages"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","api_key":"\u003cstring>","messages":[{"role":"\u003cstring>","content":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"b41fd095-a861-45f2-801c-056bdb53c1ac":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"answer":{"type":"string","description":"Answer from AskAI","uniqueKey":"answer","typeLabel":"string"},"references":{"type":"array","items":{"type":"object","properties":{"content":{"type":"string","description":"Content of the reference","uniqueKey":"references.items.[INDEX].content","typeLabel":"string"},"link":{"type":"string","format":"uri","description":"Link to the reference","uniqueKey":"references.items.[INDEX].link","typeLabel":"string\u003curi>"},"score":{"type":"number","format":"float","description":"Score of the reference","uniqueKey":"references.items.[INDEX].score","typeLabel":"number\u003cfloat>"},"title":{"type":"string","description":"Title of the reference","uniqueKey":"references.items.[INDEX].title","typeLabel":"string"}},"uniqueKey":"references.items.[INDEX]","typeLabel":"object"},"uniqueKey":"references","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"answer":"\u003cstring>","references":[{"content":"\u003cstring>","link":"\u003cstring>","score":123,"title":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"f60ca608-8840-4a4f-83cd-4765104313c5":{"url":"https://myaskai.com/api/1.1/wf"}}},"originalFileLocation":"api-documentation/chat.yaml"},"subdomain":"myaskai","siteName":"My AskAI","title":"Chat API - My AskAI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-01T14:06:08.248Z","originalFileLocation":"api-documentation/chat-api.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=\"My AskAI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/myaskai/kCBng7DMvkybpCGN/_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/myaskai/kCBng7DMvkybpCGN/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/myaskai/kCBng7DMvkybpCGN/_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/myaskai/kCBng7DMvkybpCGN/_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/myaskai/kCBng7DMvkybpCGN/_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/myaskai/kCBng7DMvkybpCGN/_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/myaskai/kCBng7DMvkybpCGN/_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/myaskai/kCBng7DMvkybpCGN/_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/myaskai/kCBng7DMvkybpCGN/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Chat API - My AskAI\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"My AskAI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://support.myaskai.com/api-documentation/chat-api\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://myaskai.mintlify.app/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Chat+API\u0026amp;theme=2d252c5ceff28f6db7ec1eab\u0026amp;signature=8cf48aa3f7bd4a5d59eb55d7976ad4f433cf4fe8f343b57c8be313286558410f\">\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=\"Chat API - My AskAI\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://myaskai.mintlify.app/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Chat+API\u0026amp;theme=2d252c5ceff28f6db7ec1eab\u0026amp;signature=8cf48aa3f7bd4a5d59eb55d7976ad4f433cf4fe8f343b57c8be313286558410f\">\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/myaskai/kCBng7DMvkybpCGN/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"My AskAI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#EA3609\">\u003clink data-mint-head rel=\"canonical\" href=\"https://support.myaskai.com/api-documentation/chat-api\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-documentation/chat-api.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://support.myaskai.com/#organization\",\"name\":\"My AskAI\",\"url\":\"https://support.myaskai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/myaskai/jQMqT5axxz3I9e3g/logo/wordmark.png?fit=max\u0026auto=format\u0026n=jQMqT5axxz3I9e3g\u0026q=85\u0026s=0e97cb4465dfed1d78e1ae94d7647f33\"}},{\"@type\":\"WebSite\",\"@id\":\"https://support.myaskai.com#website\",\"name\":\"My AskAI\",\"url\":\"https://support.myaskai.com\",\"publisher\":{\"@id\":\"https://support.myaskai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://support.myaskai.com/api-documentation/chat-api#webpage\",\"url\":\"https://support.myaskai.com/api-documentation/chat-api\",\"name\":\"Chat API\",\"dateModified\":\"2026-09-01T14:06:08.248Z\",\"isPartOf\":{\"@id\":\"https://support.myaskai.com#website\"},\"breadcrumb\":{\"@id\":\"https://support.myaskai.com/api-documentation/chat-api#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://support.myaskai.com/api-documentation/chat-api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Documentation\",\"item\":\"https://support.myaskai.com/api-documentation/api-docs-introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Chat API\",\"item\":\"https://support.myaskai.com/api-documentation/chat-api\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://support.myaskai.com/api-documentation/chat-api#apireference\",\"headline\":\"Chat API\",\"name\":\"Chat API\",\"url\":\"https://support.myaskai.com/api-documentation/chat-api\",\"mainEntityOfPage\":{\"@id\":\"https://support.myaskai.com/api-documentation/chat-api#webpage\"},\"dateModified\":\"2026-09-01T14:06:08.248Z\",\"publisher\":{\"@id\":\"https://support.myaskai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://support.myaskai.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"My AskAI\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"My AskAI","nav":{"global":null,"groups":[{"group":"Welcome","pages":[{"title":"Welcome to My AskAI","href":"/index"}]},{"group":"Start here","pages":[{"group":"What is an AI Customer Support Agent?","pages":[{"title":"What is an AI Customer Support Agent?","href":"/start-here/what-is-an-ai-customer-support-agent"},{"title":"What are the benefits of using My AskAI?","href":"/start-here/what-is-an-ai-customer-support-agent/what-are-the-benefits-of-using-my-askai"},{"title":"Who is this for?","href":"/start-here/what-is-an-ai-customer-support-agent/who-is-this-for"}]},{"title":"Create your AI customer service agent","href":"/start-here/create-your-ai-customer-service-agent"},{"title":"Onboarding","href":"/start-here/onboarding"},{"group":"Playbooks","pages":[{"title":"Playbooks","href":"/start-here/playbooks"},{"title":"Test before going live","href":"/start-here/playbooks/test-before-going-live"},{"title":"Gradually roll out AI support","href":"/start-here/playbooks/gradually-roll-out-ai-support"},{"title":"Prevent AI replies to certain topics","href":"/start-here/playbooks/prevent-ai-replies-to-certain-topics"},{"title":"Prevent AI replies to certain customers or brands","href":"/start-here/playbooks/prevent-ai-replies-to-certain-customers-or-brands"},{"title":"Improve a specific AI response","href":"/start-here/playbooks/improve-a-specific-ai-response"},{"title":"See what the AI agent did to a ticket","href":"/start-here/playbooks/see-what-the-ai-agent-did-to-a-ticket"},{"title":"Change ticket status or assignment after an AI action","href":"/start-here/playbooks/change-ticket-status-or-assignment-after-an-ai-action"},{"title":"Auto-close or archive AI-handled tickets","href":"/start-here/playbooks/auto-close-or-archive-ai-handled-tickets"},{"title":"Set up AI agents for multiple brands","href":"/start-here/playbooks/set-up-ai-agents-for-multiple-brands"}]},{"group":"Add your AI agent to your website","hidden":true,"pages":[{"title":"Add your AI agent to your website","href":"/start-here/add-your-ai-agent-to-your-website"},{"title":"WordPress","href":"/start-here/add-your-ai-agent-to-your-website/wordpress"},{"title":"Shopify","href":"/start-here/add-your-ai-agent-to-your-website/shopify"},{"title":"Zendesk","href":"/start-here/add-your-ai-agent-to-your-website/zendesk"}]},{"title":"Full product demo","href":"/start-here/full-product-demo"},{"title":"Video tutorials","href":"/start-here/video-tutorials"},{"title":"Reviews","href":"/start-here/reviews"},{"title":"Support","href":"/start-here/support"}]},{"group":"Features","pages":[{"title":"AI answers on your content","href":"/features/ai-answers-on-your-content"},{"title":"Human escalation","href":"/features/human-escalation"},{"title":"Escalation data collection","href":"/features/escalation-data-collection"},{"title":"Testing","href":"/features/testing"},{"group":"Channels","pages":[{"title":"Channels","href":"/features/channels"},{"title":"Zapier","href":"/features/channels/zapier"},{"group":"Zendesk","pages":[{"title":"Zendesk","href":"/features/channels/zendesk"},{"title":"Zendesk (Messaging)","href":"/features/channels/zendesk/zendesk-messaging"},{"title":"Zendesk (Tickets)","href":"/features/channels/zendesk/zendesk-tickets"},{"title":"Zendesk (Tagging)","href":"/features/channels/zendesk/zendesk-tagging"},{"title":"Zendesk Playbooks","href":"/features/channels/zendesk/zendesk-playbooks"}]},{"group":"Intercom","pages":[{"title":"Intercom","href":"/features/channels/intercom"},{"title":"Intercom (Tagging)","href":"/features/channels/intercom/intercom-tagging"},{"title":"Intercom (Live Translation)","href":"/features/channels/intercom/intercom-live-translation"},{"title":"Intercom Playbooks","href":"/features/channels/intercom/intercom-playbooks"},{"title":"Human Escalation Workflows","href":"/features/channels/intercom/human-escalation-workflows"}]},{"group":"Freshchat","pages":[{"title":"Freshchat","href":"/features/channels/freshchat"},{"title":"Freshchat (Tagging)","href":"/features/channels/freshchat/freshchat-tagging"}]},{"group":"Freshdesk","pages":[{"title":"Freshdesk","href":"/features/channels/freshdesk"},{"title":"Freshdesk (Tagging)","href":"/features/channels/freshdesk/freshdesk-tagging"}]},{"group":"Gorgias","pages":[{"title":"Gorgias","href":"/features/channels/gorgias"},{"title":"Gorgias (Tagging)","href":"/features/channels/gorgias/tagging"}]},{"group":"HubSpot","pages":[{"title":"HubSpot","href":"/features/channels/hubspot"},{"title":"HubSpot Playbooks","href":"/features/channels/hubspot/hubspot-playbooks"}]},{"title":"Chrome Extension","href":"/features/channels/chrome-extension"},{"title":"Zoho (SalesIQ)","href":"/features/channels/zoho-salesiq"},{"title":"Live Chat Channels Feature Comparison","href":"/features/channels/live-chat-channels-feature-comparison"},{"title":"Microsoft Teams","href":"/features/channels/microsoft-teams"},{"title":"Slack","href":"/features/channels/slack"}]},{"group":"Connections","pages":[{"title":"Connections","href":"/features/connections"},{"title":"Authorizations","href":"/features/connections/authorizations"}]},{"title":"Shopify","href":"/features/shopify"},{"title":"Connecting to Internal Systems via APIs","href":"/features/connecting-to-internal-systems-via-apis"},{"group":"User Data API","pages":[{"title":"User Data API","href":"/features/user-data-api"},{"title":"User Data API setup","href":"/features/user-data-api/user-data-api-setup"}]},{"title":"AI Actions (Tools)","href":"/features/ai-actions-tools"},{"group":"Tasks","pages":[{"title":"Tasks","href":"/features/tasks"},{"title":"Task Use Cases","href":"/features/tasks/task-use-cases"},{"title":"Task End-to-End Examples","href":"/features/tasks/task-end-to-end-examples"}]},{"title":"Self-learning","href":"/features/self-learning"},{"group":"Improve","pages":[{"title":"Improve","href":"/features/improve"},{"title":"Knowledge Gaps","hidden":true,"href":"/features/improve/knowledge-gaps"},{"title":"Guidance","href":"/features/improve/guidance"},{"title":"Custom Answers","href":"/features/improve/custom-answers"},{"title":"Test","href":"/features/improve/test"},{"title":"Content Usage","hidden":true,"href":"/features/improve/content-usage"},{"title":"Inspect \u0026 Logs","href":"/features/improve/inspect-and-logs"}]},{"title":"Image reading","href":"/features/image-reading"},{"title":"Echo agent","href":"/features/echo-agent"},{"title":"Multibrand","href":"/features/multibrand"},{"title":"Private (Internal) mode","href":"/features/private-internal-mode"},{"title":"File uploads","href":"/features/file-uploads"},{"title":"Adding \u0026 syncing your website content","href":"/features/adding-and-syncing-your-website-content"},{"title":"Training on historic tickets","href":"/features/training-on-historic-tickets"},{"group":"Insights","pages":[{"title":"Insights","href":"/features/insights"},{"title":"Conversation insight notifications","href":"/features/insights/conversation-insight-notifications"}]},{"title":"Team access","href":"/features/team-access"},{"title":"Spam filters","href":"/features/spam-filters"},{"title":"Email assistant","hidden":true,"href":"/features/email-assistant"},{"title":"Lead (Email) Capture","hidden":true,"href":"/features/lead-email-capture"},{"title":"Customization","hidden":true,"href":"/features/customization"},{"title":"Site search","hidden":true,"href":"/features/site-search"},{"title":"Conversation ratings (CSAT)","hidden":true,"href":"/features/conversation-ratings-csat"},{"title":"Languages and Localization","href":"/features/languages-and-localization"},{"title":"Starter actions","hidden":true,"href":"/features/starter-actions"},{"title":"Remove branding","href":"/features/remove-branding"}]},{"group":"Security + Privacy","pages":[{"group":"Security","pages":[{"title":"Security","href":"/security-+-privacy/security"},{"title":"SOC-2","href":"/security-+-privacy/security/soc-2"}]},{"group":"Privacy","pages":[{"title":"Privacy","href":"/security-+-privacy/privacy"},{"title":"Your content","href":"/security-+-privacy/privacy/your-content"},{"title":"Your data","href":"/security-+-privacy/privacy/your-data"},{"title":"OpenAI","href":"/security-+-privacy/privacy/openai"},{"group":"Regulations","pages":[{"title":"Regulations","href":"/security-+-privacy/privacy/regulations"},{"title":"GDPR compliance","href":"/security-+-privacy/privacy/regulations/gdpr-compliance"},{"title":"HIPAA","href":"/security-+-privacy/privacy/regulations/hipaa"}]}]}]},{"group":"Account Management","pages":[{"title":"Pricing + plans","href":"/account-management/pricing-+-plans"},{"group":"Limits","pages":[{"title":"Limits","href":"/account-management/limits"},{"title":"Exceeding limits","href":"/account-management/limits/exceeding-limits"},{"title":"Conversations","href":"/account-management/limits/conversations"}]},{"group":"Your profile","pages":[{"title":"Your profile","href":"/account-management/your-profile"},{"title":"Changing your email","href":"/account-management/your-profile/changing-your-email"},{"title":"Close your account","href":"/account-management/your-profile/close-your-account"}]},{"group":"Billing","pages":[{"title":"Billing","href":"/account-management/billing"},{"title":"Change plan","href":"/account-management/billing/change-plan"},{"title":"Update payment card","href":"/account-management/billing/update-payment-card"},{"title":"Download an invoice","href":"/account-management/billing/download-an-invoice"},{"title":"Discounts","href":"/account-management/billing/discounts"},{"title":"Refunds","href":"/account-management/billing/refunds"},{"title":"Usage costs","href":"/account-management/billing/usage-costs"},{"title":"Tax","href":"/account-management/billing/tax"},{"title":"Cancel subscription","href":"/account-management/billing/cancel-subscription"}]},{"group":"User access","pages":[{"title":"User access","href":"/account-management/user-access"},{"title":"Setting a Password for Your Account","href":"/account-management/user-access/setting-a-password-for-your-account"},{"title":"Do you have 2FA or MFA to login to My AskAI?","href":"/account-management/user-access/do-you-have-2fa-or-mfa-to-login-to-my-askai"},{"title":"Reset login password","href":"/account-management/user-access/reset-login-password"}]},{"title":"Affiliate program","href":"/account-management/affiliate-program"},{"title":"Reselling + Whitelabelling","href":"/account-management/reselling-+-whitelabelling"}]},{"group":"Troubleshooting","pages":[{"title":"How to debug an AI answer","href":"/troubleshooting/how-to-debug-an-ai-answer"},{"title":"Slow responses","href":"/troubleshooting/slow-responses"},{"title":"Chat bubble not visible","hidden":true,"href":"/troubleshooting/chat-bubble-not-visible"},{"title":"Why can't it answer?","href":"/troubleshooting/why-cant-it-answer"},{"title":"Login","href":"/troubleshooting/login"},{"title":"Website not added","href":"/troubleshooting/website-not-added"},{"title":"Issue connecting your live chat widget","hidden":true,"href":"/troubleshooting/issue-connecting-your-live-chat-widget"},{"title":"Oops there has been an error","href":"/troubleshooting/oops-there-has-been-an-error"},{"title":"I can't see any billing information for my account?","href":"/troubleshooting/i-cant-see-any-billing-information-for-my-account"}]},{"group":"FAQ","pages":[{"group":"General","pages":[{"title":"General","href":"/faq/general"},{"title":"How do I make the AI agent more \"human\"?","href":"/faq/general/how-do-i-make-the-ai-agent-more-human"},{"title":"How can I test my AI agent without it responding to customers?","href":"/faq/general/how-can-i-test-my-ai-agent-without-it-responding-to-customers"},{"title":"Can I use the AI agent within a mobile app?","href":"/faq/general/can-i-use-the-ai-agent-within-a-mobile-app"},{"title":"Can I add macros, canned or stock responses to my AI agent?","href":"/faq/general/can-i-add-macros-canned-or-stock-responses-to-my-ai-agent"},{"title":"Can I have multiple AI agents, multiple brands or multiple knowledge bases?","href":"/faq/general/can-i-have-multiple-ai-agents-multiple-brands-or-multiple-knowledge-bases"},{"title":"Can I route tickets to different agents?","href":"/faq/general/can-i-route-tickets-to-different-agents"},{"title":"Can I give my agent a personality, adjust the tone or customize the prompt?","href":"/faq/general/can-i-give-my-agent-a-personality-adjust-the-tone-or-customize-the-prompt"},{"title":"Does it get smarter the more conversations it has?","href":"/faq/general/does-it-get-smarter-the-more-conversations-it-has"},{"title":"What are your social accounts?","href":"/faq/general/what-are-your-social-accounts"},{"title":"What is the difference between My AskAI and My AskAI Classic?","href":"/faq/general/what-is-the-difference-between-my-askai-and-my-askai-classic"},{"title":"Will it answer questions about competitors' products?","href":"/faq/general/will-it-answer-questions-about-competitors-products"},{"title":"What if it can't answer?","href":"/faq/general/what-if-it-cant-answer"},{"title":"Will it make things up?","href":"/faq/general/will-it-make-things-up"},{"title":"Feedback, feature requests and suggestions","href":"/faq/general/feedback-feature-requests-and-suggestions"},{"title":"Answer streaming","href":"/faq/general/answer-streaming"},{"title":"Temperature","href":"/faq/general/temperature"},{"title":"My AskAI vs Fine-tuning","href":"/faq/general/my-askai-vs-fine-tuning"},{"title":"My AskAI vs ChatGPT","href":"/faq/general/my-askai-vs-chatgpt"},{"title":"How can I test the accuracy of my AI agent's answers?","href":"/faq/general/how-can-i-test-the-accuracy-of-my-ai-agents-answers"},{"title":"(Large Language Models) LLMs","href":"/faq/general/large-language-models-llms"},{"title":"Can I use my own OpenAI assistant or Custom GPT?","href":"/faq/general/can-i-use-my-own-openai-assistant-or-custom-gpt"},{"title":"Do you offer a SLA or uptime guarantee?","href":"/faq/general/do-you-offer-a-sla-or-uptime-guarantee"},{"title":"Do you have any rate limits for conversations for your AI agent?","href":"/faq/general/do-you-have-any-rate-limits-for-conversations-for-your-ai-agent"},{"title":"Does the AI agent use the ticket or conversation history when responding?","href":"/faq/general/does-the-ai-agent-use-the-ticket-or-conversation-history-when-responding"},{"title":"How do you manage spam tickets, chats or conversations?","href":"/faq/general/how-do-you-manage-spam-tickets-chats-or-conversations"},{"title":"How does it work?","hidden":true,"href":"/faq/general/how-does-it-work"}]}]},{"group":"API Documentation","pages":[{"title":"API Docs Introduction","href":"/api-documentation/api-docs-introduction"},{"title":"Query API","description":"Use the Query API to create an integratation with your AI agent.","openapi":"api-documentation/query-2.yaml POST /ask-ai-query","href":"/api-documentation/query-api"},{"title":"Chat API","openapi":"api-documentation/chat.yaml POST /ask-ai-chat","href":"/api-documentation/chat-api"},{"title":"User Data API","description":null,"href":"/api-documentation/user-data-api"}]}]},"title":"Chat API - My AskAI","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}