Interactly helps developers build, test, and deploy voice agents at scale.
Quickstart (<5 minutes)
Get started now with the Interactly Dashboard.
Documentation
Learn how to use Interactly’s AI platform.
API Reference
Learn how to use Interactly’s API’s.
GitHub
Check out our public SDKs.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Interactly API","colors":{"primary":"#1E6EFF","light":"#1E6EFF","dark":"#1E6EFF"},"logo":{"light":"https://mintcdn.com/interactly-qa/rQv06DcAu00ifyO5/logo/logo_light.svg?fit=max\u0026auto=format\u0026n=rQv06DcAu00ifyO5\u0026q=85\u0026s=eb6e3c5ae13dedc06c7f4af81bffb90d","dark":"https://mintcdn.com/interactly-qa/rQv06DcAu00ifyO5/logo/logo_dark.svg?fit=max\u0026auto=format\u0026n=rQv06DcAu00ifyO5\u0026q=85\u0026s=7df0871e3b8149b8337d8f907a078ed7"},"favicon":"https://mintcdn.com/interactly-qa/20698e0YpWVbNAWm/logo/favicon.png?fit=max\u0026auto=format\u0026n=20698e0YpWVbNAWm\u0026q=85\u0026s=d20934ecbb58c578651e1c26eb7e922a","api":{"playground":{"display":"interactive","proxy":false}},"appearance":{"default":"light"},"navbar":{"links":[{"href":"https://interactly.ai","label":"Website"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard-qa.interactly.ai"}},"footer":{"socials":{}},"seo":{"indexing":"all"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"interactly-qa","hasAudioNarration":false,"actualSubdomain":"interactly-qa","customDomains":["docs-qa.interactly.ai"],"gitSource":{"type":"github","owner":"interactly","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a548c02370bcde85027ad75","collectionId":"0357f8f2-f8b1-4504-a8e2-46e87b2a8016","schemaVersion":"v3"},"entitlements":{},"buildId":"6a548c02370bcde85027ad75:success","clientVersion":"0.0.3939","searchFilterCounts":[{"language":"default","tag":"API Reference","count":256},{"language":"default","tag":"Workflows","count":140},{"language":"default","tag":"Integrations","count":61},{"language":"default","tag":"Campaigns","count":42},{"language":"default","tag":"APIs","count":38},{"language":"default","tag":"Documentation","count":33},{"language":"default","tag":"Tools","count":15},{"language":"default","tag":"Prompts","count":13},{"language":"default","tag":"Simulations","count":13},{"language":"default","tag":"Integrations Resource Records V2","count":12}]},"assistantConfig":{},"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":"welcome","slug":"/welcome","pageMetadata":{"title":"👋 Welcome to Interactly Docs","layout":"overview","mode":"wide","groups":[],"hideGlobalLinks":true,"description":null,"href":"/welcome"},"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,CardGroup}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Interactly helps developers build, test, and deploy voice agents at scale.`}),`\n`,_jsx(`br`,{}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Quickstart (\u003c5 minutes)`,icon:`clock`,href:`/quickstart/dashboard`,children:_jsx(_components.p,{children:`Get started now with the Interactly Dashboard.`})}),_jsx(Card,{title:`Documentation`,icon:`book`,href:`/general/introduction`,children:_jsx(_components.p,{children:`Learn how to use Interactly’s AI platform.`})}),_jsx(Card,{title:`API Reference`,icon:`code`,href:`/api-reference`,children:_jsx(_components.p,{children:`Learn how to use Interactly’s API’s.`})}),_jsx(Card,{title:`GitHub`,icon:`fa-brands fa-github`,href:`https://github.com/Interactly`,children:_jsx(_components.p,{children:`Check out our public SDKs.`})})]})]})}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":"👋 Welcome to Interactly Docs","layout":"overview","mode":"wide","groups":[],"hideGlobalLinks":true,"description":null,"href":"/welcome"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"interactly-qa","siteName":"Interactly API","title":"👋 Welcome to Interactly Docs - Interactly API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-13T06:56:22.532Z","originalFileLocation":"welcome.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Interactly API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/interactly-qa/ztkxC4YjXG9OzWnh/_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/interactly-qa/ztkxC4YjXG9OzWnh/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/interactly-qa/ztkxC4YjXG9OzWnh/_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/interactly-qa/ztkxC4YjXG9OzWnh/_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/interactly-qa/ztkxC4YjXG9OzWnh/_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/interactly-qa/ztkxC4YjXG9OzWnh/_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/interactly-qa/ztkxC4YjXG9OzWnh/_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/interactly-qa/ztkxC4YjXG9OzWnh/_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/interactly-qa/ztkxC4YjXG9OzWnh/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"👋 Welcome to Interactly Docs - Interactly API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Interactly API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs-qa.interactly.ai/welcome\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://interactly-qa.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=%F0%9F%91%8B+Welcome+to+Interactly+Docs\u0026amp;theme=f91e2e5da38dddab758a5d35\u0026amp;signature=b0b03819ad4cb2427137a34a0b8a68968b1e3289cbe37fe20701bc9984806a11\">\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=\"👋 Welcome to Interactly Docs - Interactly API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://interactly-qa.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=%F0%9F%91%8B+Welcome+to+Interactly+Docs\u0026amp;theme=f91e2e5da38dddab758a5d35\u0026amp;signature=b0b03819ad4cb2427137a34a0b8a68968b1e3289cbe37fe20701bc9984806a11\">\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/interactly-qa/ztkxC4YjXG9OzWnh/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Interactly API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1E6EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs-qa.interactly.ai/welcome\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/welcome.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Interactly API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Interactly API","nav":{"global":null,"tabs":[{"tab":"Overview","pages":[{"title":"👋 Welcome to Interactly Docs","mode":"wide","groups":[],"href":"/welcome"}]},{"tab":"Documentation","groups":[{"group":"General","pages":[{"title":"Welcome","description":"Here you'll find information to get started, as well as a sample API Reference.","href":"/general/introduction"},{"title":"Support","href":"/general/support"}]},{"group":"Quickstart","pages":[{"title":"Dashboard","href":"/quickstart/dashboard"},{"title":null,"href":"/quickstart/client-SDK"}]},{"group":"Calls","pages":[{"title":"Live Call Control","href":"/calls/call-features"}]},{"group":"Campaigns","pages":[{"title":"Campaigns","href":"/campaigns/introduction"},{"title":"Single-Modal Campaign","href":"/campaigns/single-modal-campaign"},{"title":"Multi-Modal Campaign","href":"/campaigns/multi-modal-campaign"},{"title":"Retry Policy of Campaigns","href":"/campaigns/retry-policy-of-campaigns"},{"title":"DND \u0026 Callback","href":"/campaigns/dnd-and-callback"}]},{"group":"Workflows","pages":[{"title":"Workflows","href":"/workflows/introduction"},{"title":"Building a Workflow","href":"/workflows/building-a-workflow"},{"title":"Node Types","href":"/workflows/node-types"},{"title":"Workflow Versioning","href":"/workflows/workflow-versioning"},{"title":"Workflow Simulation","href":"/workflows/workflow-simulation"},{"title":"Tools \u0026 Integrations","href":"/workflows/tools-and-integrations"},{"title":"Scheduled \u0026 Triggered Workflows","href":"/workflows/scheduled-and-triggered-workflows"},{"title":"Workflow Webhooks","href":"/workflows/workflow-webhooks"}]},{"group":"Assistant Tools","pages":[{"title":"Assistant Tools","href":"/assistant-tools/introduction"},{"title":"Testing Tools","href":"/assistant-tools/testing-tools"}]},{"group":"Webhooks","pages":[{"title":"Webhook Events Overview","href":"/webhooks/events/introduction"},{"title":"Status Update Event","href":"/webhooks/events/status-update"},{"title":"Conversation Update Event","href":"/webhooks/events/conversation-update"},{"title":"End of Call Report Event","href":"/webhooks/events/end-of-call-report"},{"title":"Hang Event","href":"/webhooks/events/hang"},{"title":"Error Event","href":"/webhooks/events/error"},{"title":"Local Testing with ngrok","href":"/webhooks/events/testing/ngrok-setup"},{"title":"Live Events Dashboard","href":"/webhooks/events/testing/live-events-dashboard"}]},{"group":"Vendors","pages":[{"title":"Transcribers","href":"/vendors/transcribers"},{"title":"Voices","href":"/vendors/voices"},{"title":"Models","href":"/vendors/models"},{"title":"ElevenLabs TTS Configuration Guide","href":"/vendors/elevenlabs-TTS-recommended-configurations"}]},{"group":"Prompts","pages":[{"title":"Tags","href":"/prompts/tags"}]}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"API Keys","href":"/api-reference/api-keys"}]},{"group":"APIs","pages":[{"group":"Calls","pages":[{"title":"List Calls","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json get /calls/v1/conversations","href":"/api-reference/calls/list-calls"},{"title":"Create Call","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json post /calls/v1/conversations","href":"/api-reference/calls/create-call"},{"title":"Connect Call","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json post /calls/v1/conversations/connect","href":"/api-reference/calls/connect-call"},{"title":"Get Call","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json get /calls/v1/conversations/{id}","href":"/api-reference/calls/get-call"},{"title":"Control Call","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json post /calls/v1/conversations/{id}/control","href":"/api-reference/calls/control-call"}]},{"group":"Assistants","pages":[{"title":"List Assistants","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json get /assistants/v1/assistants","href":"/api-reference/assistants/list-assistants"},{"title":"Create Assistant","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json post /assistants/v1/assistants","href":"/api-reference/assistants/create-assistant"},{"title":"Get Assistant","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json get /assistants/v1/assistants/{id}","href":"/api-reference/assistants/get-assistant"},{"title":"Delete Assistant","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json delete /assistants/v1/assistants/{id}","href":"/api-reference/assistants/delete-assistant"},{"title":"Update Assistant","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json patch /assistants/v1/assistants/{id}","href":"/api-reference/assistants/update-assistant"}]},{"group":"Phone Numbers","pages":[{"title":"List Purchasable Numbers","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json get /assistants/v1/numbers/purchase-list","href":"/api-reference/phone-numbers/list-purchasable-numbers"},{"title":"Import Number","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json post /assistants/v1/numbers/{provider}","href":"/api-reference/phone-numbers/import-number"},{"title":"Purchase Number","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json post /assistants/v1/numbers/purchase","href":"/api-reference/phone-numbers/purchase-number"},{"title":"List Numbers","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json get /assistants/v1/numbers","href":"/api-reference/phone-numbers/list-numbers"},{"title":"Update Number","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json put /assistants/v1/numbers/{id}","href":"/api-reference/phone-numbers/update-number"},{"title":"Delete Number","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json delete /assistants/v1/numbers/{id}","href":"/api-reference/phone-numbers/delete-number"}]},{"group":"Tools","pages":[{"title":"List Tools","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json get /assistants/v1/tools","href":"/api-reference/tools/list-tools"},{"title":"Create Tool","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json post /assistants/v1/tools","href":"/api-reference/tools/create-tool"},{"title":"Get Tool","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json get /assistants/v1/tools/{id}","href":"/api-reference/tools/get-tool"},{"title":"Delete Tool","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json delete /assistants/v1/tools/{id}","href":"/api-reference/tools/delete-tool"},{"title":"Update Tool","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json patch /assistants/v1/tools/{id}","href":"/api-reference/tools/update-tool"}]},{"group":"Files","pages":[{"title":"List Files","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json get /kb/v1/files","href":"/api-reference/files/list-files"},{"title":"Upload File","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json post /kb/v1/files","href":"/api-reference/files/upload-file"},{"title":"Get File","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json get /kb/v1/files/{id}","href":"/api-reference/files/get-file"},{"title":"Delete File","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json delete /kb/v1/files/{id}","href":"/api-reference/files/delete-file"}]},{"group":"Knowledge Bases","pages":[{"title":"List Knowledge Bases","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json get /kb/v1/knowledge-bases","href":"/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"Create Knowledge Base","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json post /kb/v1/knowledge-bases","href":"/api-reference/knowledge-bases/create-knowledge-base"},{"title":"Get Knowledge Base","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json get /kb/v1/knowledge-bases/{id}","href":"/api-reference/knowledge-bases/get-knowledge-base"},{"title":"Update Knowledge Base","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json put /kb/v1/knowledge-bases/{id}","href":"/api-reference/knowledge-bases/update-knowledge-base"},{"title":"Delete Knowledge Base","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json delete /kb/v1/knowledge-bases/{id}","href":"/api-reference/knowledge-bases/delete-knowledge-base"},{"title":"Get Knowledge Base Status","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json get /kb/v1/knowledge-bases/{id}/status","href":"/api-reference/knowledge-bases/get-knowledge-base-status"},{"title":"Query Knowledge Base","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json post /kb/v1/knowledge-bases/{id}/query","href":"/api-reference/knowledge-bases/query-knowledge-base"},{"title":"Train Knowledge Base","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json post /kb/v1/knowledge-bases/{id}/train","href":"/api-reference/knowledge-bases/train-knowledge-base"},{"title":"Fetch the FAQ template for a knowledge base","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json get /kb/v1/knowledge-bases/{id}/faq-template","href":"/api-reference/knowledge-bases/fetch-the-faq-template-for-a-knowledge-base"},{"title":"Update questions and answers in FAQ template for a knowledge base","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json put /kb/v1/knowledge-bases/{id}/faq-template","href":"/api-reference/knowledge-bases/update-questions-and-answers-in-faq-template-for-a-knowledge-base"},{"title":"Insert new questions and answers into FAQ template for a knowledge base","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json post /kb/v1/knowledge-bases/{id}/faq-template","href":"/api-reference/knowledge-bases/insert-new-questions-and-answers-into-faq-template-for-a-knowledge-base"},{"title":"Remove questions from FAQ","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json delete /kb/v1/knowledge-bases/{id}/faq-template/questions","href":"/api-reference/knowledge-bases/remove-questions-from-faq"}]},{"group":"Webhooks","pages":[{"title":"Server Message","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/common/api.json post /server","href":"/api-reference/webhooks/server-message"}]}]},{"group":"Campaigns","pages":[{"group":"Campaigns","pages":[{"title":"List Campaigns","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/campaigns","href":"/api-reference/campaigns/campaigns/list-campaigns"},{"title":"Create Campaign","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/campaigns","href":"/api-reference/campaigns/campaigns/create-campaign"},{"title":"Get Campaign","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/campaigns/{campaign_id}","href":"/api-reference/campaigns/campaigns/get-campaign"},{"title":"Delete Campaign","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json delete /campaigns/v1/campaigns/{campaign_id}","href":"/api-reference/campaigns/campaigns/delete-campaign"},{"title":"Update Campaign","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json patch /campaigns/v1/campaigns/{campaign_id}","href":"/api-reference/campaigns/campaigns/update-campaign"},{"title":"Campaign Action","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/campaigns/{campaign_id}/action","href":"/api-reference/campaigns/campaigns/campaign-action"},{"title":"Clone Campaign","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/campaigns/{campaign_id}/clone","href":"/api-reference/campaigns/campaigns/clone-campaign"},{"title":"Restore Campaign","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/campaigns/{campaign_id}/restore","href":"/api-reference/campaigns/campaigns/restore-campaign"}]},{"group":"Campaigns Calls","pages":[{"title":"Upload Calls","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/campaigns/{campaign_id}/calls","href":"/api-reference/campaigns/campaigns-calls/upload-calls"},{"title":"Get Call Count","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/campaigns/{campaign_id}/calls/count","href":"/api-reference/campaigns/campaigns-calls/get-call-count"},{"title":"List Calls","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/campaigns/{campaign_id}/calls/list","href":"/api-reference/campaigns/campaigns-calls/list-calls"},{"title":"Get Call","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/campaigns/{campaign_id}/calls/{call_id}","href":"/api-reference/campaigns/campaigns-calls/get-call"},{"title":"Delete Call","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json delete /campaigns/v1/campaigns/{campaign_id}/calls/{call_id}","href":"/api-reference/campaigns/campaigns-calls/delete-call"},{"title":"Update Call","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json patch /campaigns/v1/campaigns/{campaign_id}/calls/{call_id}","href":"/api-reference/campaigns/campaigns-calls/update-call"},{"title":"Restore Call","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/campaigns/{campaign_id}/calls/{call_id}/restore","href":"/api-reference/campaigns/campaigns-calls/restore-call"},{"title":"Download Calls","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/campaigns/{config_id}/calls/download","href":"/api-reference/campaigns/campaigns-calls/download-calls"},{"title":"Send Campaign Report Email","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/campaigns/{config_id}/calls/report","href":"/api-reference/campaigns/campaigns-calls/send-campaign-report-email"}]},{"group":"Campaign Bulk Calls","pages":[{"title":"Create Campaign Calls Bulk","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/schedule/calls","href":"/api-reference/campaigns/campaign-bulk-calls/create-campaign-calls-bulk"},{"title":"Get Call Status by ID","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/insurance-calling/calls/{call_id}/status","href":"/api-reference/campaigns/campaign-bulk-calls/get-call-status-by-id"},{"title":"Bulk Call Status","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/insurance-calling/calls/status","href":"/api-reference/campaigns/campaign-bulk-calls/bulk-call-status"}]},{"group":"Campaign Stats","pages":[{"title":"Campaign Call Stats","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/stats/campaigns/calls","href":"/api-reference/campaigns/campaign-stats/campaign-call-stats"},{"title":"Campaign Tags","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/stats/campaigns/tags","href":"/api-reference/campaigns/campaign-stats/campaign-tags"},{"title":"Campaign Stats","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/stats/campaigns","href":"/api-reference/campaigns/campaign-stats/campaign-stats"}]},{"group":"Contacts","pages":[{"title":"Get Contacts","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/contacts","href":"/api-reference/campaigns/contacts/get-contacts"},{"title":"Create New Contact","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json post /campaigns/v1/contacts","href":"/api-reference/campaigns/contacts/create-new-contact"},{"title":"Get Contacts Stats","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/contacts/stats","href":"/api-reference/campaigns/contacts/get-contacts-stats"},{"title":"Get Contact By Id","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json get /campaigns/v1/contacts/{contact_id}","href":"/api-reference/campaigns/contacts/get-contact-by-id"},{"title":"Update Contact","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json put /campaigns/v1/contacts/{contact_id}","href":"/api-reference/campaigns/contacts/update-contact"},{"title":"Delete Contact","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/campaigns/api.json delete /campaigns/v1/contacts/{contact_id}","href":"/api-reference/campaigns/contacts/delete-contact"}]}]},{"group":"Workflows","pages":[{"group":"Nodes","pages":[{"title":"Get Node Types","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/nodes/types","href":"/api-reference/workflows/nodes/get-node-types"},{"title":"Get Node Schema","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/nodes/schema/{node_type}","href":"/api-reference/workflows/nodes/get-node-schema"},{"title":"Get Nodes","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/nodes","href":"/api-reference/workflows/nodes/get-nodes"},{"title":"Create Node","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/nodes","href":"/api-reference/workflows/nodes/create-node"},{"title":"Get Node","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/nodes/{node_id}","href":"/api-reference/workflows/nodes/get-node"},{"title":"Delete Node","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/nodes/{node_id}","href":"/api-reference/workflows/nodes/delete-node"},{"title":"Update Node","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/nodes/{node_id}","href":"/api-reference/workflows/nodes/update-node"}]},{"group":"Edges","pages":[{"title":"Get Edge Types","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/edges/types","href":"/api-reference/workflows/edges/get-edge-types"},{"title":"Get Edge Schema","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/edges/schema/{edge_type}","href":"/api-reference/workflows/edges/get-edge-schema"},{"title":"Get Edges","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/edges","href":"/api-reference/workflows/edges/get-edges"},{"title":"Create Edge","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/edges","href":"/api-reference/workflows/edges/create-edge"},{"title":"Get Edge","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/edges/{edge_id}","href":"/api-reference/workflows/edges/get-edge"},{"title":"Delete Edge","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/edges/{edge_id}","href":"/api-reference/workflows/edges/delete-edge"},{"title":"Update Edge","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/edges/{edge_id}","href":"/api-reference/workflows/edges/update-edge"}]},{"group":"Workflows","pages":[{"title":"Get Workflow Schema","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/schema","href":"/api-reference/workflows/workflows/get-workflow-schema"},{"title":"Get Global Node Config Schema","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/schemas/global-node-config","href":"/api-reference/workflows/workflows/get-global-node-config-schema"},{"title":"Get Workflow Dynamic Variables","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/dynamic-variables/{workflow_id}","href":"/api-reference/workflows/workflows/get-workflow-dynamic-variables"},{"title":"Get Workflows","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows","href":"/api-reference/workflows/workflows/get-workflows"},{"title":"Create Workflow","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows","href":"/api-reference/workflows/workflows/create-workflow"},{"title":"Clone Workflow Endpoint","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/{workflow_id}/clone","href":"/api-reference/workflows/workflows/clone-workflow-endpoint"},{"title":"Get Workflow","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/{workflow_id}","href":"/api-reference/workflows/workflows/get-workflow"},{"title":"Delete Workflow","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflows/{workflow_id}","href":"/api-reference/workflows/workflows/delete-workflow"},{"title":"Update Workflow","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/workflows/{workflow_id}","href":"/api-reference/workflows/workflows/update-workflow"},{"title":"Update Workflow Concurrency","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/workflows/{workflow_id}/concurrency","href":"/api-reference/workflows/workflows/update-workflow-concurrency"},{"title":"Export Workflow Bundle","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/{workflow_id}/export","href":"/api-reference/workflows/workflows/export-workflow-bundle"},{"title":"Import Workflow Bundle Endpoint","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/import/bundle","href":"/api-reference/workflows/workflows/import-workflow-bundle-endpoint"}]},{"group":"Workflow Versions","pages":[{"title":"List Team Active Versions","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/versions/active","href":"/api-reference/workflows/workflow-versions/list-team-active-versions"},{"title":"List Workflow Versions","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/{workflow_id}/versions","href":"/api-reference/workflows/workflow-versions/list-workflow-versions"},{"title":"Create Workflow Version","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/{workflow_id}/versions","href":"/api-reference/workflows/workflow-versions/create-workflow-version"},{"title":"Set Active Workflow Version","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/{workflow_id}/versions/{version_number}/activate","href":"/api-reference/workflows/workflow-versions/set-active-workflow-version"},{"title":"Delete Workflow Version","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflows/{workflow_id}/versions/{version_number}","href":"/api-reference/workflows/workflow-versions/delete-workflow-version"},{"title":"Update Workflow Version Name","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/workflows/{workflow_id}/versions/{version_number}","href":"/api-reference/workflows/workflow-versions/update-workflow-version-name"},{"title":"Update Workflow Version Config","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/workflows/{workflow_id}/versions/{version_number}/config","href":"/api-reference/workflows/workflow-versions/update-workflow-version-config"},{"title":"Compare Workflow Versions","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/{workflow_id}/versions/{version1_number}/diff/{version2_number}","href":"/api-reference/workflows/workflow-versions/compare-workflow-versions"}]},{"group":"Workflow Favorites","pages":[{"title":"Mark Workflow Favorite","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/{workflow_id}/favorite","href":"/api-reference/workflows/workflow-favorites/mark-workflow-favorite"},{"title":"Unmark Workflow Favorite","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflows/{workflow_id}/favorite","href":"/api-reference/workflows/workflow-favorites/unmark-workflow-favorite"}]},{"group":"Workflow Categories","pages":[{"title":"Get Workflow Categories","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-categories","href":"/api-reference/workflows/workflow-categories/get-workflow-categories"}]},{"group":"Tools","pages":[{"title":"Get Tool Types","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/tools/types","href":"/api-reference/workflows/tools/get-tool-types"},{"title":"Get Tool Schema","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/tools/schema/{tool_type}","href":"/api-reference/workflows/tools/get-tool-schema"},{"title":"Get Configurable Inbuilt Tools","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/tools/configurable-inbuilt","href":"/api-reference/workflows/tools/get-configurable-inbuilt-tools"},{"title":"Get Configurable Inbuilt Tool Schema","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/tools/configurable-inbuilt/{key}","href":"/api-reference/workflows/tools/get-configurable-inbuilt-tool-schema"},{"title":"Get Inbuilt Tools","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/tools/inbuilt","href":"/api-reference/workflows/tools/get-inbuilt-tools"},{"title":"Get Tools","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/tools","href":"/api-reference/workflows/tools/get-tools"},{"title":"Create Tool","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/tools","href":"/api-reference/workflows/tools/create-tool"},{"title":"Get Tool","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/tools/{tool_id}","href":"/api-reference/workflows/tools/get-tool"},{"title":"Delete Tool","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/tools/{tool_id}","href":"/api-reference/workflows/tools/delete-tool"},{"title":"Update Tool","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/tools/{tool_id}","href":"/api-reference/workflows/tools/update-tool"}]},{"group":"LLM Configs","pages":[{"title":"Get Llm Config Schema","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/schemas/llm-config","href":"/api-reference/workflows/llm-configs/get-llm-config-schema"},{"title":"Get Llm Configs","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/llm-configs","href":"/api-reference/workflows/llm-configs/get-llm-configs"},{"title":"Create Llm Config","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/llm-configs","href":"/api-reference/workflows/llm-configs/create-llm-config"},{"title":"Get Default Llm Config","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/llm-configs/default","href":"/api-reference/workflows/llm-configs/get-default-llm-config"},{"title":"Get Llm Config","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/llm-configs/{llm_config_id}","href":"/api-reference/workflows/llm-configs/get-llm-config"},{"title":"Delete Llm Config","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/llm-configs/{llm_config_id}","href":"/api-reference/workflows/llm-configs/delete-llm-config"},{"title":"Update Llm Config","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/llm-configs/{llm_config_id}","href":"/api-reference/workflows/llm-configs/update-llm-config"},{"title":"Test Llm Config","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/llm-configs/{llm_config_id}/test","href":"/api-reference/workflows/llm-configs/test-llm-config"},{"title":"Test Llm Config Inline","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/llm-configs/test","href":"/api-reference/workflows/llm-configs/test-llm-config-inline"}]},{"group":"Global Variables","pages":[{"title":"List Global Variables Endpoint","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/global-variables","href":"/api-reference/workflows/global-variables/list-global-variables-endpoint"},{"title":"Create Global Variable Endpoint","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/global-variables","href":"/api-reference/workflows/global-variables/create-global-variable-endpoint"},{"title":"Resolve Global Variables Endpoint","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/global-variables/resolve","href":"/api-reference/workflows/global-variables/resolve-global-variables-endpoint"},{"title":"Get Global Variable Endpoint","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/global-variables/{variable_id}","href":"/api-reference/workflows/global-variables/get-global-variable-endpoint"},{"title":"Delete Global Variable Endpoint","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/global-variables/{variable_id}","href":"/api-reference/workflows/global-variables/delete-global-variable-endpoint"},{"title":"Update Global Variable Endpoint","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/global-variables/{variable_id}","href":"/api-reference/workflows/global-variables/update-global-variable-endpoint"},{"title":"Bulk Create Global Variables Endpoint","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/global-variables/bulk","href":"/api-reference/workflows/global-variables/bulk-create-global-variables-endpoint"}]},{"group":"Super Nodes","pages":[{"title":"List Super Nodes","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/super-nodes","href":"/api-reference/workflows/super-nodes/list-super-nodes"},{"title":"Get Super Node Interface","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/super-nodes/{workflow_id}","href":"/api-reference/workflows/super-nodes/get-super-node-interface"},{"title":"Get Super Node Schema","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/super-nodes/{workflow_id}/schema","href":"/api-reference/workflows/super-nodes/get-super-node-schema"},{"title":"Publish As Super Node","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json put /workflows/v1/workflows/{workflow_id}/super-node-interface","href":"/api-reference/workflows/super-nodes/publish-as-super-node"},{"title":"Unpublish Super Node","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflows/{workflow_id}/super-node-interface","href":"/api-reference/workflows/super-nodes/unpublish-super-node"},{"title":"Get Super Node Dependents","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/{workflow_id}/super-node-dependents","href":"/api-reference/workflows/super-nodes/get-super-node-dependents"},{"title":"Get Super Node Snapshot Status","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/{workflow_id}/super-node-snapshot-status","href":"/api-reference/workflows/super-nodes/get-super-node-snapshot-status"},{"title":"Expand Preview","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/{workflow_id}/expand-preview","href":"/api-reference/workflows/super-nodes/expand-preview"}]},{"group":"Workflow Runs","pages":[{"title":"Get Workflow Run Schema","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-runs/schema","href":"/api-reference/workflows/workflow-runs/get-workflow-run-schema"},{"title":"Get Workflow Runs","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-runs","href":"/api-reference/workflows/workflow-runs/get-workflow-runs"},{"title":"Get Workflow Run","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-runs/{workflow_run_id}","href":"/api-reference/workflows/workflow-runs/get-workflow-run"},{"title":"Delete Workflow Run","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflow-runs/{workflow_run_id}","href":"/api-reference/workflows/workflow-runs/delete-workflow-run"},{"title":"Get Workflow Run Evaluation Result","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-runs/{workflow_run_id}/evaluation-result","href":"/api-reference/workflows/workflow-runs/get-workflow-run-evaluation-result"},{"title":"Add Comment To Workflow Run","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflow-runs/{workflow_run_id}/comments","href":"/api-reference/workflows/workflow-runs/add-comment-to-workflow-run"},{"title":"Add Comment To Workflow Run Event","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflow-runs/{workflow_run_id}/events/{event_logical_id}/comments","href":"/api-reference/workflows/workflow-runs/add-comment-to-workflow-run-event"},{"title":"Delete Workflow Run Comment","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflow-runs/{workflow_run_id}/comments/{comment_logical_id}","href":"/api-reference/workflows/workflow-runs/delete-workflow-run-comment"},{"title":"Delete Workflow Run Event Comment","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflow-runs/{workflow_run_id}/events/{event_logical_id}/comments/{comment_logical_id}","href":"/api-reference/workflows/workflow-runs/delete-workflow-run-event-comment"}]},{"group":"Workflow Execution","pages":[{"title":"Execute Workflow","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/{workflow_id}/execute","href":"/api-reference/workflows/workflow-execution/execute-workflow"},{"title":"Execute Checkpoint Run","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/{workflow_id}/runs/{workflow_run_id}/checkpoint-run","href":"/api-reference/workflows/workflow-execution/execute-checkpoint-run"}]},{"group":"Workflow Webhooks","pages":[{"title":"List Workflow Webhooks","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-webhooks","href":"/api-reference/workflows/workflow-webhooks/list-workflow-webhooks"},{"title":"Create Workflow Webhook","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflow-webhooks","href":"/api-reference/workflows/workflow-webhooks/create-workflow-webhook"},{"title":"Delete Workflow Webhook","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflow-webhooks/{webhook_id}","href":"/api-reference/workflows/workflow-webhooks/delete-workflow-webhook"},{"title":"Update Workflow Webhook","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/workflow-webhooks/{webhook_id}","href":"/api-reference/workflows/workflow-webhooks/update-workflow-webhook"},{"title":"List Workflow Webhook Events","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-webhooks/events","href":"/api-reference/workflows/workflow-webhooks/list-workflow-webhook-events"},{"title":"List Workflow Webhook Attempts","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-webhooks/events/{event_id}/attempts","href":"/api-reference/workflows/workflow-webhooks/list-workflow-webhook-attempts"},{"title":"Retry Workflow Webhook Event","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflow-webhooks/events/{event_doc_id}/retry","href":"/api-reference/workflows/workflow-webhooks/retry-workflow-webhook-event"}]},{"group":"Workflow Schedules","pages":[{"title":"List Workflow Schedules","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflows/{workflow_id}/schedules","href":"/api-reference/workflows/workflow-schedules/list-workflow-schedules"},{"title":"Create Workflow Schedule","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/workflows/{workflow_id}/schedules","href":"/api-reference/workflows/workflow-schedules/create-workflow-schedule"},{"title":"List Team Workflow Schedules","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-schedules","href":"/api-reference/workflows/workflow-schedules/list-team-workflow-schedules"},{"title":"Get Workflow Schedule","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/workflow-schedules/{schedule_id}","href":"/api-reference/workflows/workflow-schedules/get-workflow-schedule"},{"title":"Cancel Workflow Schedule","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/workflow-schedules/{schedule_id}","href":"/api-reference/workflows/workflow-schedules/cancel-workflow-schedule"},{"title":"Update Workflow Schedule","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/workflow-schedules/{schedule_id}","href":"/api-reference/workflows/workflow-schedules/update-workflow-schedule"}]},{"group":"Node Libraries","pages":[{"title":"Get Node Library Schema","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/node-libraries/schema","href":"/api-reference/workflows/node-libraries/get-node-library-schema"},{"title":"Get Node Libraries","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/node-libraries","href":"/api-reference/workflows/node-libraries/get-node-libraries"},{"title":"Create Node Library","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/node-libraries","href":"/api-reference/workflows/node-libraries/create-node-library"},{"title":"Get Node Library","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/node-libraries/{node_library_id}","href":"/api-reference/workflows/node-libraries/get-node-library"},{"title":"Delete Node Library","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/node-libraries/{node_library_id}","href":"/api-reference/workflows/node-libraries/delete-node-library"},{"title":"Update Node Library","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/node-libraries/{node_library_id}","href":"/api-reference/workflows/node-libraries/update-node-library"}]},{"group":"Workflow Templates","pages":[{"title":"Get Workflow Template Schema","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/templates/schema","href":"/api-reference/workflows/workflow-templates/get-workflow-template-schema"},{"title":"Get Workflow Templates","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/templates","href":"/api-reference/workflows/workflow-templates/get-workflow-templates"},{"title":"Create Workflow Template","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/templates","href":"/api-reference/workflows/workflow-templates/create-workflow-template"},{"title":"Get Workflow Template","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/templates/{workflow_template_id}","href":"/api-reference/workflows/workflow-templates/get-workflow-template"},{"title":"Delete Workflow Template","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/templates/{workflow_template_id}","href":"/api-reference/workflows/workflow-templates/delete-workflow-template"},{"title":"Update Workflow Template","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/templates/{workflow_template_id}","href":"/api-reference/workflows/workflow-templates/update-workflow-template"}]},{"group":"Simulations","pages":[{"title":"Get Simulation Schema","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulations/schema","href":"/api-reference/workflows/simulations/get-simulation-schema"},{"title":"Get Simulations","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulations","href":"/api-reference/workflows/simulations/get-simulations"},{"title":"Create Simulation","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/simulations","href":"/api-reference/workflows/simulations/create-simulation"},{"title":"Get Simulation","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulations/{simulation_id}","href":"/api-reference/workflows/simulations/get-simulation"},{"title":"Delete Simulation","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json delete /workflows/v1/simulations/{simulation_id}","href":"/api-reference/workflows/simulations/delete-simulation"},{"title":"Update Simulation","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json patch /workflows/v1/simulations/{simulation_id}","href":"/api-reference/workflows/simulations/update-simulation"},{"title":"Run Simulation","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/simulations/{simulation_id}/run","href":"/api-reference/workflows/simulations/run-simulation"},{"title":"Get Simulation Runs","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulations/{simulation_id}/runs","href":"/api-reference/workflows/simulations/get-simulation-runs"},{"title":"Get Simulation Run Details","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulation-runs/{run_id}","href":"/api-reference/workflows/simulations/get-simulation-run-details"},{"title":"Stop Simulation Run","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json post /workflows/v1/simulation-runs/{run_id}/stop","href":"/api-reference/workflows/simulations/stop-simulation-run"},{"title":"Get Individual Runs For Group","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulation-runs/{group_id}/executions","href":"/api-reference/workflows/simulations/get-individual-runs-for-group"},{"title":"Get Simulation Evaluation Summary Endpoint","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulations/{simulation_id}/evaluation-summary","href":"/api-reference/workflows/simulations/get-simulation-evaluation-summary-endpoint"},{"title":"Get Detailed Individual Runs For Group","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulation-runs/{group_id}/executions/detailed","href":"/api-reference/workflows/simulations/get-detailed-individual-runs-for-group"}]}]},{"group":"Integrations","pages":[{"group":"Auth","pages":[{"title":"Login","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v1/ms/auth","href":"/api-reference/integrations/auth/login"}]},{"group":"Admin","pages":[{"title":"Debug","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/debug","href":"/api-reference/integrations/admin/debug"},{"title":"Reset Integrations","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json post /integrations/v1/reset","href":"/api-reference/integrations/admin/reset-integrations"},{"title":"Team Overview","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v1/admin/team/overview","href":"/api-reference/integrations/admin/team-overview"},{"title":"Get Integration Tokens","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v1/admin/team/integration-tokens","href":"/api-reference/integrations/admin/get-integration-tokens"},{"title":"List Indexes","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v1/admin/indexes","href":"/api-reference/integrations/admin/list-indexes"},{"title":"Get Past Analysis","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v1/admin/use-case-runs/past-analysis","href":"/api-reference/integrations/admin/get-past-analysis"}]},{"group":"Integrations","pages":[{"title":"List Integrations Alias","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v1/connected-integrations","href":"/api-reference/integrations/integrations/list-integrations-alias"},{"title":"Get Integration","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v1/integrations/{integration}","href":"/api-reference/integrations/integrations/get-integration"},{"title":"Delete Integration","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json delete /integrations/v1/integrations/{integration}","href":"/api-reference/integrations/integrations/delete-integration"},{"title":"Disconnect Integration","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json post /integrations/v1/integrations/{integration}/disconnect","href":"/api-reference/integrations/integrations/disconnect-integration"},{"title":"Reconnect Integration","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json post /integrations/v1/integrations/{integration}/reconnect","href":"/api-reference/integrations/integrations/reconnect-integration"}]},{"group":"Use Cases","pages":[{"title":"List Use Cases","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v1/use-cases","href":"/api-reference/integrations/use-cases/list-use-cases"},{"title":"Get Use Case Schema","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v1/use-cases/{use_case}/schema","href":"/api-reference/integrations/use-cases/get-use-case-schema"},{"title":"List Use Case Groups","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v1/integrations/{integration}/use-case-groups","href":"/api-reference/integrations/use-cases/list-use-case-groups"},{"title":"Upsert Group And Usecases","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json post /integrations/v1/integrations/{integration}/use-case-groups","href":"/api-reference/integrations/use-cases/upsert-group-and-usecases"},{"title":"Get Use Case Group","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v1/integrations/{integration}/use-case-groups/{group_id}","href":"/api-reference/integrations/use-cases/get-use-case-group"},{"title":"Delete Use Case Group","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json delete /integrations/v1/integrations/{integration}/use-case-groups/{group_id}","href":"/api-reference/integrations/use-cases/delete-use-case-group"}]},{"group":"Cadence Public","pages":[{"title":"Reset Get","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/public/v1/cadence/reset","href":"/api-reference/integrations/cadence-public/reset-get"},{"title":"Reset","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json delete /integrations/public/v1/cadence/reset","href":"/api-reference/integrations/cadence-public/reset"},{"title":"Get Records","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json post /integrations/public/v1/cadence/{integration}/get-records","href":"/api-reference/integrations/cadence-public/get-records"},{"title":"Run Now","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/public/v1/cadence/run-now","href":"/api-reference/integrations/cadence-public/run-now"},{"title":"Get Status","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/public/v1/cadence/status","href":"/api-reference/integrations/cadence-public/get-status"},{"title":"Run Legacy","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/public/v1/cadence/run","href":"/api-reference/integrations/cadence-public/run-legacy"},{"title":"Patient Uuid Analysis","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/public/v1/cadence/patient-uuid-analysis","href":"/api-reference/integrations/cadence-public/patient-uuid-analysis"}]},{"group":"Cadence Run","pages":[{"title":"Run","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v1/cadence/run","href":"/api-reference/integrations/cadence-run/run"}]},{"group":"Integrations Admin","pages":[{"title":"Reset Integrations","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json post /integrations/v1/integrations/reset","href":"/api-reference/integrations/integrations-admin/reset-integrations"}]},{"group":"Verify sheets","pages":[{"title":"Verify Live Sheet","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json post /integrations/v1/{integration}/verify-live-sheet","href":"/api-reference/integrations/verify-sheets/verify-live-sheet"}]},{"group":"Integrations IO V2","pages":[{"title":"Export Integration","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/integrations/{integration_id}/export","href":"/api-reference/integrations/integrations-io-v2/export-integration"},{"title":"Import Integration","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json post /integrations/v2/integrations/import","href":"/api-reference/integrations/integrations-io-v2/import-integration"}]},{"group":"Integrations V2","pages":[{"title":"Get Integrations Schema","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/integrations/schema","href":"/api-reference/integrations/integrations-v2/get-integrations-schema"},{"title":"List Integrations","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/integrations","href":"/api-reference/integrations/integrations-v2/list-integrations"},{"title":"Create Integration","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json post /integrations/v2/integrations","href":"/api-reference/integrations/integrations-v2/create-integration"},{"title":"Get Integration","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/integrations/{integration_id}","href":"/api-reference/integrations/integrations-v2/get-integration"},{"title":"Delete Integration","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json delete /integrations/v2/integrations/{integration_id}","href":"/api-reference/integrations/integrations-v2/delete-integration"},{"title":"Update Integration","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json patch /integrations/v2/integrations/{integration_id}","href":"/api-reference/integrations/integrations-v2/update-integration"},{"title":"Oauth Authorize","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/integrations/{integration_provider}/auth","href":"/api-reference/integrations/integrations-v2/oauth-authorize"}]},{"group":"Integrations Use Cases V2","pages":[{"title":"Get Use Cases Schema","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/use-cases/schema","href":"/api-reference/integrations/integrations-use-cases-v2/get-use-cases-schema"},{"title":"List Integrations","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/use-cases","href":"/api-reference/integrations/integrations-use-cases-v2/list-integrations"},{"title":"Create Integration","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json post /integrations/v2/use-cases","href":"/api-reference/integrations/integrations-use-cases-v2/create-integration"},{"title":"Get Integration","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/use-cases/{integration_use_case_id}","href":"/api-reference/integrations/integrations-use-cases-v2/get-integration"},{"title":"Delete Integration","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json delete /integrations/v2/use-cases/{integration_use_case_id}","href":"/api-reference/integrations/integrations-use-cases-v2/delete-integration"},{"title":"Update Integration","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json patch /integrations/v2/use-cases/{integration_use_case_id}","href":"/api-reference/integrations/integrations-use-cases-v2/update-integration"},{"title":"Assistant Integrations","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/assistant/integrations/{assistant_id}","href":"/api-reference/integrations/integrations-use-cases-v2/assistant-integrations"}]},{"group":"Integrations Resource Records V2","pages":[{"title":"Get Resource Records Schema","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/resource-records/schema","href":"/api-reference/integrations/integrations-resource-records-v2/get-resource-records-schema"},{"title":"List Resource Records","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/resource-records","href":"/api-reference/integrations/integrations-resource-records-v2/list-resource-records"},{"title":"Create Resource Record","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json post /integrations/v2/resource-records","href":"/api-reference/integrations/integrations-resource-records-v2/create-resource-record"},{"title":"Create Resource Records Bulk","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json post /integrations/v2/resource-records/bulk","href":"/api-reference/integrations/integrations-resource-records-v2/create-resource-records-bulk"},{"title":"Get Resource Record","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/resource-records/{integration_resource_record_id}","href":"/api-reference/integrations/integrations-resource-records-v2/get-resource-record"},{"title":"Delete Resource Record","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json delete /integrations/v2/resource-records/{integration_resource_record_id}","href":"/api-reference/integrations/integrations-resource-records-v2/delete-resource-record"},{"title":"Update Resource Record","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json patch /integrations/v2/resource-records/{integration_resource_record_id}","href":"/api-reference/integrations/integrations-resource-records-v2/update-resource-record"},{"title":"Sync Integration Resource Records Data","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/resource-records/{integration_id}/type/{resource_record_type}/sync","href":"/api-reference/integrations/integrations-resource-records-v2/sync-integration-resource-records-data"},{"title":"Get Appointments Dashboard","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/resource-records/{integration_id}/appointments/statistics","href":"/api-reference/integrations/integrations-resource-records-v2/get-appointments-dashboard"},{"title":"Get Patients Dashboard","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/resource-records/{integration_id}/patients/statistics","href":"/api-reference/integrations/integrations-resource-records-v2/get-patients-dashboard"},{"title":"Get Patient Coverage Stedi Response","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/resource-records/{integration_id}/patients/{patient_mrn_id}/coverage/{coverage_id}","href":"/api-reference/integrations/integrations-resource-records-v2/get-patient-coverage-stedi-response"},{"title":"Get Patient Coverage Uploaded Documents","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/resource-records/{integration_id}/patients/{patient_mrn_id}/coverage/{coverage_id}/uploaded-documents","href":"/api-reference/integrations/integrations-resource-records-v2/get-patient-coverage-uploaded-documents"}]}]},{"group":"Prompts","pages":[{"group":"Prompts","pages":[{"title":"List Prompts","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/prompts/api.json get /prompts/v1/prompts","href":"/api-reference/prompts/prompts/list-prompts"},{"title":"Create Prompt","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/prompts/api.json post /prompts/v1/prompts","href":"/api-reference/prompts/prompts/create-prompt"},{"title":"Get Prompt By Id","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/prompts/api.json get /prompts/v1/prompts/{prompt_id}","href":"/api-reference/prompts/prompts/get-prompt-by-id"},{"title":"Update Prompt","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/prompts/api.json put /prompts/v1/prompts/{prompt_id}","href":"/api-reference/prompts/prompts/update-prompt"},{"title":"Delete Prompt By Id","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/prompts/api.json delete /prompts/v1/prompts/{prompt_id}","href":"/api-reference/prompts/prompts/delete-prompt-by-id"},{"title":"Generate Prompt","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/prompts/api.json post /prompts/v1/generate","href":"/api-reference/prompts/prompts/generate-prompt"}]}]},{"group":"SMS","pages":[{"group":"SMS Libraries and APIs","pages":[{"title":"Send a test SMS to the specified phone number","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/sms/api.json post /sms/v1/test/messages","href":"/api-reference/sms/sms-libraries-and-apis/send-a-test-sms-to-the-specified-phone-number"},{"title":"Send an outbound SMS","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/sms/api.json post /sms/v1/sms/send","href":"/api-reference/sms/sms-libraries-and-apis/send-an-outbound-sms"},{"title":"List SMS logs","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/sms/api.json get /sms/v1/sms/logs","href":"/api-reference/sms/sms-libraries-and-apis/list-sms-logs"},{"title":"SMS Logs Direction Stats","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/sms/api.json get /sms/v1/sms/logs/stats/direction","href":"/api-reference/sms/sms-libraries-and-apis/sms-logs-direction-stats"},{"title":"SMS Logs Status Stats","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/sms/api.json get /sms/v1/sms/logs/stats/status","href":"/api-reference/sms/sms-libraries-and-apis/sms-logs-status-stats"},{"title":"Get SMS log by ID","deprecated":null,"version":null,"openapi":"https://api-qa.interactly.ai/api-docs/sms/api.json get /sms/v1/sms/logs/{sms_log_id}","href":"/api-reference/sms/sms-libraries-and-apis/get-sms-log-by-id"}]}]}],"global":{"anchors":[{"anchor":"Swagger","icon":"code","href":"https://api-qa.interactly.ai/api-docs"},{"anchor":"OpenAPI","icon":"code","href":"https://api-qa.interactly.ai/api-docs/api.json"}]}},{"tab":"Changelog","pages":[{"title":"Product updates","mode":"center","href":"/changelog/release-notes"}]}]},"title":"👋 Welcome to Interactly Docs - Interactly API","buildId":"dpl_5UDDZ9hnigTkoV7QtvQ39eUp84nu","deploymentId":"dpl_5UDDZ9hnigTkoV7QtvQ39eUp84nu","dynamics":[],"chunks":[]}