The id of a test invocation. This is returned when tests are run.
Response
Successful Response
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Threetone Documentation","description":"Build, integrate, and operate Threetone agents and workspace APIs.","colors":{"primary":"#1a1a1a","light":"#f8f9fa","dark":"#8a8a8a"},"logo":{"light":"https://mintcdn.com/threetonelabs-c2efc9c8/iVsG1p4ZwGEMCBdd/logo/light.svg?fit=max\u0026auto=format\u0026n=iVsG1p4ZwGEMCBdd\u0026q=85\u0026s=fa47dee0de897fb2d029e48e66fb4540","dark":"https://mintcdn.com/threetonelabs-c2efc9c8/iVsG1p4ZwGEMCBdd/logo/dark.svg?fit=max\u0026auto=format\u0026n=iVsG1p4ZwGEMCBdd\u0026q=85\u0026s=85496857c3918505600166bcac1b9a2c","href":"https://threetone.in"},"favicon":"https://mintcdn.com/threetonelabs-c2efc9c8/aisQb_L7Nw-QdfvJ/favicon.png?fit=max\u0026auto=format\u0026n=aisQb_L7Nw-QdfvJ\u0026q=85\u0026s=6ab6a70e51ff4b4d491fc1539401163c","api":{"params":{"expanded":"closed"},"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"],"prefill":false}},"navbar":{"links":[{"href":"https://threetone.in/blog","label":"Blog"},{"href":"https://help.threetone.in/en","label":"Help Center"}],"primary":{"type":"button","label":"Dashboard","href":"https://threetone.in/app/agents"}},"footer":{"socials":{"x":"https://x.com/threetoneai","github":"https://github.com/threetonelabs","linkedin":"https://www.linkedin.com/company/threetonelabs","instagram":"https://www.instagram.com/threetonelabs"}},"seo":{"metatags":{"twitter:site":"@threetoneai"},"organization":{"id":"https://threetone.in/#organization","name":"Threetone","legalName":"Threetone Labs Private Limited","url":"https://threetone.in","logo":"https://threetone.in/android-chrome-192x192.png","sameAs":["https://x.com/threetoneai","https://www.linkedin.com/company/threetonelabs","https://github.com/threetonelabs","https://www.instagram.com/threetonelabs/"]}},"thumbnails":{"preset":"classic","appearance":"light","background":"https://mintcdn.com/threetonelabs-c2efc9c8/w-zHZ6bw93R-mGOw/images/og-orb-background.png?fit=max\u0026auto=format\u0026n=w-zHZ6bw93R-mGOw\u0026q=85\u0026s=e3049498865acebcb29c6202d86645a5","fonts":{"family":"Inter"},"eyebrow":{"style":"plain"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"threetonelabs-c2efc9c8","hasAudioNarration":false,"actualSubdomain":"threetonelabs-c2efc9c8","customDomains":["docs.threetone.in"],"gitSource":{"type":"github","owner":"pruthvi-yb","repo":"3t-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aeb5fd1057e717ec7ea2bb7","collectionId":"6904d960-42c0-4ec0-a609-b346e4deee4a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeb5fd1057e717ec7ea2bb7"},"entitlements":{},"buildId":"6aec3bb237327199c83b7d4a","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"Agents Platform","count":368},{"language":"default","tag":"API Reference","count":221},{"language":"default","tag":"Configure","count":71},{"language":"default","tag":"Workspace","count":66},{"language":"default","tag":"Deploy","count":46},{"language":"default","tag":"Knowledge base","count":35},{"language":"default","tag":"Integrations","count":33},{"language":"default","tag":"Agents","count":32},{"language":"default","tag":"Overview","count":29},{"language":"default","tag":"Tools","count":26}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":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":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@media (min-width: 1024px){#navbar>div:has(.nav-logo),#body-content,#content-container{max-width:none}#content-area:has(#header){max-width:48rem}}"}],"page":{"pagePath":"api-reference/test-invocations/cancel-a-test-invocation","slug":"/api-reference/test-invocations/cancel-a-test-invocation","pageMetadata":{"title":"Cancel a test invocation","description":"Cancels all pending runs in a test invocation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/test-invocations/{test_invocation_id}/cancel","href":"/api-reference/test-invocations/cancel-a-test-invocation","autogeneratedByOpenApi":true},"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: \"Cancels all pending runs in a test invocation.\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Cancel a test invocation","description":"Cancels all pending runs in a test invocation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/test-invocations/{test_invocation_id}/cancel","href":"/api-reference/test-invocations/cancel-a-test-invocation","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Test Invocations"],"summary":"Cancel a test invocation","description":"Cancels all pending runs in a test invocation.","operationId":"cancel_test_invocation_route","parameters":["074e422b-ba35-4e9b-bd07-86efb66a112f","90cc6f52-706a-449e-914d-3c2b1cb84208"],"responses":{"204":"5463173b-33b1-42d0-94c6-1e4694c58b2e","422":"aa8d1f4e-9272-43be-a627-a640f941f4c7"},"x-fern-sdk-group-name":["conversational_ai","tests","invocations"],"x-fern-sdk-method-name":"cancel","method":"post","type":"path","servers":["daaf82d5-b165-4890-ac8e-0fc27d4fa86b"],"security":[],"path":"/v1/convai/test-invocations/{test_invocation_id}/cancel","baseUrlOptions":["https://api.threetone.in"],"title":"Cancel a test invocation","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"074e422b-ba35-4e9b-bd07-86efb66a112f":{"name":"test_invocation_id","in":"path","required":true,"schema":{"type":"string","description":"The id of a test invocation. This is returned when tests are run.","embed":true,"title":"Test Invocation Id","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"The id of a test invocation. This is returned when tests are run."},"90cc6f52-706a-449e-914d-3c2b1cb84208":{"name":"x-api-key","in":"header","required":false,"schema":{"oneOf":[{"type":"string","title":"X-Api-Key","description":"Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"X-Api-Key","description":"Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page."}},"responses":{"5463173b-33b1-42d0-94c6-1e4694c58b2e":{"description":"Successful Response","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"aa8d1f4e-9272-43be-a627-a640f941f4c7":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"daaf82d5-b165-4890-ac8e-0fc27d4fa86b":{"url":"https://api.threetone.in","description":"Production"}}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"threetonelabs-c2efc9c8","siteName":"Threetone Documentation","title":"Cancel a test invocation - Threetone Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T08:18:04.041Z","originalFileLocation":"api-reference/test-invocations/cancel-a-test-invocation.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=\"Cancels all pending runs in a test invocation.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Threetone Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/threetonelabs-c2efc9c8/oDwHL60jWhxp8LD3/_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/threetonelabs-c2efc9c8/oDwHL60jWhxp8LD3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/threetonelabs-c2efc9c8/oDwHL60jWhxp8LD3/_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/threetonelabs-c2efc9c8/oDwHL60jWhxp8LD3/_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/threetonelabs-c2efc9c8/oDwHL60jWhxp8LD3/_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/threetonelabs-c2efc9c8/oDwHL60jWhxp8LD3/_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/threetonelabs-c2efc9c8/oDwHL60jWhxp8LD3/_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/threetonelabs-c2efc9c8/oDwHL60jWhxp8LD3/_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/threetonelabs-c2efc9c8/oDwHL60jWhxp8LD3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Cancel a test invocation - Threetone Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cancels all pending runs in a test invocation.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Threetone Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.threetone.in/api-reference/test-invocations/cancel-a-test-invocation\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://threetonelabs-c2efc9c8.mintlify.app/_mintlify/api/og/v2?division=Test+Invocations\u0026amp;title=Cancel+a+test+invocation\u0026amp;description=Cancels+all+pending+runs+in+a+test+invocation.\u0026amp;theme=32ea2ee571213931084ddff3\u0026amp;signature=1d5c71d7bdb1934aa189c9a0c9615bd5952e6fba84267a6f61474e75c926fe6d\">\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=\"Cancel a test invocation - Threetone Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cancels all pending runs in a test invocation.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://threetonelabs-c2efc9c8.mintlify.app/_mintlify/api/og/v2?division=Test+Invocations\u0026amp;title=Cancel+a+test+invocation\u0026amp;description=Cancels+all+pending+runs+in+a+test+invocation.\u0026amp;theme=32ea2ee571213931084ddff3\u0026amp;signature=1d5c71d7bdb1934aa189c9a0c9615bd5952e6fba84267a6f61474e75c926fe6d\">\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/threetonelabs-c2efc9c8/oDwHL60jWhxp8LD3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Threetone Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1a1a1a\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.threetone.in/api-reference/test-invocations/cancel-a-test-invocation\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/test-invocations/cancel-a-test-invocation.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://threetone.in/#organization\",\"name\":\"Threetone\",\"legalName\":\"Threetone Labs Private Limited\",\"url\":\"https://threetone.in\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://threetone.in/android-chrome-192x192.png\"},\"sameAs\":[\"https://x.com/threetoneai\",\"https://www.linkedin.com/company/threetonelabs\",\"https://github.com/threetonelabs\",\"https://www.instagram.com/threetonelabs/\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.threetone.in#website\",\"name\":\"Threetone Documentation\",\"url\":\"https://docs.threetone.in\",\"publisher\":{\"@id\":\"https://threetone.in/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.threetone.in/api-reference/test-invocations/cancel-a-test-invocation#webpage\",\"url\":\"https://docs.threetone.in/api-reference/test-invocations/cancel-a-test-invocation\",\"name\":\"Cancel a test invocation\",\"description\":\"Cancels all pending runs in a test invocation.\",\"dateModified\":\"2026-11-05T08:18:04.041Z\",\"isPartOf\":{\"@id\":\"https://docs.threetone.in#website\"},\"breadcrumb\":{\"@id\":\"https://docs.threetone.in/api-reference/test-invocations/cancel-a-test-invocation#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.threetone.in/api-reference/test-invocations/cancel-a-test-invocation#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agents Platform\",\"item\":\"https://docs.threetone.in/api-reference/agents-platform/list-agent-branches\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Tests\",\"item\":\"https://docs.threetone.in/api-reference/tests/list-tests\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Test Invocations\",\"item\":\"https://docs.threetone.in/api-reference/test-invocations/get-test-invocation\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Cancel a test invocation\",\"item\":\"https://docs.threetone.in/api-reference/test-invocations/cancel-a-test-invocation\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.threetone.in/api-reference/test-invocations/cancel-a-test-invocation#apireference\",\"headline\":\"Cancel a test invocation\",\"name\":\"Cancel a test invocation\",\"description\":\"Cancels all pending runs in a test invocation.\",\"url\":\"https://docs.threetone.in/api-reference/test-invocations/cancel-a-test-invocation\",\"mainEntityOfPage\":{\"@id\":\"https://docs.threetone.in/api-reference/test-invocations/cancel-a-test-invocation#webpage\"},\"dateModified\":\"2026-11-05T08:18:04.041Z\",\"publisher\":{\"@id\":\"https://threetone.in/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.threetone.in#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Threetone Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Threetone Documentation","nav":{"global":null,"tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":"/overview/intro"}]},{"tab":"Agents Platform","pages":[{"title":"Agents Platform","href":"/agents-platform/overview"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API overview","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"}]},{"group":"Agents Platform","pages":[{"group":"Agents","pages":[{"group":"Branches","pages":[{"title":"List agent branches","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/{agent_id}/branches","href":"/api-reference/agents-platform/list-agent-branches"},{"title":"Create agent branch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agents/{agent_id}/branches","href":"/api-reference/agents-platform/create-agent-branch"},{"title":"Get agent branch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/{agent_id}/branches/{branch_id}","href":"/api-reference/agents-platform/get-agent-branch"},{"title":"Update agent branch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/agents/{agent_id}/branches/{branch_id}","href":"/api-reference/agents-platform/update-agent-branch"},{"title":"Merge agent branch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agents/{agent_id}/branches/{source_branch_id}/merge","href":"/api-reference/agents-platform/merge-agent-branch"},{"title":"Preview merged configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/{agent_id}/branches/{source_branch_id}/merge-preview","href":"/api-reference/agents-platform/preview-merged-configuration"},{"title":"Preview rebased configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/{agent_id}/branches/{branch_id}/rebase-preview","href":"/api-reference/agents-platform/preview-rebased-configuration"},{"title":"Rebase agent branch onto main","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agents/{agent_id}/branches/{branch_id}/rebase","href":"/api-reference/agents-platform/rebase-agent-branch-onto-main"}]},{"group":"Merge proposals","pages":[{"title":"Create a merge proposal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agents/{agent_id}/merge-proposals","href":"/api-reference/agents-platform/create-a-merge-proposal"},{"title":"List merge proposals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/{agent_id}/merge-proposals","href":"/api-reference/agents-platform/list-merge-proposals"},{"title":"Get a merge proposal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}","href":"/api-reference/agents-platform/get-a-merge-proposal"},{"title":"Update a merge proposal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}","href":"/api-reference/agents-platform/update-a-merge-proposal"},{"title":"Review a merge proposal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/reviews","href":"/api-reference/agents-platform/review-a-merge-proposal"},{"title":"Comment on a merge proposal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/comments","href":"/api-reference/agents-platform/comment-on-a-merge-proposal"},{"title":"Merge a merge proposal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/merge","href":"/api-reference/agents-platform/merge-a-merge-proposal"}]},{"group":"Procedures","pages":[{"title":"List procedures","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures","href":"/api-reference/agents-platform/list-procedures"},{"title":"Create procedure","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures","href":"/api-reference/agents-platform/create-procedure"},{"title":"Get procedure","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}","href":"/api-reference/agents-platform/get-procedure"},{"title":"Delete procedure","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}","href":"/api-reference/agents-platform/delete-procedure"},{"title":"Get procedure draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft","href":"/api-reference/agents-platform/get-procedure-draft"},{"title":"Update procedure draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft","href":"/api-reference/agents-platform/update-procedure-draft"},{"title":"Delete procedure draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft","href":"/api-reference/agents-platform/delete-procedure-draft"}]},{"group":"Publishing","pages":[{"title":"Create or update agent deployments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agents/{agent_id}/deployments","href":"/api-reference/agents-platform/create-or-update-agent-deployments"},{"title":"Create agent draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agents/{agent_id}/drafts","href":"/api-reference/agents-platform/create-agent-draft"},{"title":"Delete agent draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/agents/{agent_id}/drafts","href":"/api-reference/agents-platform/delete-agent-draft"},{"title":"Get agent version metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/{agent_id}/versions/{version_id}","href":"/api-reference/agents-platform/get-agent-version-metadata"},{"title":"List agent deployments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/{agent_id}/deployments","href":"/api-reference/agents-platform/list-agent-deployments"}]},{"group":"Widget","pages":[{"title":"Get agent widget configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/{agent_id}/widget","href":"/api-reference/agents-platform/get-agent-widget-configuration"},{"title":"Upload agent avatar","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agents/{agent_id}/avatar","href":"/api-reference/agents-platform/upload-agent-avatar"}]},{"group":"Hold audio","pages":[{"title":"Post Agent Hold Audio","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agents/{agent_id}/hold-audio","href":"/api-reference/agents-platform/post-agent-hold-audio"},{"title":"Delete Agent Hold Audio","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/agents/{agent_id}/hold-audio","href":"/api-reference/agents-platform/delete-agent-hold-audio"}]},{"title":"Create agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agents/create","href":"/api-reference/agents-platform/create-agent"},{"title":"Duplicate agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agents/{agent_id}/duplicate","href":"/api-reference/agents-platform/duplicate-agent"},{"title":"Get shareable agent link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/{agent_id}/link","href":"/api-reference/agents-platform/get-shareable-agent-link"},{"title":"List agent summaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/summaries","href":"/api-reference/agents-platform/list-agent-summaries"},{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents","href":"/api-reference/agents-platform/list-agents"},{"title":"Get agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/{agent_id}","href":"/api-reference/agents-platform/get-agent"},{"title":"Update agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/agents/{agent_id}","href":"/api-reference/agents-platform/update-agent"},{"title":"Delete agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/agents/{agent_id}","href":"/api-reference/agents-platform/delete-agent"}]},{"group":"Conversations","pages":[{"group":"Analysis","pages":[{"title":"Run conversation analysis","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/conversations/{conversation_id}/analysis/run","href":"/api-reference/agents-workspace-analytics/run-conversation-analysis"},{"title":"Run conversation evaluation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/conversations/{conversation_id}/analysis/evaluations/run","href":"/api-reference/agents-workspace-analytics/run-conversation-evaluation"}]},{"group":"Messages","pages":[{"title":"Text search","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/conversations/messages/text-search","href":"/api-reference/agents-platform/text-search"},{"title":"Smart search","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/conversations/messages/smart-search","href":"/api-reference/agents-platform/smart-search"}]},{"group":"Topics","pages":[{"title":"Get agent conversation topics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/{agent_id}/topics","href":"/api-reference/agents-insights/get-agent-conversation-topics"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/tags","href":"/api-reference/agents-platform/list-tags"},{"title":"Create tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/tags","href":"/api-reference/agents-platform/create-tag"},{"title":"Get tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/tags/{tag_id}","href":"/api-reference/agents-platform/get-tag"},{"title":"Update tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/tags/{tag_id}","href":"/api-reference/agents-platform/update-tag"},{"title":"Delete tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/tags/{tag_id}","href":"/api-reference/agents-platform/delete-tag"},{"title":"Add tag to conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/conversations/{conversation_id}/tags","href":"/api-reference/agents-platform/add-tag-to-conversation"},{"title":"Remove tag from conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/conversations/{conversation_id}/tags/{tag_id}","href":"/api-reference/agents-platform/remove-tag-from-conversation"}]},{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/conversations","href":"/api-reference/agents-platform/list-conversations"},{"title":"Get conversation details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/conversations/{conversation_id}","href":"/api-reference/agents-platform/get-conversation-details"},{"title":"Get conversation summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/conversations/{conversation_id}/summary","href":"/api-reference/agents-platform/get-conversation-summary"},{"title":"Delete conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/conversations/{conversation_id}","href":"/api-reference/agents-platform/delete-conversation"},{"title":"Get conversation audio","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/conversations/{conversation_id}/audio","href":"/api-reference/agents-platform/get-conversation-audio"},{"title":"Get signed URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/conversation/get-signed-url","href":"/api-reference/agents-platform/get-signed-url"},{"title":"Get conversation token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/conversation/token","href":"/api-reference/agents-platform/get-conversation-token"},{"title":"Send conversation feedback","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/conversations/{conversation_id}/feedback","href":"/api-reference/agents-platform/send-conversation-feedback"},{"title":"Upload conversation file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/conversations/{conversation_id}/files","href":"/api-reference/agents-platform/upload-conversation-file"},{"title":"Delete conversation file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/conversations/{conversation_id}/files/{file_id}","href":"/api-reference/agents-platform/delete-conversation-file"},{"title":"Get SIP messages for a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/conversations/{conversation_id}/sip-messages","href":"/api-reference/agents-platform/get-sip-messages-for-a-conversation"},{"title":"Resolve conversation reference","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/conversations/resolve","href":"/api-reference/agents-platform/resolve-conversation-reference"}]},{"group":"Tests","pages":[{"title":"List tests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agent-testing","href":"/api-reference/tests/list-tests"},{"title":"Get test","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agent-testing/{test_id}","href":"/api-reference/tests/get-test"},{"title":"Create test","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agent-testing/create","href":"/api-reference/tests/create-test"},{"title":"Update test","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/convai/agent-testing/{test_id}","href":"/api-reference/tests/update-test"},{"title":"Delete test","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/agent-testing/{test_id}","href":"/api-reference/tests/delete-test"},{"title":"Get test summaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agent-testing/summaries","href":"/api-reference/tests/get-test-summaries"},{"title":"Run tests on agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agents/{agent_id}/run-tests","href":"/api-reference/tests/run-tests-on-agent"},{"group":"Test Folders","pages":[{"title":"Create folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agent-testing/folders","href":"/api-reference/test-folders/create-folder"},{"title":"Get folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agent-testing/folders/{folder_id}","href":"/api-reference/test-folders/get-folder"},{"title":"Update folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/agent-testing/folders/{folder_id}","href":"/api-reference/test-folders/update-folder"},{"title":"Delete folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/agent-testing/folders/{folder_id}","href":"/api-reference/test-folders/delete-folder"},{"title":"Bulk move tests to folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agent-testing/bulk-move","href":"/api-reference/test-folders/bulk-move-tests-to-folder"}]},{"group":"Test Invocations","pages":[{"title":"Get test invocation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/test-invocations/{test_invocation_id}","href":"/api-reference/test-invocations/get-test-invocation"},{"title":"Resubmit test invocation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/test-invocations/{test_invocation_id}/resubmit","href":"/api-reference/test-invocations/resubmit-test-invocation"},{"title":"List test invocations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/test-invocations","href":"/api-reference/test-invocations/list-test-invocations"},{"title":"Update test invocation","description":"Updates the user-provided name of a test invocation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/test-invocations/{test_invocation_id}","href":"/api-reference/test-invocations/update-test-invocation"},{"title":"Cancel a test invocation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/test-invocations/{test_invocation_id}/cancel","href":"/api-reference/test-invocations/cancel-a-test-invocation"}]}]},{"group":"Triage tickets","pages":[{"title":"List Workspace Conversation Tickets","description":"List conversation triage tickets across every agent in the workspace, ordered by most recently created first. Use this to build a workspace-wide view (for example, tickets assigned to the caller). Supports the same filters, sorting and search as the per-agent endpoint. Tickets for agents the caller cannot access are omitted.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/triage-tickets","href":"/api-reference/list-workspace-conversation-tickets"},{"title":"Create Agent Conversation Ticket","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/triage-tickets","href":"/api-reference/create-agent-conversation-ticket"},{"title":"List tickets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/{agent_id}/triage-tickets","href":"/api-reference/list-tickets"},{"title":"Create manual ticket","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agents/{agent_id}/triage-tickets","href":"/api-reference/create-manual-ticket"},{"title":"List assignable users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agents/{agent_id}/triage-tickets/assignable-users","href":"/api-reference/list-assignable-users"},{"title":"Get ticket","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/triage-tickets/{agentqa_ticket_id}","href":"/api-reference/get-ticket"},{"title":"Update ticket","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/triage-tickets/{agentqa_ticket_id}","href":"/api-reference/update-ticket"},{"title":"Delete ticket","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/triage-tickets/{agentqa_ticket_id}","href":"/api-reference/delete-ticket"},{"title":"Add comment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/triage-tickets/{agentqa_ticket_id}/comments","href":"/api-reference/add-comment"},{"title":"Add turn comment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/triage-tickets/{agentqa_ticket_id}/turn-comments","href":"/api-reference/add-turn-comment"},{"title":"Merge tickets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/triage-tickets/{agentqa_ticket_id}/merge","href":"/api-reference/merge-tickets"}]},{"group":"Users","pages":[{"title":"List conversation users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/users","href":"/api-reference/agents-platform/list-conversation-users"}]},{"group":"Tools","pages":[{"title":"List tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/tools","href":"/api-reference/agents-platform/list-tools"},{"title":"Create tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/tools","href":"/api-reference/agents-platform/create-tool"},{"title":"Get tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/tools/{tool_id}","href":"/api-reference/agents-platform/get-tool"},{"title":"Update tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/tools/{tool_id}","href":"/api-reference/agents-platform/update-tool"},{"title":"Delete tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/tools/{tool_id}","href":"/api-reference/agents-platform/delete-tool"},{"title":"List tool executions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/tools/{tool_id}/executions","href":"/api-reference/agents-platform/list-tool-executions"},{"title":"List agents using tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/tools/{tool_id}/dependent-agents","href":"/api-reference/agents-platform/list-agents-using-tool"}]},{"group":"Knowledge base","pages":[{"group":"Documents","pages":[{"title":"List knowledge base documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/knowledge-base","href":"/api-reference/agents-platform/list-knowledge-base-documents"},{"title":"Create knowledge base document from URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/knowledge-base/url","href":"/api-reference/agents-platform/create-knowledge-base-document-from-url"},{"title":"Create knowledge base document from file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/knowledge-base/file","href":"/api-reference/agents-platform/create-knowledge-base-document-from-file"},{"title":"Create knowledge base document from text","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/knowledge-base/text","href":"/api-reference/agents-platform/create-knowledge-base-document-from-text"},{"title":"Delete knowledge base documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/knowledge-base/bulk-delete","href":"/api-reference/agents-platform/delete-knowledge-base-documents"},{"title":"Get knowledge base document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/knowledge-base/{documentation_id}","href":"/api-reference/agents-platform/get-knowledge-base-document"},{"title":"Update document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/knowledge-base/{documentation_id}","href":"/api-reference/agents-platform/update-document"},{"title":"Delete knowledge base document or folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/knowledge-base/{documentation_id}","href":"/api-reference/agents-platform/delete-knowledge-base-document-or-folder"},{"title":"Replace knowledge base file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/knowledge-base/{documentation_id}/update-file","href":"/api-reference/agents-platform/replace-knowledge-base-file"},{"title":"Refresh knowledge base URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/knowledge-base/{documentation_id}/refresh","href":"/api-reference/agents-platform/refresh-knowledge-base-url"},{"title":"Get knowledge base document content","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/knowledge-base/{documentation_id}/content","href":"/api-reference/agents-platform/get-knowledge-base-document-content"},{"title":"Get knowledge base source file URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/knowledge-base/{documentation_id}/source-file-url","href":"/api-reference/agents-platform/get-knowledge-base-source-file-url"},{"title":"Get knowledge base document chunk","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/knowledge-base/{documentation_id}/chunk/{chunk_id}","href":"/api-reference/agents-platform/get-knowledge-base-document-chunk"},{"title":"List RAG chunks for document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/knowledge-base/{documentation_id}/chunks","href":"/api-reference/agents-platform/list-rag-chunks-for-document"}]},{"group":"Folders","pages":[{"title":"Create knowledge base folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/knowledge-base/folder","href":"/api-reference/conversational-ai/create-knowledge-base-folder"},{"title":"Move knowledge base item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/knowledge-base/{document_id}/move","href":"/api-reference/conversational-ai/move-knowledge-base-item"},{"title":"Move knowledge base items","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/knowledge-base/bulk-move","href":"/api-reference/conversational-ai/move-knowledge-base-items"}]},{"group":"Search","pages":[{"title":"Search knowledge base content","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/knowledge-base/search","href":"/api-reference/agents-platform/search-knowledge-base-content"},{"title":"List knowledge base summaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/knowledge-base/summaries","href":"/api-reference/agents-platform/list-knowledge-base-summaries"},{"title":"List agents using knowledge base document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/knowledge-base/{documentation_id}/dependent-agents","href":"/api-reference/agents-platform/list-agents-using-knowledge-base-document"},{"title":"List agents using knowledge base documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/knowledge-base/dependent-agents","href":"/api-reference/agents-platform/list-agents-using-knowledge-base-documents"},{"title":"Get agent knowledge base size","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/agent/{agent_id}/knowledge-base/size","href":"/api-reference/agents-platform/get-agent-knowledge-base-size"}]},{"group":"RAG","pages":[{"title":"Get RAG index overview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/knowledge-base/rag-index","href":"/api-reference/agents-platform/get-rag-index-overview"},{"title":"Create RAG indexes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/knowledge-base/rag-index","href":"/api-reference/agents-platform/create-rag-indexes"},{"title":"Get document RAG indexes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/knowledge-base/{documentation_id}/rag-index","href":"/api-reference/agents-platform/get-document-rag-indexes"},{"title":"Create document RAG index","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/knowledge-base/{documentation_id}/rag-index","href":"/api-reference/agents-platform/create-document-rag-index"},{"title":"Delete RAG index","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/knowledge-base/{documentation_id}/rag-index/{rag_index_id}","href":"/api-reference/agents-platform/delete-rag-index"},{"title":"Query agent knowledge base","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/agents/{agent_id}/knowledge-base/rag-query","href":"/api-reference/agents-platform/query-agent-knowledge-base"}]},{"group":"Crawl jobs","pages":[{"title":"List crawl jobs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/knowledge-base/crawl","href":"/api-reference/conversational-ai/list-crawl-jobs"},{"title":"Create crawl job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/knowledge-base/crawl","href":"/api-reference/conversational-ai/create-crawl-job"},{"title":"Get crawl job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/knowledge-base/crawl/{crawl_job_id}","href":"/api-reference/conversational-ai/get-crawl-job"},{"title":"Cancel crawl job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/knowledge-base/crawl/{crawl_job_id}/cancel","href":"/api-reference/conversational-ai/cancel-crawl-job"}]}]},{"group":"Phone numbers","pages":[{"title":"List phone numbers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/phone-numbers","href":"/api-reference/agents-platform/list-phone-numbers"},{"title":"List Phone Numbers Page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/v2/phone-numbers","href":"/api-reference/agents-platform/list-phone-numbers-page"},{"title":"Import phone number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/phone-numbers","href":"/api-reference/agents-platform/import-phone-number"},{"title":"Get phone number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/phone-numbers/{phone_number_id}","href":"/api-reference/agents-platform/get-phone-number"},{"title":"Update phone number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/phone-numbers/{phone_number_id}","href":"/api-reference/agents-platform/update-phone-number"},{"title":"Delete phone number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/phone-numbers/{phone_number_id}","href":"/api-reference/agents-platform/delete-phone-number"},{"title":"Get SIP messages for a phone number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/phone-numbers/{phone_number_id}/sip-messages","href":"/api-reference/agents-platform/get-sip-messages-for-a-phone-number"},{"title":"List phone number inventory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/phone-numbers/inventory","href":"/api-reference/phone-numbers/list-phone-number-inventory"}]},{"group":"Workspace","pages":[{"group":"Settings","pages":[{"title":"Get Agents Platform settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/settings","href":"/api-reference/agents-platform/get-agents-platform-settings"},{"title":"Update Agents Platform settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/settings","href":"/api-reference/agents-platform/update-agents-platform-settings"}]},{"group":"Secrets","pages":[{"title":"List workspace secrets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/secrets","href":"/api-reference/agents-platform/list-workspace-secrets"},{"title":"Create workspace secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/secrets","href":"/api-reference/agents-platform/create-workspace-secret"},{"title":"Get workspace secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/secrets/{secret_id}","href":"/api-reference/agents-platform/get-workspace-secret"},{"title":"Update workspace secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/secrets/{secret_id}","href":"/api-reference/agents-platform/update-workspace-secret"},{"title":"Delete workspace secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/secrets/{secret_id}","href":"/api-reference/agents-platform/delete-workspace-secret"},{"title":"List secret dependencies","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/secrets/{secret_id}/dependencies/{resource_type}","href":"/api-reference/agents-platform/list-secret-dependencies"}]},{"group":"Dashboard","pages":[{"title":"Get Agents Platform dashboard settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/settings/dashboard","href":"/api-reference/agents-platform/get-agents-platform-dashboard-settings"},{"title":"Update Agents Platform dashboard settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/settings/dashboard","href":"/api-reference/agents-platform/update-agents-platform-dashboard-settings"}]}]},{"group":"Integrations","pages":[{"group":"SIP trunk","pages":[{"title":"Start outbound call via SIP trunk","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/sip-trunk/outbound-call","href":"/api-reference/agents-platform/start-outbound-call-via-sip-trunk"}]},{"group":"Twilio","pages":[{"title":"Start outbound call via Twilio","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/twilio/outbound-call","href":"/api-reference/agents-platform/start-outbound-call-via-twilio"},{"title":"Register Twilio call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/twilio/register-call","href":"/api-reference/agents-platform/register-twilio-call"}]},{"group":"Exotel","pages":[{"title":"Start outbound call via Exotel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/exotel/outbound-call","href":"/api-reference/agents-platform/start-outbound-call-via-exotel"}]},{"group":"WhatsApp","pages":[{"title":"Start outbound call via WhatsApp","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/whatsapp/outbound-call","href":"/api-reference/agents-platform/start-outbound-call-via-whatsapp"},{"title":"Send outbound message via WhatsApp","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/whatsapp/outbound-message","href":"/api-reference/agents-platform/send-outbound-message-via-whatsapp"},{"title":"List WhatsApp accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/whatsapp-accounts","href":"/api-reference/agents-platform/list-whatsapp-accounts"},{"title":"Get WhatsApp account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/whatsapp-accounts/{phone_number_id}","href":"/api-reference/agents-platform/get-whatsapp-account"},{"title":"Update WhatsApp account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/whatsapp-accounts/{phone_number_id}","href":"/api-reference/agents-platform/update-whatsapp-account"},{"title":"Delete WhatsApp account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/whatsapp-accounts/{phone_number_id}","href":"/api-reference/agents-platform/delete-whatsapp-account"}]}]},{"group":"Batch calling","pages":[{"title":"List workspace batch calls","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/batch-calling/workspace","href":"/api-reference/agents-platform/list-workspace-batch-calls"},{"title":"Get batch call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/batch-calling/{batch_id}","href":"/api-reference/agents-platform/get-batch-call"},{"title":"Delete batch call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/batch-calling/{batch_id}","href":"/api-reference/agents-platform/delete-batch-call"},{"title":"Export batch call results","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/batch-calling/{batch_id}/export","href":"/api-reference/agents-platform/export-batch-call-results"},{"title":"Create batch call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/batch-calling/submit","href":"/api-reference/agents-platform/create-batch-call"},{"title":"Cancel batch call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/batch-calling/{batch_id}/cancel","href":"/api-reference/agents-platform/cancel-batch-call"},{"title":"Retry batch call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/batch-calling/{batch_id}/retry","href":"/api-reference/agents-platform/retry-batch-call"}]},{"group":"Models","pages":[{"title":"List available AI models","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/models","href":"/api-reference/agents-platform/list-available-ai-models"},{"title":"Get available AI model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/models/lookup","href":"/api-reference/agents-platform/get-available-ai-model"},{"title":"List available LLMs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/llm/list","href":"/api-reference/agents-platform/list-available-llms"},{"title":"Get the platform-managed LLM backup order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/llm/cascade-config","href":"/api-reference/agents-platform/get-the-platform-managed-llm-backup-order"},{"title":"Calculate expected LLM usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/llm-usage/calculate","href":"/api-reference/agents-platform/calculate-expected-llm-usage"},{"title":"Calculate expected LLM usage for an agent","openapi":"api-reference/openapi.json POST /v1/convai/agent/{agent_id}/llm-usage/calculate","href":"/api-reference/agents-platform/calculate-expected-llm-usage-for-an-agent"}]},{"group":"MCP","pages":[{"title":"Create MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/mcp-servers","href":"/api-reference/agents-platform/create-mcp-server"},{"title":"Delete MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/mcp-servers/{mcp_server_id}","href":"/api-reference/agents-platform/delete-mcp-server"},{"title":"List MCP servers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/mcp-servers","href":"/api-reference/agents-platform/list-mcp-servers"},{"title":"Get MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/mcp-servers/{mcp_server_id}","href":"/api-reference/agents-platform/get-mcp-server"},{"title":"List MCP server tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/mcp-servers/{mcp_server_id}/tools","href":"/api-reference/agents-platform/list-mcp-server-tools"},{"title":"Update MCP server configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/mcp-servers/{mcp_server_id}","href":"/api-reference/agents-platform/update-mcp-server-configuration"},{"group":"Tool approvals","pages":[{"title":"Create MCP server tool approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/mcp-servers/{mcp_server_id}/tool-approvals","href":"/api-reference/agents-platform/create-mcp-server-tool-approval"},{"title":"Delete MCP server tool approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/mcp-servers/{mcp_server_id}/tool-approvals/{tool_name}","href":"/api-reference/agents-platform/delete-mcp-server-tool-approval"}]},{"group":"Tool configuration","pages":[{"title":"Create MCP tool configuration override","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/mcp-servers/{mcp_server_id}/tool-configs","href":"/api-reference/agents-platform/create-mcp-tool-configuration-override"},{"title":"Get MCP tool configuration override","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}","href":"/api-reference/agents-platform/get-mcp-tool-configuration-override"},{"title":"Update MCP tool configuration override","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}","href":"/api-reference/agents-platform/update-mcp-tool-configuration-override"},{"title":"Delete MCP tool configuration override","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}","href":"/api-reference/agents-platform/delete-mcp-tool-configuration-override"}]}]},{"group":"Analytics","pages":[{"title":"Get live conversation count","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/analytics/live-count","href":"/api-reference/agents-platform/get-live-conversation-count"}]},{"group":"Environment variables","pages":[{"title":"List environment variables","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/environment-variables","href":"/api-reference/agents-platform/list-environment-variables"},{"title":"Create environment variable","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/environment-variables","href":"/api-reference/agents-platform/create-environment-variable"},{"title":"Get environment variable","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/environment-variables/{env_var_id}","href":"/api-reference/agents-platform/get-environment-variable"},{"title":"Update environment variable","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/convai/environment-variables/{env_var_id}","href":"/api-reference/agents-platform/update-environment-variable"},{"title":"Delete environment variable","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/environment-variables/{env_var_id}","href":"/api-reference/agents-platform/delete-environment-variable"}]},{"group":"Environments","pages":[{"title":"List environments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/convai/environments","href":"/api-reference/agents-platform/list-environments"},{"title":"Create environment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/environments","href":"/api-reference/agents-platform/create-environment"},{"title":"Delete environment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/convai/environments/{environment}","href":"/api-reference/agents-platform/delete-environment"}]},{"group":"Realtime","pages":[{"title":"Create realtime client secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/realtime/client_secrets","href":"/api-reference/realtime/create-realtime-client-secret"}]},{"group":"Outbound calls","pages":[{"title":"Start outbound call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/convai/outbound-call","href":"/api-reference/outbound-calls/start-outbound-call"}]}]},{"group":"Workspace","pages":[{"group":"Analytics","pages":[{"title":"Get workspace usage","deprecated":null,"version":null,"sidebarTitle":"Get workspace usage","openapi":"/api-reference/openapi.json post /v1/workspace/analytics/query/usage-by-product-over-time","href":"/api-reference/workspace/get-workspace-usage"},{"title":"List API requests","deprecated":null,"version":null,"sidebarTitle":"List api requests","openapi":"/api-reference/openapi.json post /v1/workspace/analytics/requests","href":"/api-reference/workspace/list-api-requests"}]},{"group":"User","pages":[{"title":"Get user info","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/user","href":"/api-reference/get-user-info"},{"title":"Get user subscription info","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/user/subscription","href":"/api-reference/get-user-subscription-info"}]},{"group":"Service accounts","pages":[{"title":"List workspace service accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/service-accounts","href":"/api-reference/workspace/list-workspace-service-accounts"},{"title":"Create workspace service account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/service-accounts","href":"/api-reference/workspace/create-workspace-service-account"},{"title":"List service account API keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/service-accounts/{service_account_user_id}/api-keys","href":"/api-reference/workspace/list-service-account-api-keys"},{"title":"Create service account API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/service-accounts/{service_account_user_id}/api-keys","href":"/api-reference/workspace/create-service-account-api-key"},{"title":"Update service account API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}","href":"/api-reference/workspace/update-service-account-api-key"},{"title":"Delete service account API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}","href":"/api-reference/workspace/delete-service-account-api-key"},{"title":"Disable service account API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}/disable","href":"/api-reference/workspace/disable-service-account-api-key"}]},{"group":"API keys","pages":[{"title":"Set workspace third-party disabling policy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workspaces/api-keys/third-party-disabling","href":"/api-reference/workspace/set-workspace-third-party-disabling-policy"},{"title":"Disable API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workspaces/api-keys/disable","href":"/api-reference/workspace/disable-api-key"}]},{"group":"Workspace","pages":[{"group":"Audit logs","pages":[{"title":"Get workspace audit logs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workspace/audit-logs","href":"/api-reference/workspace/get-workspace-audit-logs"}]},{"group":"Auth connections","pages":[{"title":"List workspace auth connections","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workspace/auth-connections","href":"/api-reference/workspace/list-workspace-auth-connections"},{"title":"Create workspace auth connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workspace/auth-connections","href":"/api-reference/workspace/create-workspace-auth-connection"},{"title":"Update workspace auth connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/workspace/auth-connections/{auth_connection_id}","href":"/api-reference/workspace/update-workspace-auth-connection"},{"title":"Delete workspace auth connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/workspace/auth-connections/{auth_connection_id}","href":"/api-reference/workspace/delete-workspace-auth-connection"}]},{"group":"Groups","pages":[{"title":"List workspace groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workspace/groups","href":"/api-reference/workspace/list-workspace-groups"},{"title":"Create workspace group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workspace/groups","href":"/api-reference/workspace/create-workspace-group"},{"title":"Update workspace group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/workspace/groups/{group_id}","href":"/api-reference/workspace/update-workspace-group"},{"title":"Delete workspace group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/workspace/groups/{group_id}","href":"/api-reference/workspace/delete-workspace-group"},{"title":"Search user groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workspace/groups/search","href":"/api-reference/workspace/search-user-groups"},{"title":"Add member to user group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workspace/groups/{group_id}/members","href":"/api-reference/workspace/add-member-to-user-group"},{"title":"Remove member from workspace group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workspace/groups/{group_id}/members/remove","href":"/api-reference/workspace/remove-member-from-workspace-group"}]},{"group":"Invitations","pages":[{"title":"Delete workspace invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/workspace/invites","href":"/api-reference/workspace/delete-workspace-invitation"},{"title":"Invite user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workspace/invites/add","href":"/api-reference/workspace/invite-user"},{"title":"Invite multiple users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workspace/invites/add-bulk","href":"/api-reference/workspace/invite-multiple-users"},{"title":"Resend workspace invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workspace/invites/resend","href":"/api-reference/workspace/resend-workspace-invitation"}]},{"group":"Members","pages":[{"title":"Get Workspace Members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workspace/members","href":"/api-reference/workspace/get-workspace-members"},{"title":"Update member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workspace/members","href":"/api-reference/workspace/update-member"}]},{"group":"Resources","pages":[{"title":"Get resource","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workspace/resources/{resource_id}","href":"/api-reference/workspace/get-resource"},{"title":"Share workspace resource","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workspace/resources/{resource_id}/share","href":"/api-reference/workspace/share-workspace-resource"},{"title":"Unshare workspace resource","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workspace/resources/{resource_id}/unshare","href":"/api-reference/workspace/unshare-workspace-resource"}]}]},{"group":"Webhooks","pages":[{"title":"List workspace webhooks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workspace/webhooks","href":"/api-reference/workspace/list-workspace-webhooks"},{"title":"Create workspace webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workspace/webhooks","href":"/api-reference/workspace/create-workspace-webhook"},{"title":"Update workspace webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/workspace/webhooks/{webhook_id}","href":"/api-reference/workspace/update-workspace-webhook"},{"title":"Delete workspace webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/workspace/webhooks/{webhook_id}","href":"/api-reference/workspace/delete-workspace-webhook"}]}]},{"group":"Shared resources","pages":[{"group":"Voices","pages":[{"title":"List my voices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/voices","href":"/api-reference/voices/list-my-voices"},{"title":"Get a saved voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/voices/{voice_id}","href":"/api-reference/voices/get-a-saved-voice"},{"title":"Add voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/voices/add","href":"/api-reference/voices/add-voice"},{"group":"Professional voice cloning","pages":[{"title":"Create PVC voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/voices/pvc","href":"/api-reference/voices/create-pvc-voice"},{"title":"Edit PVC voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/voices/pvc/{voice_id}","href":"/api-reference/voices/edit-pvc-voice"},{"title":"Add samples to PVC voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/voices/pvc/{voice_id}/samples","href":"/api-reference/voices/add-samples-to-pvc-voice"},{"title":"Update PVC voice sample","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/voices/pvc/{voice_id}/samples/{sample_id}","href":"/api-reference/voices/update-pvc-voice-sample"},{"title":"Delete PVC voice sample","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/voices/pvc/{voice_id}/samples/{sample_id}","href":"/api-reference/voices/delete-pvc-voice-sample"},{"title":"Retrieve voice sample audio","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/voices/pvc/{voice_id}/samples/{sample_id}/audio","href":"/api-reference/voices/retrieve-voice-sample-audio"},{"title":"Retrieve voice sample visual waveform","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/voices/pvc/{voice_id}/samples/{sample_id}/waveform","href":"/api-reference/voices/retrieve-voice-sample-visual-waveform"},{"title":"Retrieve speaker separation status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/voices/pvc/{voice_id}/samples/{sample_id}/speakers","href":"/api-reference/voices/retrieve-speaker-separation-status"},{"title":"Start speaker separation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/voices/pvc/{voice_id}/samples/{sample_id}/separate-speakers","href":"/api-reference/voices/start-speaker-separation"},{"title":"Retrieve separated speaker audio","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/voices/pvc/{voice_id}/samples/{sample_id}/speakers/{speaker_id}/audio","href":"/api-reference/voices/retrieve-separated-speaker-audio"},{"title":"Get PVC voice captcha","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/voices/pvc/{voice_id}/captcha","href":"/api-reference/voices/get-pvc-voice-captcha"},{"title":"Verify PVC voice captcha","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/voices/pvc/{voice_id}/captcha","href":"/api-reference/voices/verify-pvc-voice-captcha"},{"title":"Run PVC training","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/voices/pvc/{voice_id}/train","href":"/api-reference/voices/run-pvc-training"},{"title":"Request manual verification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/voices/pvc/{voice_id}/verification","href":"/api-reference/voices/request-manual-verification"}]}]}]}]}]},"basePath":"","title":"Cancel a test invocation - Threetone Documentation","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}