{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hamsa API","colors":{"primary":"#1B5E3A","light":"#B4FD83","dark":"#2D7A4F"},"logo":{"light":"https://mintcdn.com/hamsa-452fa79a/B5KuRhzUCER4_1Wi/logo/hamsa_logo_light.svg?fit=max\u0026auto=format\u0026n=B5KuRhzUCER4_1Wi\u0026q=85\u0026s=2576c2f27fed68b31fa686aca13e6fbf","dark":"https://mintcdn.com/hamsa-452fa79a/B5KuRhzUCER4_1Wi/logo/hamsa_logo_dark.svg?fit=max\u0026auto=format\u0026n=B5KuRhzUCER4_1Wi\u0026q=85\u0026s=b89ad21e4d97ee72de3045482602bf53"},"favicon":"https://mintcdn.com/hamsa-452fa79a/B5KuRhzUCER4_1Wi/favicon.svg?fit=max\u0026auto=format\u0026n=B5KuRhzUCER4_1Wi\u0026q=85\u0026s=f369c0501b06a15339575e7c72e2494a","navbar":{"links":[{"href":"https://tryhamsa.com/contact/","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://agents.tryhamsa.com/"}},"footer":{"socials":{"github":"https://github.com/hamsa-ai","linkedin":"https://www.linkedin.com/company/tryhamsa","website":"https://tryhamsa.com"}},"integrations":{"posthog":{"apiKey":"phc_3TCeimn6ufgVchZQ08TCRlIfu7Lwyaa8xGtBA67ym66","sessionRecording":false}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hamsa-452fa79a","hasAudioNarration":false,"actualSubdomain":"hamsa-452fa79a","customDomains":["docs.tryhamsa.com"],"gitSource":{"type":"github","owner":"hamsa-dev","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aba7d75e5024a36fdb35844","collectionId":"530fa5de-69cb-481c-80ed-ee186974aa4b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aba7d75e5024a36fdb35844"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aba7d75e5024a36fdb35844","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"API Reference","count":103},{"language":"default","tag":"Agents Platform","count":77},{"language":"default","tag":"Agents","count":25},{"language":"default","tag":"Overview","count":20},{"language":"default","tag":"Flow Agent","count":18},{"language":"default","tag":"Media Platform","count":15},{"language":"default","tag":"Variables","count":13},{"language":"default","tag":"Developers","count":13},{"language":"default","tag":"Web Tools Routes","count":12},{"language":"default","tag":"Nodes","count":11}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navbar>div>div>div>div:nth-child(3)>div{display:none!important}[data-theme=\"light\"] nav a[aria-current=\"page\"],[data-theme=\"light\"] nav a.active,[data-theme=\"light\"] .sidebar a[aria-current=\"page\"],[data-theme=\"light\"] .sidebar a.active,[data-theme=\"light\"] [style*=\"background\"][style*=\"#B4FD83\"],[data-theme=\"light\"] [style*=\"background\"][style*=\"rgb(180, 253, 131)\"]{background-color:#2D7A4F!important;color:#ffffff!important}[data-theme=\"dark\"] nav a[aria-current=\"page\"],[data-theme=\"dark\"] nav a.active,[data-theme=\"dark\"] .sidebar a[aria-current=\"page\"],[data-theme=\"dark\"] .sidebar a.active,[data-theme=\"dark\"] [style*=\"background\"][style*=\"#B4FD83\"],[data-theme=\"dark\"] [style*=\"background\"][style*=\"rgb(180, 253, 131)\"]{background-color:#B4FD83!important;color:#1a1a1a!important}[data-theme=\"light\"] button[class*=\"primary\"],[data-theme=\"light\"] .btn-primary{background-color:#2D7A4F!important;color:#ffffff!important}[data-theme=\"dark\"] button[class*=\"primary\"],[data-theme=\"dark\"] .btn-primary{background-color:#B4FD83!important;color:#1a1a1a!important}"}],"page":{"pagePath":"api-reference/endpoint/test-api-tool","slug":"/api-reference/endpoint/test-api-tool","pageMetadata":{"title":"Test API Tool Configuration","description":"Validates API connectivity with retry logic and streams real-time test results via Server-Sent Events.","deprecated":null,"version":null,"sidebarTitle":"Test api tool","openapi":"/api-reference/openapi.json post /v1/voice-agents/web-tool/test-api-tool","href":"/api-reference/endpoint/test-api-tool","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: \"Validates API connectivity with retry logic and streams real-time test results via Server-Sent Events.\"\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":"Test API Tool Configuration","description":"Validates API connectivity with retry logic and streams real-time test results via Server-Sent Events.","deprecated":null,"version":null,"sidebarTitle":"Test api tool","openapi":"/api-reference/openapi.json post /v1/voice-agents/web-tool/test-api-tool","href":"/api-reference/endpoint/test-api-tool","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Test API Tool connectivity and validate configuration.","description":"Validates API connectivity with retry logic and streams real-time test results via Server-Sent Events.","requestBody":"ea27a1a3-abbe-49b7-8dfa-178e0959db25","responses":{"200":"8240d1c3-26c1-4846-8187-c8424ad84bfd","400":"b44bf04d-0a84-4ea0-9779-d0e36001385a","401":"3dfb55ef-45db-4ef8-92c4-9cc370f8e9ad","500":"677a63f0-a2e3-4cac-bdaf-3e6a546b632e"},"security":["fc7a48be-9766-4722-8f0a-e10d04c96ea7"],"x-mint":{"metadata":{"title":"Test API Tool Configuration"},"href":"/api-reference/endpoint/test-api-tool"},"method":"post","type":"path","servers":["ff17730e-9c86-4caa-bbcc-7af173285799"],"path":"/v1/voice-agents/web-tool/test-api-tool","baseUrlOptions":["https://api.tryhamsa.com"],"title":"Test API Tool connectivity and validate configuration.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string","format":"uuid","description":"UUID of the project.","example":"d949f13f-40d2-4e48-ac86-b66633070603","isRequired":true,"uniqueKey":"projectId","typeLabel":"string\u003cuuid>"},"serverUrl":{"type":"string","format":"uri","description":"The API endpoint URL to test. Must be a valid external URL.","example":"https://api.example.com/endpoint","isRequired":true,"uniqueKey":"serverUrl","typeLabel":"string\u003curi>"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"description":"HTTP method to use for the API call.","example":"POST","isRequired":true,"uniqueKey":"method","typeLabel":"enum\u003cstring>"},"apiKey":{"type":"string","format":"uuid","description":"API key UUID (optional).","example":"d949f13f-40d2-4e48-ac86-b66633070603","uniqueKey":"apiKey","typeLabel":"string\u003cuuid>"},"userId":{"type":"string","format":"uuid","description":"UUID of the user (optional).","example":"d949f13f-40d2-4e48-ac86-b66633070603","uniqueKey":"userId","typeLabel":"string\u003cuuid>"},"authPrefix":{"type":"string","description":"Authorization header prefix (e.g., 'Bearer', 'Basic').","example":"Bearer","uniqueKey":"authPrefix","typeLabel":"string"},"authToken":{"type":"string","description":"Authentication token to include in the request.","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...","uniqueKey":"authToken","typeLabel":"string"},"timeout":{"type":"number","minimum":1,"maximum":15,"default":5,"description":"Request timeout in seconds (1-15 seconds).","example":5,"uniqueKey":"timeout","typeLabel":"number"},"httpHeaders":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"httpHeaders.additionalProperties","typeLabel":"string"},"description":"Custom HTTP headers to include in the request.","example":{"Content-Type":"application/json","X-Custom-Header":"value"},"uniqueKey":"httpHeaders","typeLabel":"object"},"queryParams":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"queryParams.additionalProperties","typeLabel":"string"},"description":"Query parameters to append to the URL.","example":{"filter":"active","limit":"10"},"uniqueKey":"queryParams","typeLabel":"object"},"body":{"oneOf":[{"type":"string","description":"Request body (max 10MB). Can be string, number, boolean, object, array, or null.","example":{"name":"Test","value":123},"uniqueKey":"body.oneOf.0","typeLabel":"string"},{"type":"number","description":"Request body (max 10MB). Can be string, number, boolean, object, array, or null.","example":{"name":"Test","value":123},"uniqueKey":"body.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Request body (max 10MB). Can be string, number, boolean, object, array, or null.","example":{"name":"Test","value":123},"uniqueKey":"body.oneOf.2","typeLabel":"boolean"},{"type":"object","description":"Request body (max 10MB). Can be string, number, boolean, object, array, or null.","example":{"name":"Test","value":123},"uniqueKey":"body.oneOf.3","typeLabel":"object"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"body.oneOf.4.items.[INDEX]","typeLabel":"any"},"description":"Request body (max 10MB). Can be string, number, boolean, object, array, or null.","example":{"name":"Test","value":123},"uniqueKey":"body.oneOf.4","typeLabel":"any[]"},{"type":"null","uniqueKey":"body.oneOf.5","typeLabel":"null"}],"uniqueKey":"body","typeLabel":"string | number | boolean | object | any[] | null"}},"required":["projectId","serverUrl","method"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"projectId":"d949f13f-40d2-4e48-ac86-b66633070603","serverUrl":"https://api.example.com/endpoint","method":"POST","apiKey":"d949f13f-40d2-4e48-ac86-b66633070603","userId":"d949f13f-40d2-4e48-ac86-b66633070603","authPrefix":"Bearer","authToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...","timeout":5,"httpHeaders":{"Content-Type":"application/json","X-Custom-Header":"value"},"queryParams":{"filter":"active","limit":"10"},"body":{"name":"Test","value":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8240d1c3-26c1-4846-8187-c8424ad84bfd":{"description":"Server-Sent Events stream with test results","content":{"text/event-stream":{"schema":{"type":"object","description":"Server-Sent Events stream containing test results. Events include: 'connected', 'attempt', 'complete', and 'error'.","properties":{"event":{"type":"string","enum":["connected","attempt","complete","error"],"description":"Type of SSE event.","example":"attempt","uniqueKey":"event","typeLabel":"enum\u003cstring>"},"data":{"oneOf":[{"type":"object","properties":{"message":{"type":"string","example":"Starting API test...","uniqueKey":"data.oneOf.0.message","typeLabel":"string"}},"uniqueKey":"data.oneOf.0","typeLabel":"object"},{"type":"object","properties":{"attempt":{"type":"number","description":"The attempt number.","example":1,"uniqueKey":"data.oneOf.1.attempt","typeLabel":"number"},"success":{"type":"boolean","description":"Whether this attempt was successful.","example":true,"uniqueKey":"data.oneOf.1.success","typeLabel":"boolean"},"statusCode":{"type":"number","description":"HTTP status code received.","example":200,"uniqueKey":"data.oneOf.1.statusCode","typeLabel":"number"},"data":{"description":"Response data from the API call.","example":{"result":"success"},"uniqueKey":"data.oneOf.1.data","typeLabel":"any"},"headers":{"type":"object","description":"Response headers received.","example":{"content-type":"application/json"},"uniqueKey":"data.oneOf.1.headers","typeLabel":"object"},"error":{"type":"string","description":"Error message if the attempt failed.","example":null,"uniqueKey":"data.oneOf.1.error","typeLabel":"string"},"responseTime":{"type":"number","description":"Response time in milliseconds.","example":245,"uniqueKey":"data.oneOf.1.responseTime","typeLabel":"number"}},"uniqueKey":"data.oneOf.1","typeLabel":"object"},{"type":"object","properties":{"message":{"type":"string","example":"API test completed","uniqueKey":"data.oneOf.2.message","typeLabel":"string"},"result":{"type":"object","properties":{"attempt":{"type":"number","description":"The attempt number.","example":1,"uniqueKey":"data.oneOf.2.result.attempt","typeLabel":"number"},"success":{"type":"boolean","description":"Whether this attempt was successful.","example":true,"uniqueKey":"data.oneOf.2.result.success","typeLabel":"boolean"},"statusCode":{"type":"number","description":"HTTP status code received.","example":200,"uniqueKey":"data.oneOf.2.result.statusCode","typeLabel":"number"},"data":{"description":"Response data from the API call.","example":{"result":"success"},"uniqueKey":"data.oneOf.2.result.data","typeLabel":"any"},"headers":{"type":"object","description":"Response headers received.","example":{"content-type":"application/json"},"uniqueKey":"data.oneOf.2.result.headers","typeLabel":"object"},"error":{"type":"string","description":"Error message if the attempt failed.","example":null,"uniqueKey":"data.oneOf.2.result.error","typeLabel":"string"},"responseTime":{"type":"number","description":"Response time in milliseconds.","example":245,"uniqueKey":"data.oneOf.2.result.responseTime","typeLabel":"number"}},"uniqueKey":"data.oneOf.2.result","typeLabel":"object"}},"uniqueKey":"data.oneOf.2","typeLabel":"object"},{"type":"object","properties":{"message":{"type":"string","example":"An error occurred during testing","uniqueKey":"data.oneOf.3.message","typeLabel":"string"}},"uniqueKey":"data.oneOf.3","typeLabel":"object"}],"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"event":"attempt","data":{"message":"Starting API test..."}}}},"exampleType":"generated"}},"exampleType":"generated"},"b44bf04d-0a84-4ea0-9779-d0e36001385a":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"3dfb55ef-45db-4ef8-92c4-9cc370f8e9ad":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"677a63f0-a2e3-4cac-bdaf-3e6a546b632e":{"description":"Server Side Error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"fc7a48be-9766-4722-8f0a-e10d04c96ea7":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token \u003capi-key>'","scopes":[]}}},"servers":{"ff17730e-9c86-4caa-bbcc-7af173285799":{"url":"https://api.tryhamsa.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token \u003capi-key>'","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token \u003capi-key>'","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"hamsa-452fa79a","siteName":"Hamsa API","title":"Test API Tool Configuration - Hamsa API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-04T14:43:26.700Z","originalFileLocation":"api-reference/endpoint/test-api-tool.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=\"Validates API connectivity with retry logic and streams real-time test results via Server-Sent Events.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hamsa 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/hamsa-452fa79a/11pr1mz1Eztynfhz/_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/hamsa-452fa79a/11pr1mz1Eztynfhz/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hamsa-452fa79a/11pr1mz1Eztynfhz/_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/hamsa-452fa79a/11pr1mz1Eztynfhz/_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/hamsa-452fa79a/11pr1mz1Eztynfhz/_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/hamsa-452fa79a/11pr1mz1Eztynfhz/_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/hamsa-452fa79a/11pr1mz1Eztynfhz/_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/hamsa-452fa79a/11pr1mz1Eztynfhz/_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/hamsa-452fa79a/11pr1mz1Eztynfhz/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Test API Tool Configuration - Hamsa API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Validates API connectivity with retry logic and streams real-time test results via Server-Sent Events.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hamsa API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tryhamsa.com/api-reference/endpoint/test-api-tool\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hamsa-452fa79a.mintlify.site/_mintlify/api/og/v2?division=Web+Tools+Routes\u0026amp;title=Test+API+Tool+Configuration\u0026amp;description=Validates+API+connectivity+with+retry+logic+and+streams+real-time+test+results+via+Server-Sent+Events.\u0026amp;theme=36084cdf444b71ec535ab394\u0026amp;signature=eaa7bdb1be36e04716dc82a5f78871f046cd67d790eded6cce48926a51da5594\">\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=\"Test API Tool Configuration - Hamsa API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Validates API connectivity with retry logic and streams real-time test results via Server-Sent Events.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hamsa-452fa79a.mintlify.site/_mintlify/api/og/v2?division=Web+Tools+Routes\u0026amp;title=Test+API+Tool+Configuration\u0026amp;description=Validates+API+connectivity+with+retry+logic+and+streams+real-time+test+results+via+Server-Sent+Events.\u0026amp;theme=36084cdf444b71ec535ab394\u0026amp;signature=eaa7bdb1be36e04716dc82a5f78871f046cd67d790eded6cce48926a51da5594\">\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/hamsa-452fa79a/11pr1mz1Eztynfhz/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hamsa API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1B5E3A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tryhamsa.com/api-reference/endpoint/test-api-tool\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/test-api-tool.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tryhamsa.com/#organization\",\"name\":\"Hamsa API\",\"url\":\"https://docs.tryhamsa.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hamsa-452fa79a/B5KuRhzUCER4_1Wi/logo/hamsa_logo_light.svg?fit=max\u0026auto=format\u0026n=B5KuRhzUCER4_1Wi\u0026q=85\u0026s=2576c2f27fed68b31fa686aca13e6fbf\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tryhamsa.com#website\",\"name\":\"Hamsa API\",\"url\":\"https://docs.tryhamsa.com\",\"publisher\":{\"@id\":\"https://docs.tryhamsa.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tryhamsa.com/api-reference/endpoint/test-api-tool#webpage\",\"url\":\"https://docs.tryhamsa.com/api-reference/endpoint/test-api-tool\",\"name\":\"Test API Tool Configuration\",\"description\":\"Validates API connectivity with retry logic and streams real-time test results via Server-Sent Events.\",\"dateModified\":\"2026-08-04T14:43:26.700Z\",\"isPartOf\":{\"@id\":\"https://docs.tryhamsa.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tryhamsa.com/api-reference/endpoint/test-api-tool#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tryhamsa.com/api-reference/endpoint/test-api-tool#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Web Tools Routes\",\"item\":\"https://docs.tryhamsa.com/api-reference/get-a-web-tool-by-id\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Test API Tool Configuration\",\"item\":\"https://docs.tryhamsa.com/api-reference/endpoint/test-api-tool\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tryhamsa.com/api-reference/endpoint/test-api-tool#apireference\",\"headline\":\"Test API Tool Configuration\",\"name\":\"Test API Tool Configuration\",\"description\":\"Validates API connectivity with retry logic and streams real-time test results via Server-Sent Events.\",\"url\":\"https://docs.tryhamsa.com/api-reference/endpoint/test-api-tool\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tryhamsa.com/api-reference/endpoint/test-api-tool#webpage\"},\"dateModified\":\"2026-08-04T14:43:26.700Z\",\"publisher\":{\"@id\":\"https://docs.tryhamsa.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tryhamsa.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hamsa API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Hamsa API","nav":{"global":null,"tabs":[{"tab":"Overview","icon":"list-timeline","pages":[{"title":"Overview","href":"/overview/introduction"}]},{"tab":"Text to Speech","icon":"message-waveform","pages":[{"title":"Text to Speech","href":"/text-to-speech/introduction"}]},{"tab":"Speech to Text","icon":"head-side-speak","pages":[{"title":"Speech to Text","href":"/speech-to-text/introduction"}]},{"tab":"Agents Platform","icon":"user-robot","pages":[{"title":"Agents Platform","href":"/agents/dashboard/introduction"}]},{"tab":"Media Platform","icon":"photo-film-music","pages":[{"title":"Media Platform","href":"/media/introduction"}]},{"tab":"Developers","icon":"square-terminal","pages":[{"title":"Developers","href":"/developers/apis/quick-start"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Speech-to-Text Routes","pages":[]},{"group":"Text to Speech Routes","pages":[{"title":"Generate Text to Speech Route","deprecated":null,"version":null,"sidebarTitle":"Generate tts","openapi":"/api-reference/openapi.json post /v1/jobs/text-to-speech","href":"/api-reference/endpoint/generate-tts"},{"title":"Preload Cloned TTS Voice","deprecated":null,"version":null,"sidebarTitle":"Preload cloned tts voice","openapi":"/api-reference/openapi.json post /v2/tts/voices/custom/preload","href":"/api-reference/endpoint/preload-cloned-tts-voice"},{"title":"Create TTS history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/tts/histories","href":"/api-reference/create-tts-history"},{"title":"List TTS histories","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/tts/histories","href":"/api-reference/list-tts-histories"},{"title":"Get TTS history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/tts/histories/{id}","href":"/api-reference/get-tts-history"},{"title":"Delete TTS history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v2/tts/histories/{id}","href":"/api-reference/delete-tts-history"}]},{"group":"Real Time Routes","pages":[{"title":"Generate Text to Speech File Data","deprecated":null,"version":null,"sidebarTitle":"Rt generate tts","openapi":"/api-reference/openapi.json post /v1/realtime/tts","href":"/api-reference/endpoint/rt-generate-tts"},{"title":"Generate Streamed Text to Speech File Data","deprecated":null,"version":null,"sidebarTitle":"Rt generate tts stream","openapi":"/api-reference/openapi.json post /v1/realtime/tts-stream","href":"/api-reference/endpoint/rt-generate-tts-stream"},{"title":"Generate Speech to Text Transcription","deprecated":null,"version":null,"sidebarTitle":"Rt generate stt","openapi":"/api-reference/openapi.json post /v1/realtime/stt","href":"/api-reference/endpoint/rt-generate-stt"}]},{"group":"Phone Numbers Routes","pages":[{"title":"Add Phone Number to a User Route","deprecated":null,"version":null,"sidebarTitle":"Add phone number","openapi":"/api-reference/openapi.json post /v1/voice-agents/phone-number","href":"/api-reference/endpoint/add-phone-number"},{"title":"Get Phone Number by its ID Route","deprecated":null,"version":null,"sidebarTitle":"Get phone number","openapi":"/api-reference/openapi.json get /v1/voice-agents/phone-number","href":"/api-reference/endpoint/get-phone-number"},{"title":"Delete Phone Number","deprecated":null,"version":null,"sidebarTitle":"Delete phone number","openapi":"/api-reference/openapi.json delete /v1/voice-agents/phone-number","href":"/api-reference/endpoint/delete-phone-number"},{"title":"Assign Phone Number to a Voice Agent Route","deprecated":null,"version":null,"sidebarTitle":"Assign phone number","openapi":"/api-reference/openapi.json post /v1/voice-agents/assign-number","href":"/api-reference/endpoint/assign-phone-number"},{"title":"Unassign Phone Number to a Voice Agent Route","deprecated":null,"version":null,"sidebarTitle":"Unassign phone number","openapi":"/api-reference/openapi.json post /v1/voice-agents/unassign","href":"/api-reference/endpoint/unassign-phone-number"},{"title":"List User Phone Numbers Route","deprecated":null,"version":null,"sidebarTitle":"List phone numbers","openapi":"/api-reference/openapi.json get /v1/voice-agents/phone-number/list","href":"/api-reference/endpoint/list-phone-numbers"},{"title":"Create an Outbound Call","deprecated":null,"version":null,"sidebarTitle":"Call phone number","openapi":"/api-reference/openapi.json post /v1/voice-agents/phone-number/call","href":"/api-reference/endpoint/call-phone-number"}]},{"group":"Voice Agents Routes","pages":[{"title":"Clone Voice Agent Route","deprecated":null,"version":null,"sidebarTitle":"Clone voice agent","openapi":"/api-reference/openapi.json post /v1/voice-agents/clone","href":"/api-reference/endpoint/clone-voice-agent"},{"title":"Create Voice Agent","deprecated":null,"version":null,"sidebarTitle":"Create voice agent v2","openapi":"/api-reference/openapi.json post /v2/voice-agents","href":"/api-reference/endpoint/create-voice-agent-v2"},{"title":"List Voice Agents","deprecated":null,"version":null,"sidebarTitle":"List voice agents v2","openapi":"/api-reference/openapi.json get /v2/voice-agents","href":"/api-reference/endpoint/list-voice-agents-v2"},{"title":"Get Voice Agent","deprecated":null,"version":null,"sidebarTitle":"Get voice agent v2","openapi":"/api-reference/openapi.json get /v2/voice-agents/{voiceAgentId}","href":"/api-reference/endpoint/get-voice-agent-v2"},{"title":"Update Voice Agent","deprecated":null,"version":null,"sidebarTitle":"Update voice agent v2","openapi":"/api-reference/openapi.json patch /v2/voice-agents/{voiceAgentId}","href":"/api-reference/endpoint/update-voice-agent-v2"}]},{"group":"Voice Cloning","pages":[{"title":"List TTS voices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/tts/voices","href":"/api-reference/list-tts-voices"},{"title":"Create TTS voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/tts/voices","href":"/api-reference/create-tts-voice"},{"title":"List dialects","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/tts/dialects","href":"/api-reference/list-dialects"},{"title":"Favorite a TTS voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/tts/voices/{id}/favourite","href":"/api-reference/favorite-a-tts-voice"},{"title":"Delete TTS voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v2/tts/voices/{id}","href":"/api-reference/delete-tts-voice"},{"title":"Get TTS voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/tts/voices/{id}","href":"/api-reference/get-tts-voice"},{"title":"Preview TTS voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/tts/voices/preview","href":"/api-reference/preview-tts-voice"},{"title":"Get default TTS voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/tts/voices/default/current","href":"/api-reference/get-default-tts-voice"},{"title":"Extract transcription from voice audio","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/tts/voices/extract-transcription","href":"/api-reference/extract-transcription-from-voice-audio"}]},{"group":"Call Conversations","pages":[{"title":"List Call Records (Minimal)","deprecated":null,"version":null,"sidebarTitle":"List minimal calls","openapi":"/api-reference/openapi.json get /v1/voice-agents/conversations/minimal-list","href":"/api-reference/endpoint/list-minimal-calls"},{"title":"Get Conversation by ID","deprecated":null,"version":null,"sidebarTitle":"Get conversation","openapi":"/api-reference/openapi.json get /v1/voice-agents/conversation/{conversationId}","href":"/api-reference/endpoint/get-conversation"},{"title":"Terminate Conversation","deprecated":null,"version":null,"sidebarTitle":"Terminate conversation","openapi":"/api-reference/openapi.json get /v1/voice-agents/conversation/{conversationId}/terminate","href":"/api-reference/endpoint/terminate-conversation"}]},{"group":"Outbound Campaigns","pages":[{"title":"Create Campaign","deprecated":null,"version":null,"sidebarTitle":"Create campaign","openapi":"/api-reference/openapi.json post /v1/voice-agents/campaigns","href":"/api-reference/endpoint/create-campaign"},{"title":"List Campaigns","deprecated":null,"version":null,"sidebarTitle":"List campaigns","openapi":"/api-reference/openapi.json get /v1/voice-agents/campaigns","href":"/api-reference/endpoint/list-campaigns"},{"title":"Get Campaign by ID","deprecated":null,"version":null,"sidebarTitle":"Get campaign","openapi":"/api-reference/openapi.json get /v1/voice-agents/campaigns/{id}","href":"/api-reference/endpoint/get-campaign"},{"title":"Update Campaign Name","deprecated":null,"version":null,"sidebarTitle":"Update campaign","openapi":"/api-reference/openapi.json patch /v1/voice-agents/campaigns/{id}","href":"/api-reference/endpoint/update-campaign"},{"title":"Delete Campaign","deprecated":null,"version":null,"sidebarTitle":"Delete campaign","openapi":"/api-reference/openapi.json delete /v1/voice-agents/campaigns/{id}","href":"/api-reference/endpoint/delete-campaign"},{"title":"Cancel Campaign","deprecated":null,"version":null,"sidebarTitle":"Cancel campaign","openapi":"/api-reference/openapi.json post /v1/voice-agents/campaigns/{id}/cancel","href":"/api-reference/endpoint/cancel-campaign"},{"title":"Retry Campaign","deprecated":null,"version":null,"sidebarTitle":"Retry campaign","openapi":"/api-reference/openapi.json post /v1/voice-agents/campaigns/{id}/retry","href":"/api-reference/endpoint/retry-campaign"},{"title":"Pause Campaign","deprecated":null,"version":null,"sidebarTitle":"Pause campaign","openapi":"/api-reference/openapi.json post /v1/voice-agents/campaigns/{id}/pause","href":"/api-reference/endpoint/pause-campaign"},{"title":"Resume Campaign","deprecated":null,"version":null,"sidebarTitle":"Resume campaign","openapi":"/api-reference/openapi.json post /v1/voice-agents/campaigns/{id}/resume","href":"/api-reference/endpoint/resume-campaign"}]},{"group":"Dictionaries","pages":[{"title":"Create Voice Dictionary","deprecated":null,"version":null,"sidebarTitle":"Create voice dictionary","openapi":"/api-reference/openapi.json post /v1/voice-agents/voice-dictionaries","href":"/api-reference/endpoint/create-voice-dictionary"},{"title":"List Voice Dictionaries","deprecated":null,"version":null,"sidebarTitle":"List voice dictionaries","openapi":"/api-reference/openapi.json get /v1/voice-agents/voice-dictionaries/list","href":"/api-reference/endpoint/list-voice-dictionaries"},{"title":"Get Voice Dictionary by ID","deprecated":null,"version":null,"sidebarTitle":"Get voice dictionary","openapi":"/api-reference/openapi.json get /v1/voice-agents/voice-dictionaries/{id}","href":"/api-reference/endpoint/get-voice-dictionary"},{"title":"Update Voice Dictionary","deprecated":null,"version":null,"sidebarTitle":"Update voice dictionary","openapi":"/api-reference/openapi.json patch /v1/voice-agents/voice-dictionaries/{id}","href":"/api-reference/endpoint/update-voice-dictionary"},{"title":"Toggle Voice Dictionary Activation","deprecated":null,"version":null,"sidebarTitle":"Toggle voice dictionary activation","openapi":"/api-reference/openapi.json post /v1/voice-agents/voice-dictionaries/toggle-activation","href":"/api-reference/endpoint/toggle-voice-dictionary-activation"}]},{"group":"Knowledge Base Routes","pages":[{"title":"Create new knowledge base items.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/voice-agents/knowledge-base","href":"/api-reference/create-new-knowledge-base-items"},{"title":"Update a knowledge base item by Id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/voice-agents/knowledge-base/{id}","href":"/api-reference/update-a-knowledge-base-item-by-id"},{"title":"Delete Knowledge Base Item","deprecated":null,"version":null,"sidebarTitle":"Delete kb item","openapi":"/api-reference/openapi.json delete /v1/voice-agents/knowledge-base/{id}","href":"/api-reference/endpoint/delete-kb-item"},{"title":"Get Knowledge Base Item by ID","deprecated":null,"version":null,"sidebarTitle":"Get kb item","openapi":"/api-reference/openapi.json get /v1/voice-agents/knowledge-base/{id}","href":"/api-reference/endpoint/get-kb-item"},{"title":"Return a list of Knowledge Base Items.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/voice-agents/knowledge-base/list","href":"/api-reference/return-a-list-of-knowledge-base-items"},{"title":"Toggle activation of a knowledge base item for a voice agent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/voice-agents/knowledge-base/toggle-activation","href":"/api-reference/toggle-activation-of-a-knowledge-base-item-for-a-voice-agent"},{"title":"Get Knowledge Base Size Info","deprecated":null,"version":null,"sidebarTitle":"Get kb size info","openapi":"/api-reference/openapi.json get /v1/voice-agents/knowledge-base/size-info","href":"/api-reference/endpoint/get-kb-size-info"},{"title":"Add URL to Knowledge Base Item","deprecated":null,"version":null,"sidebarTitle":"Add url to kb item","openapi":"/api-reference/openapi.json post /v1/voice-agents/knowledge-base/{id}/url","href":"/api-reference/endpoint/add-url-to-kb-item"},{"title":"Delete URL from Knowledge Base Item","deprecated":null,"version":null,"sidebarTitle":"Delete url from kb item","openapi":"/api-reference/openapi.json delete /v1/voice-agents/knowledge-base/{id}/url","href":"/api-reference/endpoint/delete-url-from-kb-item"}]},{"group":"Collections","pages":[{"title":"List Collections","deprecated":null,"version":null,"sidebarTitle":"List collections","openapi":"/api-reference/openapi.json get /v1/voice-agents/collections/list","href":"/api-reference/endpoint/list-collections"},{"title":"Create Collection","deprecated":null,"version":null,"sidebarTitle":"Create collection","openapi":"/api-reference/openapi.json post /v1/voice-agents/collections","href":"/api-reference/endpoint/create-collection"},{"title":"Update Collection","deprecated":null,"version":null,"sidebarTitle":"Update collection","openapi":"/api-reference/openapi.json patch /v1/voice-agents/collections/{id}","href":"/api-reference/endpoint/update-collection"},{"title":"Delete Collection","deprecated":null,"version":null,"sidebarTitle":"Delete collection","openapi":"/api-reference/openapi.json delete /v1/voice-agents/collections/{id}","href":"/api-reference/endpoint/delete-collection"},{"title":"Move Web Tool to Collection","deprecated":null,"version":null,"sidebarTitle":"Move tool to collection","openapi":"/api-reference/openapi.json post /v1/voice-agents/collections/move","href":"/api-reference/endpoint/move-tool-to-collection"}]},{"group":"Web Tools Routes","pages":[{"title":"Get a web tool by ID.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/voice-agents/web-tool/{id}","href":"/api-reference/get-a-web-tool-by-id"},{"title":"Delete a web tool by Id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/voice-agents/web-tool/{id}","href":"/api-reference/delete-a-web-tool-by-id"},{"title":"Toggle activation of a web tool for a voice agent.","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/voice-agents/web-tool/toggle-activation","href":"/api-reference/toggle-activation-of-a-web-tool-for-a-voice-agent"},{"title":"Test API Tool Configuration","deprecated":null,"version":null,"sidebarTitle":"Test api tool","openapi":"/api-reference/openapi.json post /v1/voice-agents/web-tool/test-api-tool","href":"/api-reference/endpoint/test-api-tool"},{"title":"Create Web Tool","description":"Creates a new web tool for a project. Web tools can be of type FUNCTION, MCP, or WEB_TOOL.","deprecated":null,"version":null,"sidebarTitle":"Create web tool","openapi":"/api-reference/openapi.json post /v2/voice-agents/web-tool","href":"/api-reference/endpoint/v2/create-web-tool"},{"title":"List Web Tools","deprecated":null,"version":null,"sidebarTitle":"List web tools","openapi":"/api-reference/openapi.json get /v2/voice-agents/web-tool/list","href":"/api-reference/endpoint/v2/list-web-tools"},{"title":"Update Web Tool","deprecated":null,"version":null,"sidebarTitle":"Update web tool","openapi":"/api-reference/openapi.json patch /v2/voice-agents/web-tool/{id}","href":"/api-reference/endpoint/v2/update-web-tool"},{"title":"Check Newer Versions","deprecated":null,"version":null,"sidebarTitle":"Version check web tools","openapi":"/api-reference/openapi.json post /v2/voice-agents/web-tool/version-check","href":"/api-reference/endpoint/v2/version-check-web-tools"}]},{"group":"Secrets","pages":[{"title":"Create Secret","deprecated":null,"version":null,"sidebarTitle":"Create secret","openapi":"/api-reference/openapi.json post /v1/projects/secrets","href":"/api-reference/endpoint/create-secret"},{"title":"List Secrets","deprecated":null,"version":null,"sidebarTitle":"List secrets","openapi":"/api-reference/openapi.json get /v1/projects/secrets/list","href":"/api-reference/endpoint/list-secrets"},{"title":"Update Secret","deprecated":null,"version":null,"sidebarTitle":"Update secret","openapi":"/api-reference/openapi.json patch /v1/projects/secrets/{id}","href":"/api-reference/endpoint/update-secret"},{"title":"Delete Secret","deprecated":null,"version":null,"sidebarTitle":"Delete secret","openapi":"/api-reference/openapi.json delete /v1/projects/secrets/{id}","href":"/api-reference/endpoint/delete-secret"}]},{"group":"AI Docs Routes","pages":[{"title":"Create AI Content Route","deprecated":null,"version":null,"sidebarTitle":"Post ai content","openapi":"/api-reference/openapi.json post /v1/jobs/ai-content","href":"/api-reference/endpoint/post-ai-content"},{"title":"Get AI Content Route","deprecated":null,"version":null,"sidebarTitle":"Get ai content","openapi":"/api-reference/openapi.json get /v1/jobs/ai-content","href":"/api-reference/endpoint/get-ai-content"},{"title":"Create Customized AI Content Route","deprecated":null,"version":null,"sidebarTitle":"Custom ai content","openapi":"/api-reference/openapi.json post /v1/jobs/ai-content/custom","href":"/api-reference/endpoint/custom-ai-content"},{"title":"Get AI Content Cost Estimate Route","deprecated":null,"version":null,"sidebarTitle":"Ai content estimate","openapi":"/api-reference/openapi.json get /v1/jobs/ai-content/estimate","href":"/api-reference/endpoint/ai-content-estimate"},{"title":"Generate AI Content","deprecated":null,"version":null,"sidebarTitle":"Generate transcription ai content v2","openapi":"/api-reference/openapi.json post /v2/jobs/generate-transcription-ai-content","href":"/api-reference/endpoint/generate-transcription-ai-content-v2"}]},{"group":"Jobs Routes","pages":[{"title":"Get Jobs List","deprecated":null,"version":null,"sidebarTitle":"Get jobs list","openapi":"/api-reference/openapi.json post /v1/jobs/all","href":"/api-reference/endpoint/get-jobs-list"},{"title":"Get Job Details By Id","deprecated":null,"version":null,"sidebarTitle":"Get job by id","openapi":"/api-reference/openapi.json get /v1/jobs","href":"/api-reference/endpoint/get-job-by-id"},{"title":"List Jobs","deprecated":null,"version":null,"sidebarTitle":"List jobs v2","openapi":"/api-reference/openapi.json get /v2/jobs","href":"/api-reference/endpoint/list-jobs-v2"},{"title":"Get Single Job","deprecated":null,"version":null,"sidebarTitle":"Get job v2","openapi":"/api-reference/openapi.json get /v2/jobs/view/{id}","href":"/api-reference/endpoint/get-job-v2"},{"title":"Update Job Title","deprecated":null,"version":null,"sidebarTitle":"Update job title v2","openapi":"/api-reference/openapi.json patch /v2/jobs/{id}","href":"/api-reference/endpoint/update-job-title-v2"},{"title":"Delete Job","deprecated":null,"version":null,"sidebarTitle":"Delete job v2","openapi":"/api-reference/openapi.json delete /v2/jobs/{id}","href":"/api-reference/endpoint/delete-job-v2"}]},{"group":"Project Routes","pages":[{"title":"Get Project By API Key","deprecated":null,"version":null,"sidebarTitle":"Get project by api key","openapi":"/api-reference/openapi.json get /v1/projects/by-api-key","href":"/api-reference/endpoint/get-project-by-api-key"}]},{"group":"API Statistics Routes","pages":[{"title":"Get Usage Statistics Numbers","deprecated":null,"version":null,"sidebarTitle":"Statistics numbers","openapi":"/api-reference/openapi.json get /v1/projects/statistics/numbers","href":"/api-reference/endpoint/statistics-numbers"},{"title":"Get Usage Statistics Chart","deprecated":null,"version":null,"sidebarTitle":"Statistics chart","openapi":"/api-reference/openapi.json get /v1/projects/statistics/chart","href":"/api-reference/endpoint/statistics-chart"}]},{"group":"Agents Analytics and Performance Metrics","pages":[{"title":"Get Overview Analytics","deprecated":null,"version":null,"sidebarTitle":"Get overview analytics","openapi":"/api-reference/openapi.json get /v1/agent-analytics/overview","href":"/api-reference/endpoint/get-overview-analytics"},{"title":"Get Performance Analytics","deprecated":null,"version":null,"sidebarTitle":"Get performance analytics","openapi":"/api-reference/openapi.json get /v1/agent-analytics/performance","href":"/api-reference/endpoint/get-performance-analytics"},{"title":"Get Satisfaction and Outcome Analytics","deprecated":null,"version":null,"sidebarTitle":"Get satisfaction analytics","openapi":"/api-reference/openapi.json get /v1/agent-analytics/satisfaction","href":"/api-reference/endpoint/get-satisfaction-analytics"}]},{"group":"Exporting Conversations","pages":[{"title":"Export Conversations","deprecated":null,"version":null,"sidebarTitle":"Export conversations","openapi":"/api-reference/openapi.json get /v1/agent-analytics/conversations/export","href":"/api-reference/endpoint/export-conversations"}]},{"group":"Exporting Conversations","pages":[{"title":"Get Call Log by ID","deprecated":null,"version":null,"sidebarTitle":"Get call log","openapi":"/api-reference/openapi.json get /v1/agent-analytics/logs/{id}","href":"/api-reference/endpoint/get-call-log"},{"title":"List Call Logs","deprecated":null,"version":null,"sidebarTitle":"List call logs","openapi":"/api-reference/openapi.json get /v1/agent-analytics/logs","href":"/api-reference/endpoint/list-call-logs"}]},{"group":"Deprecated APIs","pages":[{"group":"Voice Agents","expanded":true,"pages":[{"title":"Create Voice Agent Route","deprecated":true,"version":null,"sidebarTitle":"Create voice agent","openapi":"/api-reference/openapi.json post /v1/voice-agents","href":"/api-reference/endpoint/create-voice-agent"},{"title":"Update Voice Agent Route","deprecated":true,"version":null,"sidebarTitle":"Update voice agent","openapi":"/api-reference/openapi.json patch /v1/voice-agents/{voiceAgentId}","href":"/api-reference/endpoint/update-voice-agent"},{"title":"Get Voice Agents List Route","deprecated":true,"version":null,"sidebarTitle":"Get all voice agents","openapi":"/api-reference/openapi.json get /v1/voice-agents","href":"/api-reference/endpoint/get-all-voice-agents"},{"title":"Get A Voice Agent By Id Route","deprecated":true,"version":null,"sidebarTitle":"Get voice agent by id","openapi":"/api-reference/openapi.json get /v1/voice-agents/{voiceAgentId}","href":"/api-reference/endpoint/get-voice-agent-by-id"}]},{"group":"Voice Agents Conversations Routes","expanded":true,"pages":[{"title":"Start a Call for a Conversation Route","deprecated":true,"version":null,"sidebarTitle":"Start a call","openapi":"/api-reference/openapi.json post /v1/voice-agents/call","href":"/api-reference/endpoint/start-a-call"}]},{"group":"Web Tools Routes","expanded":true,"pages":[{"title":"Create a new web tool.","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v1/voice-agents/web-tool","href":"/api-reference/create-a-new-web-tool"},{"title":"Update a web tool by Id.","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json patch /v1/voice-agents/web-tool/{id}","href":"/api-reference/update-a-web-tool-by-id"},{"title":"Return a list of Web Tools.","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v1/voice-agents/web-tool/list","href":"/api-reference/return-a-list-of-web-tools"},{"title":"Check Web Tool Version Updates","deprecated":true,"version":null,"sidebarTitle":"Version check","openapi":"/api-reference/openapi.json post /v1/voice-agents/web-tool/version-check","href":"/api-reference/endpoint/version-check"}]}]}]},{"tab":"WebSocket API","icon":"rocket-vertical","pages":[{"title":"WebSocket API","href":"/websocket/websocket-api"}]},{"tab":"Changelog","icon":"rectangle-history-circle-user","pages":[{"title":"Changelog","href":"/changelog/main"}]}]},"basePath":"","title":"Test API Tool Configuration - Hamsa API","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}