Use the ClaudIA API to integrate with projects, agents, knowledge bases, and content.
Explore the ClaudIA API
Browse the available endpoints and open them in the API playground.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cloud Chat","colors":{"primary":"#EF7221","light":"#FF9D5C","dark":"#D65E10"},"logo":{"light":"https://mintcdn.com/cloud-humans/GHbxWTY81Qa4762I/logo/light.svg?fit=max\u0026auto=format\u0026n=GHbxWTY81Qa4762I\u0026q=85\u0026s=2899d32cd5c5f8adff5bb4390125f626","dark":"https://mintcdn.com/cloud-humans/GHbxWTY81Qa4762I/logo/dark.svg?fit=max\u0026auto=format\u0026n=GHbxWTY81Qa4762I\u0026q=85\u0026s=95d8350f3dade95801b6c310d5ba597f"},"favicon":"https://mintcdn.com/cloud-humans/T7XxBi09ex74abIC/favicon.svg?fit=max\u0026auto=format\u0026n=T7XxBi09ex74abIC\u0026q=85\u0026s=6b1379d1ea0f266d6ca12eb1f8ccbf77","fonts":{"family":"Inter"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cloud-humans","hasAudioNarration":false,"actualSubdomain":"cloud-humans","customDomains":["docs.cloudhumans.com"],"gitSource":{"type":"github","owner":"cloudhumans","repo":"dev-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aff212b5735af7f41d07425","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"API Reference","count":190},{"language":"default","tag":"Cloud Chat","count":129},{"language":"default","tag":"Claudia","count":66},{"language":"default","tag":"Guides","count":32},{"language":"default","tag":"Data Export","count":27},{"language":"default","tag":"Table Catalog","count":19},{"language":"default","tag":"Agents","count":18},{"language":"default","tag":"Help Center","count":15},{"language":"default","tag":"Conversations","count":14},{"language":"default","tag":"Controlled Flows","count":14}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"integrations/claudia-api","slug":"/integrations/claudia-api","pageMetadata":{"title":"ClaudIA API","description":"Build integrations with the ClaudIA API.","href":"/integrations/claudia-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: \"Build integrations with the ClaudIA API.\"\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`,..._provideComponents(),...props.components},{Card}=_components;if(!Card)_missingMdxReference(`Card`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Use the ClaudIA API to integrate with projects, agents, knowledge bases, and content.`}),`\n`,_jsx(Card,{title:`Explore the ClaudIA API`,icon:`robot`,href:`/api-reference/claudia`,children:_jsx(_components.p,{children:`Browse the available endpoints and open them in the API playground.`})})]})}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":"ClaudIA API","description":"Build integrations with the ClaudIA API.","href":"/integrations/claudia-api"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"cloud-humans","siteName":"Cloud Chat","title":"ClaudIA API - Cloud Chat","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-20T18:59:01.579Z","originalFileLocation":"integrations/claudia-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=\"description\" content=\"Build integrations with the ClaudIA API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cloud Chat\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_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/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_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/cloud-humans/Tjh_1uQRibuZjdTW/_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/cloud-humans/Tjh_1uQRibuZjdTW/_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/cloud-humans/Tjh_1uQRibuZjdTW/_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/cloud-humans/Tjh_1uQRibuZjdTW/_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/cloud-humans/Tjh_1uQRibuZjdTW/_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/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"ClaudIA API - Cloud Chat\">\u003cmeta data-mint-head property=\"og:description\" content=\"Build integrations with the ClaudIA API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cloud Chat\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cloudhumans.com/integrations/claudia-api\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cloud-humans.mintlify.site/_mintlify/api/og/v2?division=Integrations\u0026amp;title=ClaudIA+API\u0026amp;description=Build+integrations+with+the+ClaudIA+API.\u0026amp;theme=f1ab87c694400f10daae88f8\u0026amp;signature=9c562778c5279cafa56384c4a058ca149e212c589240e995fc736498d17ef6b3\">\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=\"ClaudIA API - Cloud Chat\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Build integrations with the ClaudIA API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cloud-humans.mintlify.site/_mintlify/api/og/v2?division=Integrations\u0026amp;title=ClaudIA+API\u0026amp;description=Build+integrations+with+the+ClaudIA+API.\u0026amp;theme=f1ab87c694400f10daae88f8\u0026amp;signature=9c562778c5279cafa56384c4a058ca149e212c589240e995fc736498d17ef6b3\">\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/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cloud Chat\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#EF7221\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cloudhumans.com/integrations/claudia-api\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/integrations/claudia-api.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cloudhumans.com/#organization\",\"name\":\"Cloud Chat\",\"url\":\"https://docs.cloudhumans.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cloud-humans/GHbxWTY81Qa4762I/logo/light.svg?fit=max\u0026auto=format\u0026n=GHbxWTY81Qa4762I\u0026q=85\u0026s=2899d32cd5c5f8adff5bb4390125f626\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cloudhumans.com#website\",\"name\":\"Cloud Chat\",\"url\":\"https://docs.cloudhumans.com\",\"publisher\":{\"@id\":\"https://docs.cloudhumans.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cloudhumans.com/integrations/claudia-api#webpage\",\"url\":\"https://docs.cloudhumans.com/integrations/claudia-api\",\"name\":\"ClaudIA API\",\"description\":\"Build integrations with the ClaudIA API.\",\"dateModified\":\"2026-08-20T18:59:01.579Z\",\"isPartOf\":{\"@id\":\"https://docs.cloudhumans.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cloudhumans.com/integrations/claudia-api#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cloudhumans.com/integrations/claudia-api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Integrations\",\"item\":\"https://docs.cloudhumans.com/mcp/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"ClaudIA API\",\"item\":\"https://docs.cloudhumans.com/integrations/claudia-api\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.cloudhumans.com/integrations/claudia-api#article\",\"headline\":\"ClaudIA API\",\"name\":\"ClaudIA API\",\"description\":\"Build integrations with the ClaudIA API.\",\"url\":\"https://docs.cloudhumans.com/integrations/claudia-api\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cloudhumans.com/integrations/claudia-api#webpage\"},\"dateModified\":\"2026-08-20T18:59:01.579Z\",\"publisher\":{\"@id\":\"https://docs.cloudhumans.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cloudhumans.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cloud Chat\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Cloud Chat\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/integrations/claudia-api.md","siteName":"Cloud Chat","nav":{"global":null,"tabs":[{"tab":"Guides","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":""}]},{"group":"Integrations","pages":[{"title":"MCP Server","href":"/mcp/overview"},{"title":"Cloud Chat API","description":"Build integrations with the Cloud Chat API.","href":"/integrations/cloud-chat-api"},{"title":"ClaudIA API","href":"/integrations/claudia-api"},{"title":"Controlled Flows API","description":"Build integrations with the Controlled Flows API.","href":"/integrations/controlled-flows-api"}]},{"group":"Data Export","pages":[{"title":"Overview and access","href":"/data-export/overview"},{"title":"Access from Google Cloud","href":"/data-export/google-cloud-access"},{"title":"Hourly delivery in v2 (from Nov 3, 2026)","sidebarTitle":"Hourly delivery in v2","href":"/data-export/hourly-delivery"},{"title":"Bucket layout","href":"/data-export/bucket-layout"},{"title":"Downloading files","href":"/data-export/downloading"},{"title":"Storage classes and restoring archived data","href":"/data-export/storage-classes"},{"title":"Performance and best practices","href":"/data-export/performance"},{"title":"Troubleshooting","href":"/data-export/troubleshooting"},{"group":"Table Catalog","root":{"title":"Table catalog","href":"/data-export/catalog/overview"},"pages":[{"group":"Claudia","expanded":false,"pages":[{"title":"claudia_conversation","sidebarTitle":"claudia_conversation","href":"/data-export/catalog/claudia/claudia_conversation"},{"title":"claudia_messages","sidebarTitle":"claudia_messages","href":"/data-export/catalog/claudia/claudia_messages"},{"title":"claudia_contents","sidebarTitle":"claudia_contents","href":"/data-export/catalog/claudia/claudia_contents"},{"title":"claudia_conversation_feedback","sidebarTitle":"claudia_conversation_feedback","href":"/data-export/catalog/claudia/claudia_conversation_feedback"},{"title":"claudia_csat","sidebarTitle":"claudia_csat","href":"/data-export/catalog/claudia/claudia_csat"},{"title":"claudia_prompt_revision","sidebarTitle":"claudia_prompt_revision","href":"/data-export/catalog/claudia/claudia_prompt_revision"},{"title":"eddie_result_outcomes","sidebarTitle":"eddie_result_outcomes","href":"/data-export/catalog/claudia/eddie_result_outcomes"}]},{"group":"Cloud Chat","expanded":false,"pages":[{"title":"cloud_chat_conversations","sidebarTitle":"cloud_chat_conversations","href":"/data-export/catalog/cloud-chat/cloud_chat_conversations"},{"title":"cloud_chat_messages","sidebarTitle":"cloud_chat_messages","href":"/data-export/catalog/cloud-chat/cloud_chat_messages"},{"title":"cloud_chat_conversations_tags","sidebarTitle":"cloud_chat_conversations_tags","href":"/data-export/catalog/cloud-chat/cloud_chat_conversations_tags"},{"title":"cloud_chat_conversations_custom_fields","sidebarTitle":"cloud_chat_conversations_custom_fields","href":"/data-export/catalog/cloud-chat/cloud_chat_conversations_custom_fields"},{"title":"cloud_chat_conversations_first_reply_metrics","sidebarTitle":"cloud_chat_conversations_first_reply_metrics","href":"/data-export/catalog/cloud-chat/cloud_chat_conversations_first_reply_metrics"},{"title":"cloud_chat_contacts","sidebarTitle":"cloud_chat_contacts","href":"/data-export/catalog/cloud-chat/cloud_chat_contacts"},{"title":"cloud_chat_csat","sidebarTitle":"cloud_chat_csat","href":"/data-export/catalog/cloud-chat/cloud_chat_csat"},{"title":"cloud_chat_tags","sidebarTitle":"cloud_chat_tags","href":"/data-export/catalog/cloud-chat/cloud_chat_tags"},{"title":"cloud_chat_outbound_events","sidebarTitle":"cloud_chat_outbound_events","href":"/data-export/catalog/cloud-chat/cloud_chat_outbound_events"},{"title":"cloud_chat_agent_metrics","sidebarTitle":"cloud_chat_agent_metrics","href":"/data-export/catalog/cloud-chat/cloud_chat_agent_metrics"},{"title":"cloud_chat_team_metrics","sidebarTitle":"cloud_chat_team_metrics","href":"/data-export/catalog/cloud-chat/cloud_chat_team_metrics"},{"title":"cloud_chat_account_user_availability_histories","sidebarTitle":"cloud_chat_account_user_availability_histories","href":"/data-export/catalog/cloud-chat/cloud_chat_account_user_availability_histories"}]}]}]}]},{"tab":"API Reference","products":[{"product":"Cloud Chat","icon":"messages","groups":[{"group":"Getting Started","pages":[{"title":"Cloud Chat API","href":"/api-reference/cloudchat/overview"},{"title":"Find your credentials","href":"/api-reference/cloudchat/credentials"}]},{"group":"Authentication","pages":[{"title":"Sign in and get a token","deprecated":null,"version":null,"openapi":"/api-reference/specs/auth/v1.json post /v1/signin","href":"/api-reference/cloudchat/v1/auth/authentication/sign-in-and-get-a-token"},{"title":"Answer a sign-in challenge","deprecated":null,"version":null,"openapi":"/api-reference/specs/auth/v1.json post /v1/signin/challenge","href":"/api-reference/cloudchat/v1/auth/authentication/answer-a-sign-in-challenge"}]},{"group":"Canned Responses","pages":[{"title":"List canned responses","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/canned-responses","href":"/api-reference/cloudchat/endpoints/list-canned-responses"},{"title":"Get a canned response","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/canned-responses/{cannedResponseId}","href":"/api-reference/cloudchat/endpoints/get-a-canned-response"},{"title":"Create a canned response","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/canned-responses","href":"/api-reference/cloudchat/endpoints/create-a-canned-response"},{"title":"Update a canned response","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/canned-responses/{cannedResponseId}","href":"/api-reference/cloudchat/endpoints/update-a-canned-response"},{"title":"Delete a canned response","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/canned-responses/{cannedResponseId}","href":"/api-reference/cloudchat/endpoints/delete-a-canned-response"}]},{"group":"Conversations","pages":[{"title":"List conversations","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/conversations","href":"/api-reference/cloudchat/endpoints/list-conversations"},{"title":"Find a conversation by any identifier","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/conversations/find","href":"/api-reference/cloudchat/endpoints/find-a-conversation"},{"title":"Get a conversation","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/conversations/{conversationId}","href":"/api-reference/cloudchat/endpoints/get-a-conversation"},{"title":"List conversation messages","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/conversations/{conversationId}/messages","href":"/api-reference/cloudchat/endpoints/list-conversation-messages"},{"title":"List CSAT answers","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/csat-responses","href":"/api-reference/cloudchat/endpoints/list-csat-answers"},{"title":"Open a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations","href":"/api-reference/cloudchat/endpoints/open-a-conversation"},{"title":"Update a conversation","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/conversations/{conversationId}","href":"/api-reference/cloudchat/endpoints/update-a-conversation"},{"title":"Change the status of a conversation","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/conversations/{conversationId}/status","href":"/api-reference/cloudchat/endpoints/change-conversation-status"},{"title":"Assign a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations/{conversationId}/assignments","href":"/api-reference/cloudchat/endpoints/assign-a-conversation"},{"title":"Add an internal note to a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations/{conversationId}/notes","href":"/api-reference/cloudchat/endpoints/add-a-conversation-note"},{"title":"Block the contact of a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations/{conversationId}/mute","href":"/api-reference/cloudchat/endpoints/block-the-contact-of-a-conversation"},{"title":"Unblock the contact of a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations/{conversationId}/unmute","href":"/api-reference/cloudchat/endpoints/unblock-the-contact-of-a-conversation"}]},{"group":"Contacts","pages":[{"title":"List contacts","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/contacts","href":"/api-reference/cloudchat/endpoints/list-contacts"},{"title":"Search contacts","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/contacts/search","href":"/api-reference/cloudchat/endpoints/search-contacts"},{"title":"Get a contact","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/contacts/{contactId}","href":"/api-reference/cloudchat/endpoints/get-a-contact"},{"title":"Create a contact","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/contacts","href":"/api-reference/cloudchat/endpoints/create-a-contact"},{"title":"Update a contact","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/contacts/{contactId}","href":"/api-reference/cloudchat/endpoints/update-a-contact"}]},{"group":"Companies","pages":[{"title":"List companies","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/companies","href":"/api-reference/cloudchat/endpoints/list-companies"},{"title":"Get a company","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/companies/{companyId}","href":"/api-reference/cloudchat/endpoints/get-a-company"},{"title":"Update a company","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/companies/{companyId}","href":"/api-reference/cloudchat/endpoints/update-a-company"},{"title":"List a contact's companies","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/contacts/{contactId}/companies","href":"/api-reference/cloudchat/endpoints/list-contact-companies"},{"title":"Link a contact to a company","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/contacts/{contactId}/companies","href":"/api-reference/cloudchat/endpoints/link-a-contact-to-a-company"},{"title":"Unlink a contact from a company","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/contacts/{contactId}/companies/{companyId}","href":"/api-reference/cloudchat/endpoints/unlink-a-contact-from-a-company"}]},{"group":"Labels","pages":[{"title":"List labels","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/labels","href":"/api-reference/cloudchat/endpoints/list-labels"},{"title":"Get a label","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/labels/{labelId}","href":"/api-reference/cloudchat/endpoints/get-a-label"},{"title":"Create a label","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/labels","href":"/api-reference/cloudchat/endpoints/create-a-label"},{"title":"Update a label","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/labels/{labelId}","href":"/api-reference/cloudchat/endpoints/update-a-label"},{"title":"Add labels to a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations/{conversationId}/labels","href":"/api-reference/cloudchat/endpoints/add-labels-to-a-conversation"},{"title":"Remove labels from a conversation","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/conversations/{conversationId}/labels","href":"/api-reference/cloudchat/endpoints/remove-labels-from-a-conversation"},{"title":"List the labels of a contact","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/contacts/{contactId}/labels","href":"/api-reference/cloudchat/endpoints/list-contact-labels"},{"title":"Add labels to a contact","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/contacts/{contactId}/labels","href":"/api-reference/cloudchat/endpoints/add-labels-to-a-contact"},{"title":"Remove labels from a contact","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/contacts/{contactId}/labels","href":"/api-reference/cloudchat/endpoints/remove-labels-from-a-contact"}]},{"group":"Inboxes","pages":[{"title":"List inboxes","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/inboxes","href":"/api-reference/cloudchat/endpoints/list-inboxes"},{"title":"Get an inbox","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/inboxes/{inboxId}","href":"/api-reference/cloudchat/endpoints/get-an-inbox"},{"title":"Update an inbox's settings","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/inboxes/{inboxId}","href":"/api-reference/cloudchat/endpoints/update-an-inbox"},{"title":"List inbox members","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/inboxes/{inboxId}/members","href":"/api-reference/cloudchat/endpoints/list-inbox-members"},{"title":"Add inbox members","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/inboxes/{inboxId}/members","href":"/api-reference/cloudchat/endpoints/add-inbox-members"},{"title":"Remove inbox members","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/inboxes/{inboxId}/members","href":"/api-reference/cloudchat/endpoints/remove-inbox-members"},{"title":"Get the satisfaction survey of an inbox","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/inboxes/{inboxId}/csat-survey","href":"/api-reference/cloudchat/endpoints/get-the-satisfaction-survey-of-an-inbox"},{"title":"Update the satisfaction survey of an inbox","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/inboxes/{inboxId}/csat-survey","href":"/api-reference/cloudchat/endpoints/update-the-satisfaction-survey-of-an-inbox"}]},{"group":"Campaigns","pages":[{"title":"Preview campaign recipients","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/campaigns/preview-recipients","href":"/api-reference/cloudchat/endpoints/preview-campaign-recipients"},{"title":"Create a campaign","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/campaigns","href":"/api-reference/cloudchat/endpoints/create-a-campaign"},{"title":"Get a campaign","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/campaigns/{campaignId}","href":"/api-reference/cloudchat/endpoints/get-a-campaign"},{"title":"List campaign variables","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/campaigns/variables","href":"/api-reference/cloudchat/endpoints/list-campaign-variables"},{"title":"List message templates","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/inboxes/{inboxId}/message-templates","href":"/api-reference/cloudchat/endpoints/list-message-templates"},{"title":"Create a message template","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/inboxes/{inboxId}/message-templates","href":"/api-reference/cloudchat/endpoints/create-a-message-template"},{"title":"Update a message template","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/inboxes/{inboxId}/message-templates/{name}","href":"/api-reference/cloudchat/endpoints/update-a-message-template"}]},{"group":"Reports","pages":[{"title":"List reports","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/reports","href":"/api-reference/cloudchat/endpoints/list-reports"},{"title":"Get a report","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/reports/{reportKey}","href":"/api-reference/cloudchat/endpoints/get-a-report"},{"title":"List report query fields","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/report-queries/fields","href":"/api-reference/cloudchat/endpoints/list-report-query-fields"},{"title":"Run a report query","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/report-queries","href":"/api-reference/cloudchat/endpoints/run-a-report-query"}]},{"group":"Agents","pages":[{"title":"List agents","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/agents","href":"/api-reference/cloudchat/endpoints/list-agents"},{"title":"Get an agent","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/agents/{agentId}","href":"/api-reference/cloudchat/endpoints/get-an-agent"},{"title":"Create an agent","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/agents","href":"/api-reference/cloudchat/endpoints/create-an-agent"},{"title":"Update an agent","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/agents/{agentId}","href":"/api-reference/cloudchat/endpoints/update-an-agent"},{"title":"Get agent access","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/agents/{agentId}/access","href":"/api-reference/cloudchat/endpoints/get-agent-access"},{"title":"Set agent access","openapi":"api-reference/specs/cloudchat/v1.json PUT /v1/accounts/{accountId}/agents/{agentId}/access","href":"/api-reference/cloudchat/endpoints/set-agent-access"}]},{"group":"Teams","pages":[{"title":"List teams","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/teams","href":"/api-reference/cloudchat/endpoints/list-teams"},{"title":"Get a team","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/teams/{teamId}","href":"/api-reference/cloudchat/endpoints/get-a-team"},{"title":"Create a team","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/teams","href":"/api-reference/cloudchat/endpoints/create-a-team"},{"title":"Update a team","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/teams/{teamId}","href":"/api-reference/cloudchat/endpoints/update-a-team"},{"title":"List team members","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/teams/{teamId}/members","href":"/api-reference/cloudchat/endpoints/list-team-members"},{"title":"Add team members","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/teams/{teamId}/members","href":"/api-reference/cloudchat/endpoints/add-team-members"},{"title":"Remove team members","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/teams/{teamId}/members","href":"/api-reference/cloudchat/endpoints/remove-team-members"}]},{"group":"Macros","pages":[{"title":"List macros","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/macros","href":"/api-reference/cloudchat/endpoints/list-macros"},{"title":"Get a macro","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/macros/{macroId}","href":"/api-reference/cloudchat/endpoints/get-a-macro"},{"title":"Create a macro","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/macros","href":"/api-reference/cloudchat/endpoints/create-a-macro"},{"title":"Update a macro","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/macros/{macroId}","href":"/api-reference/cloudchat/endpoints/update-a-macro"}]},{"group":"Custom Views","pages":[{"title":"List custom views","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/custom-views","href":"/api-reference/cloudchat/endpoints/list-custom-views"},{"title":"Get a custom view","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/custom-views/{customViewId}","href":"/api-reference/cloudchat/endpoints/get-a-custom-view"},{"title":"Create a custom view","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/custom-views","href":"/api-reference/cloudchat/endpoints/create-a-custom-view"},{"title":"Update a custom view","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/custom-views/{customViewId}","href":"/api-reference/cloudchat/endpoints/update-a-custom-view"},{"title":"Delete a custom view","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/custom-views/{customViewId}","href":"/api-reference/cloudchat/endpoints/delete-a-custom-view"}]},{"group":"Automation Rules","pages":[{"title":"List automation rules","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/automation-rules","href":"/api-reference/cloudchat/endpoints/list-automation-rules"},{"title":"Get an automation rule","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/automation-rules/{automationRuleId}","href":"/api-reference/cloudchat/endpoints/get-an-automation-rule"},{"title":"Propose an automation rule","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/automation-rules/propose-create","href":"/api-reference/cloudchat/endpoints/propose-an-automation-rule"},{"title":"Confirm an automation rule","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/automation-rules/confirm-create","href":"/api-reference/cloudchat/endpoints/confirm-an-automation-rule"},{"title":"Propose automation rule edits","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/automation-rules/{automationRuleId}/propose-edits","href":"/api-reference/cloudchat/endpoints/propose-automation-rule-edits"},{"title":"Confirm automation rule edits","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/automation-rules/{automationRuleId}/confirm-edits","href":"/api-reference/cloudchat/endpoints/confirm-automation-rule-edits"},{"title":"Propose a new rule order","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/automation-rules/propose-reorder","href":"/api-reference/cloudchat/endpoints/propose-a-new-rule-order"},{"title":"Confirm a new rule order","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/automation-rules/confirm-reorder","href":"/api-reference/cloudchat/endpoints/confirm-a-new-rule-order"}]},{"group":"Availability Reasons","pages":[{"title":"List availability reasons","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/availability-reasons","href":"/api-reference/cloudchat/endpoints/list-availability-reasons"},{"title":"Create an availability reason","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/availability-reasons","href":"/api-reference/cloudchat/endpoints/create-an-availability-reason"},{"title":"Update an availability reason","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/availability-reasons/{availabilityReasonId}","href":"/api-reference/cloudchat/endpoints/update-an-availability-reason"},{"title":"Delete an availability reason","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/availability-reasons/{availabilityReasonId}","href":"/api-reference/cloudchat/endpoints/delete-an-availability-reason"}]},{"group":"Native Attribute Requirements","pages":[{"title":"List native attribute requirements","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/native-attribute-requirements","href":"/api-reference/cloudchat/endpoints/list-native-attribute-requirements"},{"title":"Require a native attribute","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/native-attribute-requirements","href":"/api-reference/cloudchat/endpoints/create-a-native-attribute-requirement"},{"title":"Stop requiring a native attribute","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/native-attribute-requirements/{nativeAttributeRequirementId}","href":"/api-reference/cloudchat/endpoints/delete-a-native-attribute-requirement"}]},{"group":"Custom Attributes","pages":[{"title":"List custom attributes","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/custom-attributes","href":"/api-reference/cloudchat/endpoints/list-custom-attributes"},{"title":"Get a custom attribute","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/custom-attributes/{customAttributeId}","href":"/api-reference/cloudchat/endpoints/get-a-custom-attribute"},{"title":"Create a custom attribute","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/custom-attributes","href":"/api-reference/cloudchat/endpoints/create-a-custom-attribute"},{"title":"Update a custom attribute","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/custom-attributes/{customAttributeId}","href":"/api-reference/cloudchat/endpoints/update-a-custom-attribute"}]},{"group":"Help Center","pages":[{"title":"List portals","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals","href":"/api-reference/cloudchat/endpoints/list-portals"},{"title":"Get a portal","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals/{portalSlug}","href":"/api-reference/cloudchat/endpoints/get-a-portal"},{"title":"Create a portal","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/portals","href":"/api-reference/cloudchat/endpoints/create-a-portal"},{"title":"Update a portal","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/portals/{portalSlug}","href":"/api-reference/cloudchat/endpoints/update-a-portal"},{"title":"List categories","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals/{portalSlug}/categories","href":"/api-reference/cloudchat/endpoints/list-categories"},{"title":"Get a category","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals/{portalSlug}/categories/{categoryId}","href":"/api-reference/cloudchat/endpoints/get-a-category"},{"title":"Create a category","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/portals/{portalSlug}/categories","href":"/api-reference/cloudchat/endpoints/create-a-category"},{"title":"Update a category","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/portals/{portalSlug}/categories/{categoryId}","href":"/api-reference/cloudchat/endpoints/update-a-category"},{"title":"Delete a category","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/portals/{portalSlug}/categories/{categoryId}","href":"/api-reference/cloudchat/endpoints/delete-a-category"},{"title":"List articles","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals/{portalSlug}/articles","href":"/api-reference/cloudchat/endpoints/list-articles"},{"title":"Get an article","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals/{portalSlug}/articles/{articleId}","href":"/api-reference/cloudchat/endpoints/get-an-article"},{"title":"Create an article","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/portals/{portalSlug}/articles","href":"/api-reference/cloudchat/endpoints/create-an-article"},{"title":"Update an article","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/portals/{portalSlug}/articles/{articleId}","href":"/api-reference/cloudchat/endpoints/update-an-article"},{"title":"Translate an article","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/portals/{portalSlug}/articles/{articleId}/translate","href":"/api-reference/cloudchat/endpoints/translate-an-article"},{"title":"Delete an article","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/portals/{portalSlug}/articles/{articleId}","href":"/api-reference/cloudchat/endpoints/delete-an-article"}]},{"group":"Uploads","pages":[{"title":"Upload an image","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/uploads","href":"/api-reference/cloudchat/endpoints/upload-an-image"}]}]},{"product":"Claudia","icon":"robot","groups":[{"group":"Getting Started","pages":[{"title":"Sign in","href":"/api-reference/claudia/sign-in"},{"title":"API credentials","href":"/api-reference/claudia/api-credentials"}]},{"group":"Authentication","pages":[{"title":"Sign in and get a token","deprecated":null,"version":null,"openapi":"/api-reference/specs/auth/v1.json post /v1/signin","href":"/api-reference/claudia/v1/auth/authentication/sign-in-and-get-a-token"},{"title":"Answer a sign-in challenge","deprecated":null,"version":null,"openapi":"/api-reference/specs/auth/v1.json post /v1/signin/challenge","href":"/api-reference/claudia/v1/auth/authentication/answer-a-sign-in-challenge"}]},{"group":"Agents","pages":[{"title":"List agents","openapi":"api-reference/specs/claudia/v1.json GET /v1/tenants/{tenant}/assistants","href":"/api-reference/claudia/endpoints/list-assistants"},{"title":"Get one agent","openapi":"api-reference/specs/claudia/v1.json GET /v1/tenants/{tenant}/assistants/{id}","href":"/api-reference/claudia/endpoints/get-assistant"},{"title":"List an agent's saved versions","openapi":"api-reference/specs/claudia/v1.json GET /v1/tenants/{tenant}/assistants/{id}/versions","href":"/api-reference/claudia/endpoints/list-assistant-versions"},{"title":"Get one saved version of an agent","openapi":"api-reference/specs/claudia/v1.json GET /v1/tenants/{tenant}/assistants/{id}/versions/{version}","href":"/api-reference/claudia/endpoints/get-assistant-version"},{"title":"Create an agent","openapi":"api-reference/specs/claudia/v1.json POST /v1/tenants/{tenant}/assistants","href":"/api-reference/claudia/endpoints/create-assistant"},{"title":"Read one prompt field's full text","openapi":"api-reference/specs/claudia/v1.json POST /v1/tenants/{tenant}/assistants/{id}/text","href":"/api-reference/claudia/endpoints/read-assistant-text"},{"title":"Propose an agent edit","openapi":"api-reference/specs/claudia/v1.json POST /v1/tenants/{tenant}/assistants/{id}/propose-edits","href":"/api-reference/claudia/endpoints/propose-assistant-edits"},{"title":"Confirm an agent edit","openapi":"api-reference/specs/claudia/v1.json POST /v1/tenants/{tenant}/assistants/{id}/confirm-edits","href":"/api-reference/claudia/endpoints/confirm-assistant-edits"},{"title":"Propose an agent create","openapi":"api-reference/specs/claudia/v1.json POST /v1/tenants/{tenant}/assistants/propose-create","href":"/api-reference/claudia/endpoints/propose-assistant-create"},{"title":"Confirm an agent create","openapi":"api-reference/specs/claudia/v1.json POST /v1/tenants/{tenant}/assistants/confirm-create","href":"/api-reference/claudia/endpoints/confirm-assistant-create"},{"title":"Delete a draft agent","openapi":"api-reference/specs/claudia/v1.json DELETE /v1/tenants/{tenant}/assistants/{id}","href":"/api-reference/claudia/endpoints/delete-assistant"},{"title":"Chat with one agent in a test conversation","openapi":"api-reference/specs/claudia/v1.json POST /v1/tenants/{tenant}/assistants/{id}/invoke","href":"/api-reference/claudia/endpoints/invoke-assistant"}]},{"group":"Agent Tools","pages":[{"title":"List agent tools","openapi":"api-reference/specs/claudia/v1.json GET /v1/tenants/{tenant}/agent-tools","href":"/api-reference/claudia/endpoints/list-agent-tools"}]},{"group":"Conversations","pages":[{"title":"Get a conversation summary","openapi":"api-reference/specs/claudia/v1.json GET /v1/conversations/{id}/summary","href":"/api-reference/claudia/endpoints/get-conversation-summary"},{"title":"Get a message's execution trace","openapi":"api-reference/specs/claudia/v1.json GET /v1/messages/{messageId}/trace","href":"/api-reference/claudia/endpoints/get-message-trace"}]},{"group":"Knowledge Bases","pages":[{"title":"List knowledge bases","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json get /v1/knowledge-bases","href":"/api-reference/claudia/v1/knowledge-bases/list-knowledge-bases"},{"title":"Get a knowledge base","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json get /v1/knowledge-bases/{kbId}","href":"/api-reference/claudia/v1/knowledge-bases/get-a-knowledge-base"},{"title":"Create a knowledge base","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json post /v1/knowledge-bases","href":"/api-reference/claudia/v1/knowledge-bases/create-a-knowledge-base"}]},{"group":"Knowledge Base Content","pages":[{"title":"List and search content","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json get /v1/knowledge-bases/{kbId}/entries","href":"/api-reference/claudia/v1/knowledge-base-content/list-and-search-content"},{"title":"Get a content entry","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json get /v1/knowledge-bases/{kbId}/entries/{entryId}","href":"/api-reference/claudia/v1/knowledge-base-content/get-a-content-entry"},{"title":"List tags in use","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json get /v1/knowledge-bases/{kbId}/entries/tags","href":"/api-reference/claudia/v1/knowledge-base-content/list-tags-in-use"},{"title":"List topics in use","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json get /v1/knowledge-bases/{kbId}/entries/topics","href":"/api-reference/claudia/v1/knowledge-base-content/list-topics-in-use"},{"title":"Create a content entry","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json post /v1/knowledge-bases/{kbId}/entries","href":"/api-reference/claudia/v1/knowledge-base-content/create-a-content-entry"},{"title":"Import content in bulk","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json post /v1/knowledge-bases/{kbId}/entries/import","href":"/api-reference/claudia/v1/knowledge-base-content/import-content-in-bulk"},{"title":"Enable or disable an entry","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json post /v1/knowledge-bases/{kbId}/entries/{entryId}/toggle-disable","href":"/api-reference/claudia/v1/knowledge-base-content/enable-or-disable-an-entry"},{"title":"Update a content entry","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json put /v1/knowledge-bases/{kbId}/entries/{entryId}","href":"/api-reference/claudia/v1/knowledge-base-content/update-a-content-entry"},{"title":"Delete a content entry","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json delete /v1/knowledge-bases/{kbId}/entries/{entryId}","href":"/api-reference/claudia/v1/knowledge-base-content/delete-a-content-entry"}]},{"group":"Content Quality","pages":[{"title":"List proposed rewrites","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json get /v1/knowledge-bases/{kbId}/improvements/quality","href":"/api-reference/claudia/v1/content-quality/list-proposed-rewrites"},{"title":"Count the quality review","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json get /v1/knowledge-bases/{kbId}/improvements/quality/summary","href":"/api-reference/claudia/v1/content-quality/count-the-quality-review"},{"title":"Approve proposed rewrites","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json post /v1/knowledge-bases/{kbId}/improvements/quality/approve","href":"/api-reference/claudia/v1/content-quality/approve-proposed-rewrites"},{"title":"Reject proposed rewrites","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json post /v1/knowledge-bases/{kbId}/improvements/quality/reject","href":"/api-reference/claudia/v1/content-quality/reject-proposed-rewrites"},{"title":"Edit a proposal before approving it","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json put /v1/knowledge-bases/{kbId}/improvements/quality/{id}","href":"/api-reference/claudia/v1/content-quality/edit-a-proposal-before-approving-it"}]},{"group":"Content Improvements","pages":[{"title":"List suggested content","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json get /v1/knowledge-bases/{kbId}/improvements","href":"/api-reference/claudia/v1/content-improvements/list-suggested-content"},{"title":"Count the review queue","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json get /v1/knowledge-bases/{kbId}/improvements/summary","href":"/api-reference/claudia/v1/content-improvements/count-the-review-queue"},{"title":"Approve suggestions","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json post /v1/knowledge-bases/{kbId}/improvements/approve","href":"/api-reference/claudia/v1/content-improvements/approve-suggestions"},{"title":"Reject suggestions","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json post /v1/knowledge-bases/{kbId}/improvements/reject","href":"/api-reference/claudia/v1/content-improvements/reject-suggestions"},{"title":"Edit a suggestion before approving it","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json put /v1/knowledge-bases/{kbId}/improvements/{entryId}","href":"/api-reference/claudia/v1/content-improvements/edit-a-suggestion-before-approving-it"}]},{"group":"Content Sources","pages":[{"title":"List content sources","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json get /v1/knowledge-bases/{kbId}/scraper-config","href":"/api-reference/claudia/v1/content-sources/list-content-sources"},{"title":"Create or update a content source","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json patch /v1/knowledge-bases/{kbId}/scraper-config","href":"/api-reference/claudia/v1/content-sources/create-or-update-a-content-source"},{"title":"Delete a content source","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json delete /v1/knowledge-bases/{kbId}/scraper-config/{configId}","href":"/api-reference/claudia/v1/content-sources/delete-a-content-source"},{"title":"Run a content source now","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json post /v1/knowledge-bases/{kbId}/scraper-config/{configId}/run","href":"/api-reference/claudia/v1/content-sources/run-a-content-source-now"}]},{"group":"MCP Servers","pages":[{"title":"List MCP servers","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json get /v1/tenants/{tenant}/mcp-servers","href":"/api-reference/claudia/v1/mcp-servers/list-mcp-servers"},{"title":"Register an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json post /v1/tenants/{tenant}/mcp-servers","href":"/api-reference/claudia/v1/mcp-servers/register-an-mcp-server"},{"title":"Probe an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json post /v1/tenants/{tenant}/mcp-servers/validate","href":"/api-reference/claudia/v1/mcp-servers/probe-an-mcp-server"},{"title":"Update an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json put /v1/tenants/{tenant}/mcp-servers/{id}","href":"/api-reference/claudia/v1/mcp-servers/update-an-mcp-server"},{"title":"Delete an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json delete /v1/tenants/{tenant}/mcp-servers/{id}","href":"/api-reference/claudia/v1/mcp-servers/delete-an-mcp-server"}]},{"group":"Playground","pages":[{"title":"Send a message to ClaudIA and read its answer","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json post /v1/playground/invoke","href":"/api-reference/claudia/v1/playground/send-a-message-to-claudia-and-read-its-answer"}]},{"group":"Project Settings","pages":[{"title":"Read a project's settings","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json get /v1/projects/{project}/settings","href":"/api-reference/claudia/v1/project-settings/read-a-projects-settings"},{"title":"Read who changed a project's settings, and to what","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json get /v1/projects/{project}/settings/history","href":"/api-reference/claudia/v1/project-settings/read-who-changed-a-projects-settings-and-to-what"},{"title":"Change a project's settings","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json patch /v1/projects/{project}/settings","href":"/api-reference/claudia/v1/project-settings/change-a-projects-settings"},{"title":"List a project's A/B variants","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json get /v1/projects/{project}/ab-keys","href":"/api-reference/claudia/v1/project-settings/list-a-projects-ab-variants"},{"title":"Read a project's A/B test","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json get /v1/projects/{project}/ab-test","href":"/api-reference/claudia/v1/ab-tests/read-a-projects-ab-test"},{"title":"Create or change an A/B variant","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json patch /v1/projects/{project}/ab-test/variants/{key}","href":"/api-reference/claudia/v1/ab-tests/create-or-change-an-ab-variant"},{"title":"Split new conversations between the base and the variants","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json put /v1/projects/{project}/ab-test/traffic","href":"/api-reference/claudia/v1/ab-tests/split-new-conversations-between-the-base-and-the-variants"},{"title":"Delete an A/B variant","deprecated":null,"version":null,"openapi":"/api-reference/specs/claudia/v1.json delete /v1/projects/{project}/ab-test/variants/{key}","href":"/api-reference/claudia/v1/ab-tests/delete-an-ab-variant"}]}]},{"product":"Controlled Flows","icon":"diagram-project","groups":[{"group":"Getting Started","pages":[{"title":"Overview","href":"/api-reference/controlled-flows/overview"}]},{"group":"Authentication","pages":[{"title":"Sign in and get a token","deprecated":null,"version":null,"openapi":"/api-reference/specs/auth/v1.json post /v1/signin","href":"/api-reference/controlled-flows/v1/auth/authentication/sign-in-and-get-a-token"},{"title":"Answer a sign-in challenge","deprecated":null,"version":null,"openapi":"/api-reference/specs/auth/v1.json post /v1/signin/challenge","href":"/api-reference/controlled-flows/v1/auth/authentication/answer-a-sign-in-challenge"}]},{"group":"Workspaces","pages":[{"title":"List workspaces","deprecated":null,"version":null,"openapi":"/api-reference/specs/controlled-flows/v1.json get /v1/workspaces","href":"/api-reference/controlled-flows/v1/workspaces/list-workspaces"}]},{"group":"Flows","pages":[{"title":"List flows","deprecated":null,"version":null,"openapi":"/api-reference/specs/controlled-flows/v1.json get /v1/typebots","href":"/api-reference/controlled-flows/v1/flows/list-flows"},{"title":"Get a flow","deprecated":null,"version":null,"openapi":"/api-reference/specs/controlled-flows/v1.json get /v1/typebots/{flowId}","href":"/api-reference/controlled-flows/v1/flows/get-a-flow"},{"title":"Create a flow","deprecated":null,"version":null,"openapi":"/api-reference/specs/controlled-flows/v1.json post /v1/typebots","href":"/api-reference/controlled-flows/v1/flows/create-a-flow"},{"title":"Update a flow","deprecated":null,"version":null,"openapi":"/api-reference/specs/controlled-flows/v1.json patch /v1/typebots/{flowId}","href":"/api-reference/controlled-flows/v1/flows/update-a-flow"},{"title":"Validate a flow","deprecated":null,"version":null,"openapi":"/api-reference/specs/controlled-flows/v1.json get /v1/typebots/{flowId}/validate","href":"/api-reference/controlled-flows/v1/flows/validate-a-flow"},{"title":"Publish a flow","deprecated":null,"version":null,"openapi":"/api-reference/specs/controlled-flows/v1.json post /v1/typebots/{flowId}/publish","href":"/api-reference/controlled-flows/v1/flows/publish-a-flow"}]},{"group":"Versions","pages":[{"title":"List flow versions","deprecated":null,"version":null,"openapi":"/api-reference/specs/controlled-flows/v1.json get /v1/typebots/{flowId}/history","href":"/api-reference/controlled-flows/v1/versions/list-flow-versions"},{"title":"Restore a flow version","deprecated":null,"version":null,"openapi":"/api-reference/specs/controlled-flows/v1.json post /v1/typebots/{flowId}/history/{historyId}/rollback","href":"/api-reference/controlled-flows/v1/versions/restore-a-flow-version"}]},{"group":"Credentials","pages":[{"title":"List REST API credentials","deprecated":null,"version":null,"openapi":"/api-reference/specs/controlled-flows/v1.json get /v1/credentials","href":"/api-reference/controlled-flows/v1/credentials/list-rest-api-credentials"},{"title":"Create a REST API credential","deprecated":null,"version":null,"openapi":"/api-reference/specs/controlled-flows/v1.json post /v1/credentials","href":"/api-reference/controlled-flows/v1/credentials/create-a-rest-api-credential"}]}]}]}]},"basePath":"","title":"ClaudIA API - Cloud Chat","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":[],"chunks":[]}