{
"error": "Unauthorized",
"message": "X-API-Key is missing or invalid",
"path": "/v1/integrations/{integrationId}/tools",
"status": 401,
"timestamp": "2026-10-14T11:41:38.587Z"
}
{
"error": "Forbidden",
"message": "Access denied for this resource",
"path": "/v1/integrations/{integrationId}/tools",
"status": 403,
"timestamp": "2026-10-14T11:41:38.587Z"
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"path": "/v1/integrations/{integrationId}/tools",
"status": 404,
"timestamp": "2026-10-14T11:41:38.587Z"
}
{
"error": "Internal Server Error",
"message": "Unexpected server error",
"path": "/v1/integrations/{integrationId}/tools",
"status": 500,
"timestamp": "2026-10-14T11:41:38.587Z"
}
Integration Tools
Execute Tool
Executes a tool against its configured third-party API using the supplied placeholder values. Auth credentials are resolved automatically; specify authId to select specific credentials when multiple exist. Optionally set saveAsMock to persist the live request/response as a named mock, or useMockToolDataId to return a stored mock without calling the third-party API. Returns the response body, status code, and optional mockToolDataId.
Authenticate every request by passing your API key in the X-API-Key header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.
Request body to execute a tool against its configured third-party API. Supply values for every {{variable}} placeholder declared in the tool's endpoint, queryParams, and bodyParams. The tool's stored auth credentials are resolved automatically — you do not need to pass credentials here.
A map of placeholder names to values used to resolve {{placeholder}} tokens in the tool's endpoint URL, query parameters, and request body at runtime. Each placeholder used in the request must have a corresponding entry in this map. Example: for endpoint '/customers/{{customerId}}.json', provide {"customerId": "7654321"}.
Dynamic key-value pairs that were passed to the agent at call start for personalisation. Keys correspond to variable names defined in the agent's configuration (e.g., 'customer_name', 'account_id'). Null or empty if no dynamic variables were provided when the call was created.
Public identifier of the mock created when saveAsMock was supplied on the execute request.
Example:
"mock_HaDxmGfwb8MZLlKM"
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"SigmaMind AI","description":"Developer docs for SigmaMind AI. Build, test, and deploy AI agents that handle voice, chat, and email conversations for your contact center.","colors":{"primary":"#0F172A","light":"#F8FAFC","dark":"#1E293B"},"logo":{"light":"https://mintcdn.com/sigmamindai/vxjJeTe45csRRZLq/logo/light.svg?fit=max\u0026auto=format\u0026n=vxjJeTe45csRRZLq\u0026q=85\u0026s=bc51a1190d0d56521defbdc28b2a0798","dark":"https://mintcdn.com/sigmamindai/vxjJeTe45csRRZLq/logo/dark.svg?fit=max\u0026auto=format\u0026n=vxjJeTe45csRRZLq\u0026q=85\u0026s=37e6d9d7f667ee3761cc76b9ed758f6a","href":"https://www.sigmamind.ai"},"favicon":"https://mintcdn.com/sigmamindai/x8_xeWMetIJrwgEQ/favicon.svg?fit=max\u0026auto=format\u0026n=x8_xeWMetIJrwgEQ\u0026q=85\u0026s=dce3fc7f05848ac97179954ea0aac7a7","navbar":{"links":[{"href":"mailto:help@sigmamind.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.sigmamind.ai/auth/login"}},"footer":{"socials":{"x":"https://x.com/sigmamind_ai","linkedin":"https://www.linkedin.com/company/sigmamind-ai","website":"https://www.sigmamind.ai","youtube":"https://www.youtube.com/@SigmaMindAI"}},"seo":{"indexing":"all"},"integrations":{"ga4":{"measurementId":"G-FS7QYGTFP5"},"gtm":{"tagId":"GTM-NN56PC2H"}},"errors":{"404":{"redirect":true}},"contextual":{"options":["copy","view","assistant","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"variables":{"BASE_URL":"https://api.sigmamind.ai"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.sigmamind.ai"},{"anchor":"Discord Community","icon":"discord","href":"https://www.discord.com/invite/jSWGcw5Wyx"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sigmamindai","hasAudioNarration":false,"actualSubdomain":"sigmamindai","customDomains":["docs.sigmamind.ai"],"gitSource":{"type":"github","owner":"sigmamind-ai","repo":"docs","deployBranch":"dev-master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad0bd308db8cca04419eaa4","collectionId":"f79efd5c-2c72-462d-a1c0-9572c019f6bd","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad0bd308db8cca04419eaa4"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad0bd308db8cca04419eaa4","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Documentation","count":94},{"language":"default","tag":"API Reference","count":77},{"language":"default","tag":"Build","count":37},{"language":"default","tag":"Deploy","count":14},{"language":"default","tag":"How to build conversational flow agents","count":12},{"language":"default","tag":"Tool Integrations","count":11},{"language":"default","tag":"How to build single prompt agents","count":8},{"language":"default","tag":"Add Basic Nodes","count":7},{"language":"default","tag":"How to Add tool","count":6},{"language":"default","tag":"CCAAS Integrations","count":6}]},"assistantConfig":{"enableStarterQuestions":true,"deflection":{"enabled":true,"email":"support@sigmamind.ai","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"695fb83bba37df35a996e0a8","deploymentId":"682c3c0be2b0b5676d6f71d1","questionText":"How do I connect my app with a voice AI agent?","status":"active","generatedBy":"manual","createdAt":"2026-01-08T13:59:23.075Z","updatedAt":"2026-01-08T13:59:23.075Z","__v":0},{"_id":"695fb809ba37df35a996deb4","deploymentId":"682c3c0be2b0b5676d6f71d1","questionText":"How can I add a voice agent to my app or website?","status":"active","generatedBy":"manual","createdAt":"2026-01-08T13:58:33.153Z","updatedAt":"2026-01-08T13:58:33.153Z","__v":0},{"_id":"695fb7adba37df35a996da58","deploymentId":"682c3c0be2b0b5676d6f71d1","questionText":"How do I set up a voice AI agent?","status":"active","generatedBy":"manual","createdAt":"2026-01-08T13:57:01.201Z","updatedAt":"2026-01-08T13:57:01.201Z","__v":0}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/integration-tools/execute-tool","slug":"/api-reference/integration-tools/execute-tool","pageMetadata":{"openapi":"post /v1/integrations/{integrationId}/tools/{toolId}/execute","title":"Execute Tool","description":"Executes a tool against its configured third-party API using the supplied placeholder values. Auth credentials are resolved automatically; specify authId to select specific credentials when multiple exist. Optionally set saveAsMock to persist the live request/response as a named mock, or useMockToolDataId to return a stored mock without calling the third-party API. Returns the response body, status code, and optional mockToolDataId.","href":"/api-reference/integration-tools/execute-tool"},"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: \"Executes a tool against its configured third-party API using the supplied placeholder values. Auth credentials are resolved automatically; specify authId to select specific credentials when multiple exist. Optionally set saveAsMock to persist the live request/response as a named mock, or useMockToolDataId to return a stored mock without calling the third-party API. Returns the response body, status code, and optional mockToolDataId.\"\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":{"openapi":"post /v1/integrations/{integrationId}/tools/{toolId}/execute","title":"Execute Tool","description":"Executes a tool against its configured third-party API using the supplied placeholder values. Auth credentials are resolved automatically; specify authId to select specific credentials when multiple exist. Optionally set saveAsMock to persist the live request/response as a named mock, or useMockToolDataId to return a stored mock without calling the third-party API. Returns the response body, status code, and optional mockToolDataId.","href":"/api-reference/integration-tools/execute-tool"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Integration Tools"],"summary":"Execute Tool","description":"Executes a tool against its configured third-party API using the supplied placeholder values. Auth credentials are resolved automatically; specify authId to select specific credentials when multiple exist. Optionally set saveAsMock to persist the live request/response as a named mock, or useMockToolDataId to return a stored mock without calling the third-party API. Returns the response body, status code, and optional mockToolDataId.","operationId":"executeIntegrationTool","parameters":["3b9fff5a-e906-4d43-87cc-ebfb24e405c0","7901389e-65b3-408f-bf72-401a61bb8de5"],"requestBody":"5e179792-092f-4420-8ddd-d009d17559c7","responses":{"200":"8d36d884-ff3b-411d-b64c-b9376b0559cf","400":"44fedde1-8875-4286-b4f1-92eac931b8a9","401":"316ee0cd-6c72-4f43-828c-00ba42e069cd","403":"ecd68da6-0291-4c50-9353-cc36bcf0760c","404":"ef8c69df-764d-4dde-8372-a021c5df9cd0","500":"7a302966-ffaa-4534-8737-d9df0b27d238"},"method":"post","type":"path","servers":["75f7b222-03cc-4d0b-ad9a-f874f3025873"],"security":["9493c0cd-b560-4dc9-b9d1-6f65df68321e"],"path":"/v1/integrations/{integrationId}/tools/{toolId}/execute","baseUrlOptions":["https://api.sigmamind.ai"],"title":"Execute Tool","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3b9fff5a-e906-4d43-87cc-ebfb24e405c0":{"name":"integrationId","in":"path","description":"Unique identifier of the integration to which the tool belongs.","required":true,"schema":{"type":"string","isRequired":true,"description":"Unique identifier of the integration to which the tool belongs.","uniqueKey":"","typeLabel":"string"},"example":"intg_AuUKK371Spr5"},"7901389e-65b3-408f-bf72-401a61bb8de5":{"name":"toolId","in":"path","description":"Unique identifier of the tool to execute.","required":true,"schema":{"type":"string","isRequired":true,"description":"Unique identifier of the tool to execute.","uniqueKey":"","typeLabel":"string"},"example":"tool_X9pLm2Wq8Rt3"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"placeholders":{"type":"object","additionalProperties":{"type":"string","description":"A map of placeholder names to values used to resolve {{placeholder}} tokens in the tool's endpoint URL, query parameters, and request body at runtime. Each placeholder used in the request must have a corresponding entry in this map. Example: for endpoint '/customers/{{customerId}}.json', provide {\"customerId\": \"7654321\"}.","example":"{\"customerId\":\"7654321\"}","uniqueKey":"placeholders.additionalProperties","typeLabel":"string"},"description":"A map of placeholder names to values used to resolve {{placeholder}} tokens in the tool's endpoint URL, query parameters, and request body at runtime. Each placeholder used in the request must have a corresponding entry in this map. Example: for endpoint '/customers/{{customerId}}.json', provide {\"customerId\": \"7654321\"}.","example":{"customerId":"7654321"},"uniqueKey":"placeholders","typeLabel":"object"},"authId":{"maxLength":64,"minLength":0,"type":"string","description":"The authId of the credential set to use for this execution. ","example":"auth_P3kNz7Yv1Qm9","uniqueKey":"authId","typeLabel":"string"},"saveAsMock":{"required":["agentId","name"],"type":"object","properties":{"name":{"type":"string","description":"Human-readable name for the captured mock.","example":"Success - Order Confirmed","isRequired":true,"uniqueKey":"saveAsMock.name","typeLabel":"string"},"agentId":{"type":"string","description":"The unique identifier of the agent this mock belongs to.","example":"agent_D5D0p7TUs66TTAEAx","isRequired":true,"uniqueKey":"saveAsMock.agentId","typeLabel":"string"},"toolAlias":{"type":"string","description":"Optional agent step name used to resolve the tool when creating the mock. When omitted, the executed tool's toolId is used.","example":"get_order","uniqueKey":"saveAsMock.toolAlias","typeLabel":"string"},"delay":{"type":"integer","description":"Optional artificial delay in milliseconds to store on the mock. Defaults to 0.","format":"int64","example":0,"uniqueKey":"saveAsMock.delay","typeLabel":"integer\u003cint64>"}},"description":"When present on tool execute, persists the live request/response as a named mock in the tenant mock library and returns the created mockToolDataId.","uniqueKey":"saveAsMock","typeLabel":"object"}},"description":"Request body to execute a tool against its configured third-party API. Supply values for every {{variable}} placeholder declared in the tool's endpoint, queryParams, and bodyParams. The tool's stored auth credentials are resolved automatically — you do not need to pass credentials here.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"placeholders":{"customerId":"7654321"},"authId":"auth_P3kNz7Yv1Qm9"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"8d36d884-ff3b-411d-b64c-b9376b0559cf":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"toolId":{"type":"string","description":"Unique identifier of the tool that was executed.","example":"tool_X9pLm2Wq8Rt3","uniqueKey":"toolId","typeLabel":"string"},"integrationId":{"type":"string","description":"Unique identifier of the integration this tool belongs to.","example":"intg_AuUKK371Spr5","uniqueKey":"integrationId","typeLabel":"string"},"url":{"type":"string","description":"The fully resolved URL that was called, with all {{variable}} placeholders substituted.","example":"https://my-store.myshopify.com/admin/api/2024-01/customers/7654321.json","uniqueKey":"url","typeLabel":"string"},"method":{"type":"string","description":"The HTTP method used for the request.","example":"GET","uniqueKey":"method","typeLabel":"string"},"statusCode":{"type":"integer","description":"HTTP status code returned by the third-party API.","format":"int32","example":200,"uniqueKey":"statusCode","typeLabel":"integer\u003cint32>"},"success":{"type":"boolean","description":"Whether the third-party API returned a 2xx success response.","example":true,"uniqueKey":"success","typeLabel":"boolean"},"responseBody":{"type":"object","description":"Dynamic key-value pairs that were passed to the agent at call start for personalisation. Keys correspond to variable names defined in the agent's configuration (e.g., 'customer_name', 'account_id'). Null or empty if no dynamic variables were provided when the call was created.","example":{"customer_name":"Michael","account_id":"ACC-001"},"uniqueKey":"responseBody","typeLabel":"object"},"responseHeaders":{"type":"object","additionalProperties":{"type":"string","description":"Response headers returned by the third-party API.","example":"{\"Content-Type\":\"application/json; charset=utf-8\"}","uniqueKey":"responseHeaders.additionalProperties","typeLabel":"string"},"description":"Response headers returned by the third-party API.","example":{"Content-Type":"application/json; charset=utf-8"},"uniqueKey":"responseHeaders","typeLabel":"object"},"errorMessage":{"type":"string","description":"Error message when success is false — contains the raw error body or exception message.","example":"404 Not Found: {\"errors\": \"Customer not found\"}","uniqueKey":"errorMessage","typeLabel":"string"},"durationMs":{"type":"integer","description":"How long the third-party API took to respond, in milliseconds.","format":"int64","example":342,"uniqueKey":"durationMs","typeLabel":"integer\u003cint64>"},"executedAt":{"type":"string","description":"Timestamp when the execution was triggered.","format":"date-time","example":"2024-04-20T10:00:00.000Z","uniqueKey":"executedAt","typeLabel":"string\u003cdate-time>"},"mockToolDataId":{"type":"string","description":"Public identifier of the mock created when saveAsMock was supplied on the execute request.","example":"mock_HaDxmGfwb8MZLlKM","uniqueKey":"mockToolDataId","typeLabel":"string"}},"description":"Result of executing a tool against its configured third-party API.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"toolId":"tool_X9pLm2Wq8Rt3","integrationId":"intg_AuUKK371Spr5","url":"https://my-store.myshopify.com/admin/api/2024-01/customers/7654321.json","method":"GET","statusCode":200,"success":true,"responseBody":{"customer_name":"Michael","account_id":"ACC-001"},"responseHeaders":{"Content-Type":"application/json; charset=utf-8"},"errorMessage":"404 Not Found: {\"errors\": \"Customer not found\"}","durationMs":342,"executedAt":"2024-04-20T10:00:00.000Z","mockToolDataId":"mock_HaDxmGfwb8MZLlKM"}}},"exampleType":"generated"}},"exampleType":"generated"},"44fedde1-8875-4286-b4f1-92eac931b8a9":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Error timestamp in ISO format","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"status":{"type":"integer","description":"HTTP status code","example":400,"uniqueKey":"status","typeLabel":"integer"},"error":{"type":"string","description":"Error type or HTTP status message","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","example":"Email is required","uniqueKey":"message","typeLabel":"string"},"path":{"type":"string","description":"Request path where error occurred","example":"/v1/users","uniqueKey":"path","typeLabel":"string"},"validationErrors":{"type":"object","description":"Field validation errors (if any)","example":"{\n \"email\": \"Email is required\",\n \"name\": \"Name is too short\"\n}","uniqueKey":"validationErrors","typeLabel":"object"}},"description":"Standard error response","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"error":"Bad Request","message":"Invalid request parameters","path":"/v1/integrations/{integrationId}/tools","status":400,"timestamp":"2026-10-14T11:41:38.586Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"316ee0cd-6c72-4f43-828c-00ba42e069cd":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Error timestamp in ISO format","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"status":{"type":"integer","description":"HTTP status code","example":400,"uniqueKey":"status","typeLabel":"integer"},"error":{"type":"string","description":"Error type or HTTP status message","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","example":"Email is required","uniqueKey":"message","typeLabel":"string"},"path":{"type":"string","description":"Request path where error occurred","example":"/v1/users","uniqueKey":"path","typeLabel":"string"},"validationErrors":{"type":"object","description":"Field validation errors (if any)","example":"{\n \"email\": \"Email is required\",\n \"name\": \"Name is too short\"\n}","uniqueKey":"validationErrors","typeLabel":"object"}},"description":"Standard error response","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"error":"Unauthorized","message":"X-API-Key is missing or invalid","path":"/v1/integrations/{integrationId}/tools","status":401,"timestamp":"2026-10-14T11:41:38.587Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"ecd68da6-0291-4c50-9353-cc36bcf0760c":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Error timestamp in ISO format","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"status":{"type":"integer","description":"HTTP status code","example":400,"uniqueKey":"status","typeLabel":"integer"},"error":{"type":"string","description":"Error type or HTTP status message","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","example":"Email is required","uniqueKey":"message","typeLabel":"string"},"path":{"type":"string","description":"Request path where error occurred","example":"/v1/users","uniqueKey":"path","typeLabel":"string"},"validationErrors":{"type":"object","description":"Field validation errors (if any)","example":"{\n \"email\": \"Email is required\",\n \"name\": \"Name is too short\"\n}","uniqueKey":"validationErrors","typeLabel":"object"}},"description":"Standard error response","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"error":"Forbidden","message":"Access denied for this resource","path":"/v1/integrations/{integrationId}/tools","status":403,"timestamp":"2026-10-14T11:41:38.587Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"ef8c69df-764d-4dde-8372-a021c5df9cd0":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Error timestamp in ISO format","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"status":{"type":"integer","description":"HTTP status code","example":400,"uniqueKey":"status","typeLabel":"integer"},"error":{"type":"string","description":"Error type or HTTP status message","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","example":"Email is required","uniqueKey":"message","typeLabel":"string"},"path":{"type":"string","description":"Request path where error occurred","example":"/v1/users","uniqueKey":"path","typeLabel":"string"},"validationErrors":{"type":"object","description":"Field validation errors (if any)","example":"{\n \"email\": \"Email is required\",\n \"name\": \"Name is too short\"\n}","uniqueKey":"validationErrors","typeLabel":"object"}},"description":"Standard error response","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"error":"Not Found","message":"The requested resource was not found","path":"/v1/integrations/{integrationId}/tools","status":404,"timestamp":"2026-10-14T11:41:38.587Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"7a302966-ffaa-4534-8737-d9df0b27d238":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Error timestamp in ISO format","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"status":{"type":"integer","description":"HTTP status code","example":400,"uniqueKey":"status","typeLabel":"integer"},"error":{"type":"string","description":"Error type or HTTP status message","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","example":"Email is required","uniqueKey":"message","typeLabel":"string"},"path":{"type":"string","description":"Request path where error occurred","example":"/v1/users","uniqueKey":"path","typeLabel":"string"},"validationErrors":{"type":"object","description":"Field validation errors (if any)","example":"{\n \"email\": \"Email is required\",\n \"name\": \"Name is too short\"\n}","uniqueKey":"validationErrors","typeLabel":"object"}},"description":"Standard error response","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"error":"Internal Server Error","message":"Unexpected server error","path":"/v1/integrations/{integrationId}/tools","status":500,"timestamp":"2026-10-14T11:41:38.587Z"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"9493c0cd-b560-4dc9-b9d1-6f65df68321e":{"apiKeyAuth":{"type":"apiKey","description":"Authenticate every request by passing your API key in the `X-API-Key` header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.","name":"X-API-Key","in":"header","scopes":[],"schemeName":"apiKeyAuth"}}},"servers":{"75f7b222-03cc-4d0b-ad9a-f874f3025873":{"url":"https://api.sigmamind.ai","description":"SigmaMind AI Agent Builder APIs"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Authenticate every request by passing your API key in the `X-API-Key` header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.","name":"X-API-Key","in":"header","scopes":[],"schemeName":"apiKeyAuth"},"schema":{"title":"X-API-Key","type":"string","description":"Authenticate every request by passing your API key in the `X-API-Key` header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"X-API-Key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-docs.yaml"},"subdomain":"sigmamindai","siteName":"SigmaMind AI","title":"Execute Tool - SigmaMind AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-15T12:44:00.978Z","originalFileLocation":"api-reference/integration-tools/execute-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=\"Executes a tool against its configured third-party API using the supplied placeholder values. Auth credentials are resolved automatically; specify authId to select specific credentials when multiple exist. Optionally set saveAsMock to persist the live request/response as a named mock, or useMockToolDataId to return a stored mock without calling the third-party API. Returns the response body, status code, and optional mockToolDataId.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SigmaMind AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sigmamindai/QkCWUi6da-GSENjq/_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/sigmamindai/QkCWUi6da-GSENjq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sigmamindai/QkCWUi6da-GSENjq/_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/sigmamindai/QkCWUi6da-GSENjq/_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/sigmamindai/QkCWUi6da-GSENjq/_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/sigmamindai/QkCWUi6da-GSENjq/_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/sigmamindai/QkCWUi6da-GSENjq/_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/sigmamindai/QkCWUi6da-GSENjq/_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/sigmamindai/QkCWUi6da-GSENjq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Execute Tool - SigmaMind AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Executes a tool against its configured third-party API using the supplied placeholder values. Auth credentials are resolved automatically; specify authId to select specific credentials when multiple exist. Optionally set saveAsMock to persist the live request/response as a named mock, or useMockToolDataId to return a stored mock without calling the third-party API. Returns the response body, status code, and optional mockToolDataId.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SigmaMind AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sigmamind.ai/api-reference/integration-tools/execute-tool\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sigmamindai.mintlify.app/_mintlify/api/og/v2?division=Integration+Tools\u0026amp;title=Execute+Tool\u0026amp;description=Executes+a+tool+against+its+configured+third-party+API+using+the+supplied+placeholder+values.+Auth+credentials+are+resolved+automatically%3B+specify+authId+to+sel\u0026amp;theme=1cb0dee83b8b2161fa75211c\u0026amp;signature=bea1bd8dc8cdd5eb868c805d5c8c85952c4d79f2e69803367759df973c2c6a92\">\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=\"Execute Tool - SigmaMind AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Executes a tool against its configured third-party API using the supplied placeholder values. Auth credentials are resolved automatically; specify authId to select specific credentials when multiple exist. Optionally set saveAsMock to persist the live request/response as a named mock, or useMockToolDataId to return a stored mock without calling the third-party API. Returns the response body, status code, and optional mockToolDataId.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sigmamindai.mintlify.app/_mintlify/api/og/v2?division=Integration+Tools\u0026amp;title=Execute+Tool\u0026amp;description=Executes+a+tool+against+its+configured+third-party+API+using+the+supplied+placeholder+values.+Auth+credentials+are+resolved+automatically%3B+specify+authId+to+sel\u0026amp;theme=1cb0dee83b8b2161fa75211c\u0026amp;signature=bea1bd8dc8cdd5eb868c805d5c8c85952c4d79f2e69803367759df973c2c6a92\">\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/sigmamindai/QkCWUi6da-GSENjq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SigmaMind AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F172A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sigmamind.ai/api-reference/integration-tools/execute-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/integration-tools/execute-tool.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sigmamind.ai/#organization\",\"name\":\"SigmaMind AI\",\"url\":\"https://docs.sigmamind.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sigmamindai/vxjJeTe45csRRZLq/logo/light.svg?fit=max\u0026auto=format\u0026n=vxjJeTe45csRRZLq\u0026q=85\u0026s=bc51a1190d0d56521defbdc28b2a0798\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sigmamind.ai#website\",\"name\":\"SigmaMind AI\",\"url\":\"https://docs.sigmamind.ai\",\"publisher\":{\"@id\":\"https://docs.sigmamind.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sigmamind.ai/api-reference/integration-tools/execute-tool#webpage\",\"url\":\"https://docs.sigmamind.ai/api-reference/integration-tools/execute-tool\",\"name\":\"Execute Tool\",\"description\":\"Executes a tool against its configured third-party API using the supplied placeholder values. Auth credentials are resolved automatically; specify authId to select specific credentials when multiple exist. Optionally set saveAsMock to persist the live request/response as a named mock, or useMockToolDataId to return a stored mock without calling the third-party API. Returns the response body, status code, and optional mockToolDataId.\",\"dateModified\":\"2026-09-15T12:44:00.978Z\",\"isPartOf\":{\"@id\":\"https://docs.sigmamind.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.sigmamind.ai/api-reference/integration-tools/execute-tool#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.sigmamind.ai/api-reference/integration-tools/execute-tool#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Integration Tools\",\"item\":\"https://docs.sigmamind.ai/api-reference/integration-tools/create-tool\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Execute Tool\",\"item\":\"https://docs.sigmamind.ai/api-reference/integration-tools/execute-tool\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.sigmamind.ai/api-reference/integration-tools/execute-tool#apireference\",\"headline\":\"Execute Tool\",\"name\":\"Execute Tool\",\"description\":\"Executes a tool against its configured third-party API using the supplied placeholder values. Auth credentials are resolved automatically; specify authId to select specific credentials when multiple exist. Optionally set saveAsMock to persist the live request/response as a named mock, or useMockToolDataId to return a stored mock without calling the third-party API. Returns the response body, status code, and optional mockToolDataId.\",\"url\":\"https://docs.sigmamind.ai/api-reference/integration-tools/execute-tool\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sigmamind.ai/api-reference/integration-tools/execute-tool#webpage\"},\"dateModified\":\"2026-09-15T12:44:00.978Z\",\"publisher\":{\"@id\":\"https://docs.sigmamind.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sigmamind.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SigmaMind AI\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"SigmaMind AI","nav":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.sigmamind.ai"},{"anchor":"Discord Community","icon":"discord","href":"https://www.discord.com/invite/jSWGcw5Wyx"}]},"tabs":[{"tab":"Documentation","icon":"book","pages":[{"title":"Documentation","href":"/documentation/getting-started/introduction"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Calls","pages":[{"openapi":"post /v1/calls","title":"Create Phone Call","href":"/api-reference/calls/create-phone-call"},{"openapi":"get /v1/calls/{callId}","title":"Get Phone Call","href":"/api-reference/calls/get-phone-call"},{"openapi":"get /v1/calls","title":"List Phone Calls","href":"/api-reference/calls/list-phone-calls"},{"openapi":"delete /v1/calls/{callId}","title":"Delete Phone Call","href":"/api-reference/calls/delete-phone-call"}]},{"group":"Chats","pages":[{"openapi":"post /v1/chats","title":"Create Chat","href":"/api-reference/chats/create-a-chat"},{"openapi":"post /v1/chats/response","title":"Chat Completion","href":"/api-reference/chats/chat-completion"},{"openapi":"get /v1/chats/{chatId}","title":"Get Chat","href":"/api-reference/chats/get-chat"},{"openapi":"get /v1/chats","title":"List Chats","href":"/api-reference/chats/list-chats"},{"openapi":"patch /v1/chats/{chatId}","title":"Update Chat","href":"/api-reference/chats/update-chat"},{"openapi":"patch /v1/chats/{chatId}/end-session","title":"End Chat","href":"/api-reference/chats/end-chat"}]},{"group":"Phone Numbers","pages":[{"openapi":"post /v1/phone-numbers","title":"Create Phone Number","href":"/api-reference/phone-numbers/create-phone-number"},{"openapi":"post /v1/phone-numbers/import","title":"Import Phone Number","href":"/api-reference/phone-numbers/import-phone-number"},{"openapi":"get /v1/phone-numbers/{phoneNumber}","title":"Get Phone Number","href":"/api-reference/phone-numbers/get-phone-number"},{"openapi":"get /v1/phone-numbers","title":"List Phone Numbers","href":"/api-reference/phone-numbers/list-phone-numbers"},{"openapi":"patch /v1/phone-numbers/{phoneNumber}","title":"Update Phone Number","href":"/api-reference/phone-numbers/update-phone-number"},{"openapi":"delete /v1/phone-numbers/{phoneNumber}","title":"Delete Phone Number","href":"/api-reference/phone-numbers/delete-phone-number"}]},{"group":"Single Prompt Agents","pages":[{"openapi":"post /v1/agents","title":"Create Agent","href":"/api-reference/single-prompt-agents/create-agent"},{"openapi":"get /v1/agents/{agentId}","title":"Get Agent","href":"/api-reference/single-prompt-agents/get-agent"},{"openapi":"get /v1/agents","title":"List Agents","href":"/api-reference/single-prompt-agents/list-single-prompt-agents"},{"openapi":"patch /v1/agents/{agentId}","title":"Update Agent","href":"/api-reference/single-prompt-agents/update-agent"},{"openapi":"delete /v1/agents/{agentId}","title":"Delete Agent","href":"/api-reference/single-prompt-agents/delete-agent"}]},{"group":"Conversational Agents","pages":[{"openapi":"post /v1/conversational-agents","title":"Create conversational Agent","href":"/api-reference/conversational-agents/create-conversational-agent"},{"openapi":"get /v1/conversational-agents/{agentId}","title":"Get conversational Agent","href":"/api-reference/conversational-agents/get-conversational-agent"},{"openapi":"patch /v1/conversational-agents/{agentId}","title":"Update conversational Agent","href":"/api-reference/conversational-agents/update-conversational-agent"}]},{"group":"Campaigns","pages":[{"openapi":"post /v1/campaigns","title":"Create Campaign","href":"/api-reference/campaigns/create-campaign"},{"openapi":"get /v1/campaigns/{campaignId}","title":"Get Campaign","href":"/api-reference/campaigns/get-campaign"},{"openapi":"get /v1/campaigns","title":"List Campaigns","href":"/api-reference/campaigns/list-campaigns"},{"openapi":"patch /v1/campaigns/{campaignId}","title":"Update Campaign","href":"/api-reference/campaigns/update-campaign"},{"openapi":"delete /v1/campaigns/{campaignId}","title":"Delete Campaign","href":"/api-reference/campaigns/delete-campaign"}]},{"group":"Integrations","pages":[{"openapi":"post /v1/integrations","title":"Create Integration","href":"/api-reference/integrations/create-integration"},{"openapi":"get /v1/integrations/{integrationId}","title":"Get Integration","href":"/api-reference/integrations/get-integration"},{"openapi":"get /v1/integrations","title":"List Integrations","href":"/api-reference/integrations/list-integrations"},{"openapi":"patch /v1/integrations/{integrationId}","title":"Update Integration","href":"/api-reference/integrations/update-integration"},{"openapi":"delete /v1/integrations/{integrationId}","title":"Delete Integration","href":"/api-reference/integrations/delete-integration"}]},{"group":"Integration Auth","pages":[{"openapi":"post /v1/integrations/{integrationId}/auth","title":"Create Integration Auth","href":"/api-reference/integration-auth/create-integration-auth"},{"openapi":"get /v1/integrations/{integrationId}/auth/{authId}","title":"Get Integration Auth","href":"/api-reference/integration-auth/get-integration-auth"},{"openapi":"get /v1/integrations/{integrationId}/auth","title":"List Integration Auth","href":"/api-reference/integration-auth/list-integration-auth"},{"openapi":"patch /v1/integrations/{integrationId}/auth/{authId}","title":"Update Integration Auth","href":"/api-reference/integration-auth/update-integration-auth"},{"openapi":"delete /v1/integrations/{integrationId}/auth/{authId}","title":"Delete Integration Auth","href":"/api-reference/integration-auth/delete-integration-auth"}]},{"group":"Integration Tools","pages":[{"openapi":"post /v1/integrations/{integrationId}/tools","title":"Create Tool","description":"Creates a new API tool under the specified integration. Define the HTTP endpoint, method, and parameter schema the agent will use when invoking the tool. Returns the created tool including its toolId, which is required for subsequent get, update, delete, and execute calls.","href":"/api-reference/integration-tools/create-tool"},{"openapi":"post /v1/integrations/{integrationId}/tools/{toolId}/execute","title":"Execute Tool","href":"/api-reference/integration-tools/execute-tool"},{"openapi":"get /v1/integrations/{integrationId}/tools/{toolId}","title":"Get Tool","description":"Retrieves the full configuration of a single tool by toolId. Returns the tool's endpoint, HTTP method, parameter schema, and access type.","href":"/api-reference/integration-tools/get-tool"},{"openapi":"get /v1/integrations/{integrationId}/tools","title":"List Tools","href":"/api-reference/integration-tools/list-tools"},{"openapi":"patch /v1/integrations/{integrationId}/tools/{toolId}","title":"Update Tool","href":"/api-reference/integration-tools/update-tool"},{"openapi":"delete /v1/integrations/{integrationId}/tools/{toolId}","title":"Delete Tool","href":"/api-reference/integration-tools/delete-tool"}]},{"group":"Mock Tool Data","pages":[{"openapi":"post /v1/mock-tool-data","title":"Create Mock Tool Data","href":"/api-reference/mock-tool-data/create-mock-tool-data"},{"openapi":"get /v1/mock-tool-data/{mockToolDataId}","title":"Get Mock Tool Data","href":"/api-reference/mock-tool-data/get-mock-tool-data"},{"openapi":"get /v1/mock-tool-data","title":"List Mock Tool Data","href":"/api-reference/mock-tool-data/list-mock-tool-data"},{"openapi":"patch /v1/mock-tool-data/{mockToolDataId}","title":"Update Mock Tool Data","href":"/api-reference/mock-tool-data/update-mock-tool-data"},{"openapi":"delete /v1/mock-tool-data/{mockToolDataId}","title":"Delete Mock Tool Data","href":"/api-reference/mock-tool-data/delete-mock-tool-data"}]},{"group":"Test Cases","pages":[{"openapi":"post /v1/test-cases","title":"Create Test Case","href":"/api-reference/test-cases/create-test-case"},{"openapi":"get /v1/test-cases/{testCaseId}","title":"Get Test Case","href":"/api-reference/test-cases/get-test-case"},{"openapi":"get /v1/test-cases","title":"List Test Cases","href":"/api-reference/test-cases/list-test-cases"},{"openapi":"patch /v1/test-cases/{testCaseId}","title":"Update Test Case","href":"/api-reference/test-cases/update-test-case"},{"openapi":"delete /v1/test-cases/{testCaseId}","title":"Delete Test Case","href":"/api-reference/test-cases/delete-test-case"}]},{"group":"Batch","pages":[{"openapi":"post /v1/batch-runs","title":"Create Batch Run","href":"/api-reference/batch/create-batch-run"},{"openapi":"get /v1/batch-runs/{batchId}","title":"Get Batch Run","href":"/api-reference/batch/get-batch-run"},{"openapi":"get /v1/batch-runs","title":"List Batch Runs","href":"/api-reference/batch/list-batch-runs"}]},{"group":"Test Runs","pages":[{"openapi":"get /v1/test-runs/{jobId}","title":"Get Test Run","href":"/api-reference/test-runs/get-test-run"},{"openapi":"get /v1/test-runs","title":"List Test Runs","href":"/api-reference/test-runs/list-test-runs"}]},{"group":"Webhooks","pages":[{"openapi":"post /v1/webhooks","title":"Create Webhook","href":"/api-reference/webhooks/create-webhook"},{"openapi":"get /v1/webhooks/{webhookId}","title":"Get Webhook","href":"/api-reference/webhooks/get-webhook"},{"openapi":"get /v1/webhooks","title":"List Webhooks","href":"/api-reference/webhooks/list-webhooks"},{"openapi":"delete /v1/webhooks/{webhookId}","title":"Delete Webhook","href":"/api-reference/webhooks/delete-webhook"}]},{"group":"QA Rules","pages":[{"openapi":"post /v1/qa-rules","title":"Create QA Rule","href":"/api-reference/qa-rules/create-qa-rule"},{"openapi":"get /v1/qa-rules/{qaRuleId}","title":"Get QA Rule","href":"/api-reference/qa-rules/get-qa-rule"},{"openapi":"get /v1/qa-rules","title":"List QA Rules","href":"/api-reference/qa-rules/list-qa-rules"},{"openapi":"patch /v1/qa-rules/{qaRuleId}","title":"Update QA Rule","href":"/api-reference/qa-rules/update-qa-rule"},{"openapi":"delete /v1/qa-rules/{qaRuleId}","title":"Delete QA Rule","href":"/api-reference/qa-rules/delete-qa-rule"}]},{"group":"QA Issues","pages":[{"openapi":"get /v1/qa-issues/{qaIssueId}","title":"Get QA Issue","href":"/api-reference/qa-issues/get-qa-issue"},{"openapi":"get /v1/qa-issues","title":"List QA Issues","href":"/api-reference/qa-issues/list-qa-issues"}]},{"group":"Knowledge bases","pages":[{"openapi":"post /v1/knowledge-bases","title":"Create knowledge base","href":"/api-reference/knowledge-bases/create-knowledge-base"},{"openapi":"get /v1/knowledge-bases/{kbId}","title":"Get knowledge base","href":"/api-reference/knowledge-bases/get-knowledge-base-by-kbid"},{"openapi":"get /v1/knowledge-bases","title":"List knowledge bases","href":"/api-reference/knowledge-bases/list-knowledge-bases"},{"openapi":"patch /v1/knowledge-bases/{kbId}","title":"Update knowledge base","href":"/api-reference/knowledge-bases/update-knowledge-base"},{"openapi":"delete /v1/knowledge-bases/{kbId}","title":"Delete knowledge base","href":"/api-reference/knowledge-bases/delete-knowledge-base"},{"openapi":"delete /v1/knowledge-bases/{kbId}/documents/{documentId}","title":"Delete document","href":"/api-reference/knowledge-bases/delete-one-document-from-a-knowledge-base"}]}]},{"tab":"MCP","icon":"code-branch","pages":[{"title":"MCP","href":"/mcp/server"}]},{"tab":"Tutorials","icon":"video","hidden":true,"pages":[{"title":"Tutorials","href":"/tutorials/agents/overview"}]}]},"title":"Execute Tool - SigmaMind AI","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}