{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Convocore","colors":{"primary":"#28a9ff","light":"#28a9ff","dark":"#28a9ff"},"logo":{"light":"https://mintcdn.com/convocore/1cycRLmxh90eo61b/logo/ta-logo-512x512.png?fit=max\u0026auto=format\u0026n=1cycRLmxh90eo61b\u0026q=85\u0026s=9ebf8bd5b5f6f870b1498d2fa53591bc","dark":"https://mintcdn.com/convocore/1cycRLmxh90eo61b/logo/ta-logo-512x512.png?fit=max\u0026auto=format\u0026n=1cycRLmxh90eo61b\u0026q=85\u0026s=9ebf8bd5b5f6f870b1498d2fa53591bc"},"favicon":"https://mintcdn.com/convocore/1cycRLmxh90eo61b/logo/ta-logo-512x512.png?fit=max\u0026auto=format\u0026n=1cycRLmxh90eo61b\u0026q=85\u0026s=9ebf8bd5b5f6f870b1498d2fa53591bc","api":{"openapi":["api-reference/openapi.json"],"asyncapi":["api-reference/asyncapi/interact.yaml"]},"appearance":{"default":"dark"},"navbar":{"links":[{"href":"mailto:support@convocore.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://convocore.ai/login"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/convocore","instagram":"https://instagram.com/convocore","discord":"https://discord.gg/XrJtBsQQRN"}},"contextual":{"options":["copy","chatgpt","claude","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.gg/XrJtBsQQRN"},{"anchor":"Status","icon":"info","href":"https://status.convocore.ai/"},{"anchor":"Pricing","icon":"dollar-sign","href":"https://www.convocore.ai/pricing"},{"anchor":"Affiliate Program","icon":"handshake","href":"https://affiliates.convocore.ai/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"convocore","hasAudioNarration":false,"actualSubdomain":"convocore","customDomains":["docs.convocore.ai"],"gitSource":{"type":"github","owner":"vectorwizards-hq","repo":"convocore","deployBranch":"moe","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ab915ca1970a43573821821","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":152},{"language":"default","tag":"Documentation","count":135},{"language":"default","tag":"V3","count":107},{"language":"default","tag":"Build Your Agent","count":45},{"language":"default","tag":"V2 (Legacy)","count":38},{"language":"default","tag":"Agents","count":34},{"language":"default","tag":"Business","count":26},{"language":"default","tag":"Workspaces","count":22},{"language":"default","tag":"Features","count":22},{"language":"default","tag":"Orgs","count":19}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":":root{--head-color: #3f4346}.dark{--head-color: #e5e7eb}svg[width=\"3\"][height=\"24\"][viewBox=\"0 -9 3 24\"]{background-color:transparent!important}#navigation-items>div>ul>li>a>div,#navigation-items>div>ul>li>div>div{font-weight:550!important;color:var(--head-color)!important;font-size:0.93rem!important;margin-bottom:0.2rem!important}#navigation-items>div>ul>li>div>svg:first-of-type,#navigation-items>div>ul>li>a>svg:first-of-type{background-color:var(--head-color);margin-bottom:0.2rem!important}"}],"page":{"pagePath":"api-reference/v3/tools/update","slug":"/api-reference/v3/tools/update","pageMetadata":{"title":"Update Tool","description":"Updates a tool, this route must use the new V3 [endpoints](/api-reference/v3/intro).","openapi":"PATCH /tools/{toolId}","href":"/api-reference/v3/tools/update"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Updates a tool, this route must use the new V3 \", _jsx(_components.a, {\n href: \"/api-reference/v3/intro\",\n children: \"endpoints\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`example-request`,children:`Example Request`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"tool\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Updated Tool Name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Updated description for the AI\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"disabled\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`Uses partial updates - only provided fields are changed. Other fields remain unchanged.`})}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Set `,_jsx(_components.code,{children:`disabled: true`}),` to temporarily disable a tool without deleting it.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update Tool","description":"Updates a tool, this route must use the new V3 [endpoints](/api-reference/v3/intro).","openapi":"PATCH /tools/{toolId}","href":"/api-reference/v3/tools/update"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Example Request","slug":"example-request","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"toolRouter-updateTool","summary":"Update Tool","tags":["Tools"],"security":["cf5f4251-a475-4020-bfbf-62a82cc96d1d"],"requestBody":"673f6d66-912d-4168-9bbf-dca26371c499","parameters":["3553d807-4a1b-49f6-b36e-fee77a2fbc90"],"responses":{"200":"dd8a00cd-8d07-4215-9c38-38512a85fc6f","default":"d292ffe6-c71a-47f3-b8cb-e4e38b114b14"},"method":"patch","type":"path","servers":["e55f9874-43f1-4359-be71-1811af333c24"],"path":"/tools/{toolId}","baseUrlOptions":["https://eu-gcp-api.vg-stuff.com/v3"],"title":"Update Tool","description":"Updates a tool, this route must use the new V3 [endpoints](/api-reference/v3/intro).","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3553d807-4a1b-49f6-b36e-fee77a2fbc90":{"name":"toolId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tool":{"type":"object","properties":{"name":{"type":"string","description":"The name of the tool, providing a human-readable identifier for display purposes.","isRequired":true,"uniqueKey":"tool.name","typeLabel":"string"},"description":{"type":"string","description":"A detailed description of the tool's purpose and functionality. Helps users understand its role within the agent.","isRequired":true,"uniqueKey":"tool.description","typeLabel":"string"},"isDefault":{"type":"boolean","description":"Indicates whether this tool is the default tool for the agent. Defaults to false if unspecified.","uniqueKey":"tool.isDefault","typeLabel":"boolean"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH"],"description":"The HTTP method used by this tool. Acceptable values are 'GET', 'POST', 'PUT', or 'PATCH'. Defaults to 'POST' if unspecified.","uniqueKey":"tool.method","typeLabel":"enum\u003cstring>"},"serverUrl":{"type":"string","description":"The server URL where the tool's operations are performed. Used for network-based integrations.","uniqueKey":"tool.serverUrl","typeLabel":"string"},"serverUrlSecret":{"type":"string","description":"A secret token or key associated with the server URL. Provides secure access to the tool's backend services.","uniqueKey":"tool.serverUrlSecret","typeLabel":"string"},"disabled":{"type":"boolean","description":"Indicates whether the tool is currently disabled. A disabled tool cannot be used by the agent.","uniqueKey":"tool.disabled","typeLabel":"boolean"},"isVapiTool":{"type":"boolean","description":"Indicates whether the tool is a Virtual API (VAPI) tool. VAPI tools enable interaction with external APIs.","uniqueKey":"tool.isVapiTool","typeLabel":"boolean"},"vapiId":{"type":"string","description":"A unique identifier for the VAPI associated with this tool. Used for integration with specific API endpoints.","uniqueKey":"tool.vapiId","typeLabel":"string"},"isGlobal":{"type":"boolean","description":"If true, this tool is globally accessible to all nodes and agents. Overrides context-specific restrictions.","uniqueKey":"tool.isGlobal","typeLabel":"boolean"},"variablesIds":{"type":"array","items":{"type":"string","uniqueKey":"tool.variablesIds.items.[INDEX]","typeLabel":"string"},"description":"An array of variable IDs associated with the tool. Each ID maps to a specific variable used by the tool.","uniqueKey":"tool.variablesIds","typeLabel":"string[]"},"toolsSettings":{"oneOf":[{}],"uniqueKey":"tool.toolsSettings","typeLabel":"any"},"fields":{"type":"array","items":{"type":"object","properties":{"in":{"type":"string","description":"Defines the location or context in which the field is utilized. Common values include 'query', 'body', or 'header'.","uniqueKey":"tool.fields.items.[INDEX].in","typeLabel":"string"},"type":{"type":"string","enum":["string","number","boolean","system"],"description":"Specifies the variable type of the field. Acceptable values include 'string', 'number', 'boolean', and 'system'.","uniqueKey":"tool.fields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"description":"The current assigned value of the field. This value is optional and supports any type depending on the field's context.","uniqueKey":"tool.fields.items.[INDEX].value","typeLabel":"any"},"defaultValue":{"description":"A predefined value assigned to the field when no specific value is provided. Useful for ensuring consistent behavior.","uniqueKey":"tool.fields.items.[INDEX].defaultValue","typeLabel":"any"},"key":{"type":"string","description":"The unique key that identifies this tool field or variable. Often used for referencing the field programmatically.","uniqueKey":"tool.fields.items.[INDEX].key","typeLabel":"string"},"description":{"type":"string","description":"A detailed explanation of the field's purpose and usage. Helps users understand the field's role in the system.","uniqueKey":"tool.fields.items.[INDEX].description","typeLabel":"string"},"required":{"type":"boolean","description":"Indicates whether the presence of this field is mandatory for successful operation. Defaults to false if unspecified.","uniqueKey":"tool.fields.items.[INDEX].required","typeLabel":"boolean"},"reusable":{"type":"boolean","description":"Denotes whether this field can be reused across multiple contexts or tools. Useful for reducing redundancy.","uniqueKey":"tool.fields.items.[INDEX].reusable","typeLabel":"boolean"},"isEnv":{"type":"boolean","description":"Specifies if this field represents an environment variable, typically used for configuration or deployment.","uniqueKey":"tool.fields.items.[INDEX].isEnv","typeLabel":"boolean"},"isSystem":{"type":"boolean","description":"Indicates whether this field is a system-level variable, reserved for core operations or internal use.","uniqueKey":"tool.fields.items.[INDEX].isSystem","typeLabel":"boolean"},"isGlobal":{"type":"boolean","description":"If enabled, this field remains globally accessible to the agent across all operational contexts. Useful for global constants.","uniqueKey":"tool.fields.items.[INDEX].isGlobal","typeLabel":"boolean"},"agentId":{"type":"string","description":"References the unique identifier of the agent associated with this field. Helps in mapping fields to specific agents.","uniqueKey":"tool.fields.items.[INDEX].agentId","typeLabel":"string"},"userId":{"type":"string","description":"References the unique identifier of the user associated with this field. Useful for user-specific customizations.","uniqueKey":"tool.fields.items.[INDEX].userId","typeLabel":"string"},"id":{"type":"string","uniqueKey":"tool.fields.items.[INDEX].id","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"tool.fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"tool.fields","typeLabel":"object[]"},"channels":{"type":"array","items":{"type":"string","enum":["web-chat","whatsapp","instagram","telegram","discord","gb-chat","vapi","messenger","voice","telephony","outlook","zoho","sms"],"uniqueKey":"tool.channels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The channels that the tool can be used on.","uniqueKey":"tool.channels","typeLabel":"enum\u003cstring>[]"}},"required":["name","description"],"additionalProperties":false,"isRequired":true,"uniqueKey":"tool","typeLabel":"object"}},"required":["tool"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"tool":{"name":"\u003cstring>","description":"\u003cstring>","isDefault":true,"serverUrl":"\u003cstring>","serverUrlSecret":"\u003cstring>","disabled":true,"isVapiTool":true,"vapiId":"\u003cstring>","isGlobal":true,"variablesIds":["\u003cstring>"],"toolsSettings":"\u003cunknown>","fields":[{"in":"\u003cstring>","value":"\u003cunknown>","defaultValue":"\u003cunknown>","key":"\u003cstring>","description":"\u003cstring>","required":true,"reusable":true,"isEnv":true,"isSystem":true,"isGlobal":true,"agentId":"\u003cstring>","userId":"\u003cstring>","id":"\u003cstring>"}],"channels":[]}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"dd8a00cd-8d07-4215-9c38-38512a85fc6f":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the tool. Ensures distinct identification within the system.","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"name":{"type":"string","description":"The name of the tool, providing a human-readable identifier for display purposes.","isRequired":true,"uniqueKey":"data.name","typeLabel":"string"},"description":{"type":"string","description":"A detailed description of the tool's purpose and functionality. Helps users understand its role within the agent.","isRequired":true,"uniqueKey":"data.description","typeLabel":"string"},"isDefault":{"type":"boolean","description":"Indicates whether this tool is the default tool for the agent. Defaults to false if unspecified.","uniqueKey":"data.isDefault","typeLabel":"boolean"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH"],"description":"The HTTP method used by this tool. Acceptable values are 'GET', 'POST', 'PUT', or 'PATCH'. Defaults to 'POST' if unspecified.","uniqueKey":"data.method","typeLabel":"enum\u003cstring>"},"serverUrl":{"type":"string","description":"The server URL where the tool's operations are performed. Used for network-based integrations.","uniqueKey":"data.serverUrl","typeLabel":"string"},"serverUrlSecret":{"type":"string","description":"A secret token or key associated with the server URL. Provides secure access to the tool's backend services.","uniqueKey":"data.serverUrlSecret","typeLabel":"string"},"createdAt":{"type":"string","description":"The timestamp when the tool was created, formatted as an ISO 8601 string. Useful for tracking tool lifecycle.","uniqueKey":"data.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"The timestamp when the tool was last updated, formatted as an ISO 8601 string. Useful for versioning and auditing.","uniqueKey":"data.updatedAt","typeLabel":"string"},"disabled":{"type":"boolean","description":"Indicates whether the tool is currently disabled. A disabled tool cannot be used by the agent.","uniqueKey":"data.disabled","typeLabel":"boolean"},"isVapiTool":{"type":"boolean","description":"Indicates whether the tool is a Virtual API (VAPI) tool. VAPI tools enable interaction with external APIs.","uniqueKey":"data.isVapiTool","typeLabel":"boolean"},"vapiId":{"type":"string","description":"A unique identifier for the VAPI associated with this tool. Used for integration with specific API endpoints.","uniqueKey":"data.vapiId","typeLabel":"string"},"isGlobal":{"type":"boolean","description":"If true, this tool is globally accessible to all nodes and agents. Overrides context-specific restrictions.","uniqueKey":"data.isGlobal","typeLabel":"boolean"},"variablesIds":{"type":"array","items":{"type":"string","uniqueKey":"data.variablesIds.items.[INDEX]","typeLabel":"string"},"description":"An array of variable IDs associated with the tool. Each ID maps to a specific variable used by the tool.","uniqueKey":"data.variablesIds","typeLabel":"string[]"},"agentId":{"type":"string","description":"The unique identifier of the agent associated with this tool. Helps in linking the tool to a specific agent.","uniqueKey":"data.agentId","typeLabel":"string"},"userId":{"type":"string","description":"The unique identifier of the user associated with this tool. Used for user-specific configurations and access control.","uniqueKey":"data.userId","typeLabel":"string"},"backchannellingPhrases":{"type":"array","items":{"type":"string","uniqueKey":"data.backchannellingPhrases.items.[INDEX]","typeLabel":"string"},"description":"An array of phrases used for backchannel communication. These phrases help in maintaining conversational flow.","uniqueKey":"data.backchannellingPhrases","typeLabel":"string[]"},"toolsSettings":{"oneOf":[{}],"uniqueKey":"data.toolsSettings","typeLabel":"any"},"fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the field, ensuring it is distinct across the system.","isRequired":true,"uniqueKey":"data.fields.items.[INDEX].id","typeLabel":"string"},"in":{"type":"string","description":"Defines the location or context in which the field is utilized. Common values include 'query', 'body', or 'header'.","uniqueKey":"data.fields.items.[INDEX].in","typeLabel":"string"},"type":{"type":"string","enum":["string","number","boolean","system"],"description":"Specifies the variable type of the field. Acceptable values include 'string', 'number', 'boolean', and 'system'.","uniqueKey":"data.fields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"description":"The current assigned value of the field. This value is optional and supports any type depending on the field's context.","uniqueKey":"data.fields.items.[INDEX].value","typeLabel":"any"},"defaultValue":{"description":"A predefined value assigned to the field when no specific value is provided. Useful for ensuring consistent behavior.","uniqueKey":"data.fields.items.[INDEX].defaultValue","typeLabel":"any"},"key":{"type":"string","description":"The unique key that identifies this tool field or variable. Often used for referencing the field programmatically.","uniqueKey":"data.fields.items.[INDEX].key","typeLabel":"string"},"description":{"type":"string","description":"A detailed explanation of the field's purpose and usage. Helps users understand the field's role in the system.","uniqueKey":"data.fields.items.[INDEX].description","typeLabel":"string"},"required":{"type":"boolean","description":"Indicates whether the presence of this field is mandatory for successful operation. Defaults to false if unspecified.","uniqueKey":"data.fields.items.[INDEX].required","typeLabel":"boolean"},"reusable":{"type":"boolean","description":"Denotes whether this field can be reused across multiple contexts or tools. Useful for reducing redundancy.","uniqueKey":"data.fields.items.[INDEX].reusable","typeLabel":"boolean"},"isEnv":{"type":"boolean","description":"Specifies if this field represents an environment variable, typically used for configuration or deployment.","uniqueKey":"data.fields.items.[INDEX].isEnv","typeLabel":"boolean"},"isSystem":{"type":"boolean","description":"Indicates whether this field is a system-level variable, reserved for core operations or internal use.","uniqueKey":"data.fields.items.[INDEX].isSystem","typeLabel":"boolean"},"isGlobal":{"type":"boolean","description":"If enabled, this field remains globally accessible to the agent across all operational contexts. Useful for global constants.","uniqueKey":"data.fields.items.[INDEX].isGlobal","typeLabel":"boolean"},"agentId":{"type":"string","description":"References the unique identifier of the agent associated with this field. Helps in mapping fields to specific agents.","uniqueKey":"data.fields.items.[INDEX].agentId","typeLabel":"string"},"userId":{"type":"string","description":"References the unique identifier of the user associated with this field. Useful for user-specific customizations.","uniqueKey":"data.fields.items.[INDEX].userId","typeLabel":"string"}},"required":["id"],"additionalProperties":false,"uniqueKey":"data.fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.fields","typeLabel":"object[]"},"channels":{"type":"array","items":{"type":"string","enum":["web-chat","whatsapp","instagram","telegram","discord","gb-chat","vapi","messenger","voice","telephony","outlook","zoho","sms"],"uniqueKey":"data.channels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The channels that the tool can be used on.","uniqueKey":"data.channels","typeLabel":"enum\u003cstring>[]"}},"required":["id","name","description"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["success","message","data"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","data":{"id":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","isDefault":true,"method":"GET","serverUrl":"\u003cstring>","serverUrlSecret":"\u003cstring>","createdAt":"\u003cstring>","updatedAt":"\u003cstring>","disabled":true,"isVapiTool":true,"vapiId":"\u003cstring>","isGlobal":true,"variablesIds":["\u003cstring>"],"agentId":"\u003cstring>","userId":"\u003cstring>","backchannellingPhrases":["\u003cstring>"],"toolsSettings":"\u003cunknown>","fields":[{"id":"\u003cstring>","in":"\u003cstring>","type":"string","value":"\u003cunknown>","defaultValue":"\u003cunknown>","key":"\u003cstring>","description":"\u003cstring>","required":true,"reusable":true,"isEnv":true,"isSystem":true,"isGlobal":true,"agentId":"\u003cstring>","userId":"\u003cstring>"}],"channels":["web-chat"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"d292ffe6-c71a-47f3-b8cb-e4e38b114b14":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"additionalProperties":false,"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"\u003cstring>","issues":[{"message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"cf5f4251-a475-4020-bfbf-62a82cc96d1d":{"Authorization":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"e55f9874-43f1-4359-be71-1811af333c24":{"url":"https://eu-gcp-api.vg-stuff.com/v3"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Authorization","name":"Authorization"}],"title":"Authorization"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"convocore","siteName":"Convocore","title":"Update Tool - Convocore","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-24T21:43:08.760Z","originalFileLocation":"api-reference/v3/tools/update.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=\"dark\"}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=\"Updates a tool, this route must use the new V3 endpoints.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Convocore\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/convocore/xJul9Fxd36kpM8oJ/_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/convocore/xJul9Fxd36kpM8oJ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/convocore/xJul9Fxd36kpM8oJ/_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/convocore/xJul9Fxd36kpM8oJ/_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/convocore/xJul9Fxd36kpM8oJ/_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/convocore/xJul9Fxd36kpM8oJ/_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/convocore/xJul9Fxd36kpM8oJ/_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/convocore/xJul9Fxd36kpM8oJ/_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/convocore/xJul9Fxd36kpM8oJ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Tool - Convocore\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates a tool, this route must use the new V3 endpoints.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Convocore\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.convocore.ai/api-reference/v3/tools/update\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://convocore.mintlify.site/_mintlify/api/og/v2?division=Tools\u0026amp;title=Update+Tool\u0026amp;description=Updates+a+tool%2C+this+route+must+use+the+new+V3+%5Bendpoints%5D%28%2Fapi-reference%2Fv3%2Fintro%29.\u0026amp;theme=ad5ffcb84f80ca71d8be4f33\u0026amp;signature=6d2aa825ff2711e4bdfcaaa628937a53d70add6ec33efc037291bbb0a3bbfd98\">\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=\"Update Tool - Convocore\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates a tool, this route must use the new V3 endpoints.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://convocore.mintlify.site/_mintlify/api/og/v2?division=Tools\u0026amp;title=Update+Tool\u0026amp;description=Updates+a+tool%2C+this+route+must+use+the+new+V3+%5Bendpoints%5D%28%2Fapi-reference%2Fv3%2Fintro%29.\u0026amp;theme=ad5ffcb84f80ca71d8be4f33\u0026amp;signature=6d2aa825ff2711e4bdfcaaa628937a53d70add6ec33efc037291bbb0a3bbfd98\">\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/convocore/xJul9Fxd36kpM8oJ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Convocore\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#28a9ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.convocore.ai/api-reference/v3/tools/update\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v3/tools/update.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.convocore.ai/#organization\",\"name\":\"Convocore\",\"url\":\"https://docs.convocore.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/convocore/1cycRLmxh90eo61b/logo/ta-logo-512x512.png?fit=max\u0026auto=format\u0026n=1cycRLmxh90eo61b\u0026q=85\u0026s=9ebf8bd5b5f6f870b1498d2fa53591bc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.convocore.ai#website\",\"name\":\"Convocore\",\"url\":\"https://docs.convocore.ai\",\"publisher\":{\"@id\":\"https://docs.convocore.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.convocore.ai/api-reference/v3/tools/update#webpage\",\"url\":\"https://docs.convocore.ai/api-reference/v3/tools/update\",\"name\":\"Update Tool\",\"description\":\"Updates a tool, this route must use the new V3 endpoints.\",\"dateModified\":\"2026-01-24T21:43:08.760Z\",\"isPartOf\":{\"@id\":\"https://docs.convocore.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.convocore.ai/api-reference/v3/tools/update#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.convocore.ai/api-reference/v3/tools/update#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"V3\",\"item\":\"https://docs.convocore.ai/api-reference/v3/intro\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Tools\",\"item\":\"https://docs.convocore.ai/api-reference/v3/tools/defaults\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update Tool\",\"item\":\"https://docs.convocore.ai/api-reference/v3/tools/update\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.convocore.ai/api-reference/v3/tools/update#apireference\",\"headline\":\"Update Tool\",\"name\":\"Update Tool\",\"description\":\"Updates a tool, this route must use the new V3 endpoints.\",\"url\":\"https://docs.convocore.ai/api-reference/v3/tools/update\",\"mainEntityOfPage\":{\"@id\":\"https://docs.convocore.ai/api-reference/v3/tools/update#webpage\"},\"dateModified\":\"2026-01-24T21:43:08.760Z\",\"publisher\":{\"@id\":\"https://docs.convocore.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.convocore.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Convocore\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Convocore","nav":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.gg/XrJtBsQQRN"},{"anchor":"Status","icon":"info","href":"https://status.convocore.ai/"},{"anchor":"Pricing","icon":"dollar-sign","href":"https://www.convocore.ai/pricing"},{"anchor":"Affiliate Program","icon":"handshake","href":"https://affiliates.convocore.ai/"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/help-center/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"Get Started","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"API Endpoints","href":"/api-reference/endpoints"}]},{"group":"V3","pages":[{"title":"Get Started","icon":"rocket","href":"/api-reference/v3/intro"},{"group":"Agents","icon":"robot","pages":[{"title":"Create Agent","openapi":"POST /agents","href":"/api-reference/v3/agents/post"},{"title":"Agent Usage","openapi":"POST /agents/{agent_id}/usage","href":"/api-reference/v3/agents/usage/get"},{"title":"Get Agent By ID","openapi":"GET /agents/{id}","href":"/api-reference/v3/agents/get_id"},{"title":"Get Agents","openapi":"GET /agents","href":"/api-reference/v3/agents/get"},{"title":"Search Agents","openapi":"GET /agents/search","href":"/api-reference/v3/agents/search"},{"title":"Delete Agent","openapi":"DELETE /agents/{id}","href":"/api-reference/v3/agents/delete"},{"title":"Update Agent","openapi":"PATCH /agents/{id}","href":"/api-reference/v3/agents/update"},{"title":"Clone Agent","openapi":"POST /agents/{agentId}/clone","href":"/api-reference/v3/agents/clone"},{"title":"Interact (REST)","openapi":"POST /agents/interact","href":"/api-reference/v3/agents/interact"},{"title":"Agent Audit Log","openapi":"GET /agents/{agentId}/audit-log","href":"/api-reference/v3/agents/audit-log"},{"title":"Create From Canonical Template","openapi":"POST /agent-templates/{templateId}/create","href":"/api-reference/v3/agents/from-template"},{"title":"Export Agent Template","openapi":"GET /agents/{agentId}/export-template","href":"/api-reference/v3/agents/export-template"},{"title":"Import Agent Template","openapi":"POST /agents/import-template","href":"/api-reference/v3/agents/import-template"}]},{"group":"Knowledge Base","icon":"brain","pages":[{"title":"Create KB","openapi":"POST /agents/{agentId}/kb","href":"/api-reference/v3/kb/post"},{"title":"Upload KB Images","openapi":"POST /agents/{agentId}/kb/images","href":"/api-reference/v3/kb/images"},{"title":"Bulk Create KB Docs","openapi":"POST /agents/{agentId}/kb/docs/bulk","href":"/api-reference/v3/kb/bulk"},{"title":"Get agent KB docs","openapi":"GET /agents/{agentId}/kb","href":"/api-reference/v3/kb/get"},{"title":"Get Single KB Doc","openapi":"GET /agents/{agentId}/kb/{docId}","href":"/api-reference/v3/kb/get_id"},{"title":"Get KB Stats","openapi":"GET /agents/{agentId}/kb/stats","href":"/api-reference/v3/kb/get_stats"},{"title":"Search KB","openapi":"POST /agents/{agentId}/kb/search","href":"/api-reference/v3/kb/search"},{"title":"Delete KB Doc","openapi":"DELETE /agents/{agentId}/kb/{docId}","href":"/api-reference/v3/kb/delete"},{"title":"Update KB Doc","openapi":"PATCH /agents/{agentId}/kb/{docId}","href":"/api-reference/v3/kb/update"}]},{"group":"Scrape","icon":"globe","pages":[{"title":"General Scrape","openapi":"POST /scrape","href":"/api-reference/v3/scrape/post"}]},{"group":"Conversations","icon":"square-minus","pages":[{"title":"Create Conversation","openapi":"POST /agents/{agentId}/convos","href":"/api-reference/v3/conversations/post"},{"title":"Update Conversation","openapi":"PATCH /agents/{agentId}/convos/{convoId}","href":"/api-reference/v3/conversations/update"},{"title":"Update Conversation Messages","openapi":"PATCH /agents/{agentId}/convos/{convoId}/messages","href":"/api-reference/v3/conversations/update_messages"},{"title":"Send Message to Conversation","openapi":"POST /agents/{agentId}/convos/{convoId}/send","href":"/api-reference/v3/conversations/send"},{"title":"Get Agent Conversations","openapi":"GET /agents/{agentId}/convos","href":"/api-reference/v3/conversations/get"},{"title":"Get Single Conversation","openapi":"GET /agents/{agentId}/convos/{convoId}","href":"/api-reference/v3/conversations/get_id"},{"title":"Delete Conversation","openapi":"DELETE /agents/{agentId}/convos/{convoId}","href":"/api-reference/v3/conversations/delete"},{"title":"Export Agent Conversations","openapi":"GET /agents/{agentId}/convos/export","href":"/api-reference/v3/conversations/export"},{"title":"Export Single Conversation","openapi":"GET /agents/{agentId}/convos/{convoId}/export","href":"/api-reference/v3/conversations/export_single"}]},{"group":"Numbers and Telephony","icon":"phone","pages":[{"title":"Outbound Voice Call","openapi":"POST /calls","href":"/api-reference/v3/calls/post"},{"title":"Send Outbound SMS","openapi":"POST /sms","href":"/api-reference/v3/sms/post"},{"title":"Send SMS to Leads (bulk)","openapi":"POST /smsLeads","href":"/api-reference/v3/sms/sms-leads"}]},{"group":"Voices","icon":"microphone","pages":[{"title":"Voices API","href":"/api-reference/v3/voices/intro"},{"title":"List voice providers","openapi":"GET /voices/providers","href":"/api-reference/v3/voices/list-providers"},{"title":"List a provider's TTS models","openapi":"GET /voices/{provider}/models","href":"/api-reference/v3/voices/list-provider-models"},{"title":"List voices (unified)","openapi":"GET /voices","href":"/api-reference/v3/voices/list-voices"},{"title":"List a provider's voices","openapi":"GET /voices/{provider}","href":"/api-reference/v3/voices/list-provider-voices"},{"title":"Get a voice","openapi":"GET /voices/{provider}/{voiceId}","href":"/api-reference/v3/voices/get-voice"},{"title":"Search available Twilio numbers","openapi":"POST /utils/twilio/available-numbers","href":"/api-reference/v3/voices/available-numbers"},{"title":"Import a Twilio number","openapi":"POST /utils/import-twilio-number","href":"/api-reference/v3/voices/import-twilio-number"},{"title":"Buy a Twilio number","openapi":"POST /utils/buy-twilio-number","href":"/api-reference/v3/voices/buy-twilio-number"},{"title":"Verify Twilio number webhooks","openapi":"POST /utils/twilio/check-number","href":"/api-reference/v3/voices/check-number"},{"title":"Release a Twilio number","openapi":"POST /utils/twilio/release-number","href":"/api-reference/v3/voices/release-number"},{"title":"Assign Twilio number to agent (SMS)","openapi":"POST /utils/twilio/sync-sms","href":"/api-reference/v3/voices/sync-sms"}]},{"group":"Tools","icon":"wrench","pages":[{"title":"List Default LLM Tools","openapi":"GET /tools/defaults","href":"/api-reference/v3/tools/defaults"},{"title":"Create Tool","openapi":"POST /agents/{agentId}/tools","href":"/api-reference/v3/tools/post"},{"title":"Get Tools","openapi":"GET /agents/{agentId}/tools","href":"/api-reference/v3/tools/get"},{"title":"Get Tool By ID","openapi":"GET /tools/{toolId}","href":"/api-reference/v3/tools/get_id"},{"title":"Delete Tool","description":"Deletes a tool, this route must use the new V3 [endpoints](/api-reference/v3/intro).","openapi":"DELETE /tools/{toolId}","href":"/api-reference/v3/tools/delete"},{"title":"Update Tool","openapi":"PATCH /tools/{toolId}","href":"/api-reference/v3/tools/update"}]},{"group":"Variables","icon":"code","pages":[{"title":"Create Variable","description":"Creates a new variable, this route must use the new V3 [endpoints](/api-reference/v3/intro).","openapi":"POST /agents/{agentId}/variables","href":"/api-reference/v3/variables/post"},{"title":"Get Variables","openapi":"GET /agents/{agentId}/variables","href":"/api-reference/v3/variables/get"},{"title":"Get Variable By ID","openapi":"GET /variables/{variableId}","href":"/api-reference/v3/variables/get_id"},{"title":"Delete Variable","openapi":"DELETE /variables/{variableId}","href":"/api-reference/v3/variables/delete"},{"title":"Update Variable","openapi":"PATCH /variables/{variableId}","href":"/api-reference/v3/variables/update"}]},{"group":"Leads","icon":"users","pages":[{"title":"Create Lead","openapi":"POST /leads","href":"/api-reference/v3/leads/post"},{"title":"Get Leads","openapi":"GET /leads","href":"/api-reference/v3/leads/get"},{"title":"Get Lead By ID","openapi":"GET /leads/{id}","href":"/api-reference/v3/leads/get_id"},{"title":"Delete Lead","openapi":"DELETE /leads/{id}","href":"/api-reference/v3/leads/delete"},{"title":"Update Lead","openapi":"PATCH /leads/{id}","href":"/api-reference/v3/leads/update"}]},{"group":"Agency","icon":"building-columns","pages":[{"title":"Get Agency","openapi":"GET /agency","href":"/api-reference/v3/agency/getAgency"},{"title":"Create or Update Agency","openapi":"POST /agency","href":"/api-reference/v3/agency/upsertAgency"},{"title":"Delete Agency","openapi":"DELETE /agency","href":"/api-reference/v3/agency/deleteAgency"}]},{"group":"Orgs","icon":"building","pages":[{"title":"Get All Organizations","openapi":"GET /orgs","href":"/api-reference/v3/orgs/getAllOrgs"},{"title":"Search Organizations","openapi":"GET /orgs/search","href":"/api-reference/v3/orgs/searchOrgs"},{"title":"Create Organization","openapi":"POST /orgs","href":"/api-reference/v3/orgs/createOrg"},{"title":"Get Organization","openapi":"GET /orgs/{orgId}","href":"/api-reference/v3/orgs/getOrgById"},{"title":"Update Organization","openapi":"PATCH /orgs/{orgId}","href":"/api-reference/v3/orgs/updateOrg"},{"title":"Delete Organization","openapi":"DELETE /orgs/{orgId}","href":"/api-reference/v3/orgs/deleteOrg"},{"title":"Get Organization Agents","openapi":"GET /orgs/{orgId}/agents","href":"/api-reference/v3/orgs/getOrgAgents"},{"title":"Assign Organization Agent","openapi":"POST /orgs/{orgId}/agents/{agentId}","href":"/api-reference/v3/orgs/assignOrgAgent"},{"title":"Get Organization Clients","openapi":"GET /orgs/{orgId}/clients","href":"/api-reference/v3/orgs/getOrgClients"},{"title":"Get Organization Members and Teams","openapi":"GET /orgs/{orgId}/members-and-teams","href":"/api-reference/v3/orgs/getOrgMembersAndTeams"},{"title":"List Organization Teams","openapi":"GET /orgs/{orgId}/teams","href":"/api-reference/v3/orgs/listOrgTeams"},{"title":"Create Organization Team","openapi":"POST /orgs/{orgId}/teams","href":"/api-reference/v3/orgs/createOrgTeam"},{"title":"Update Organization Team","openapi":"PATCH /orgs/{orgId}/teams/{teamId}","href":"/api-reference/v3/orgs/updateOrgTeam"},{"title":"Delete Organization Team","openapi":"DELETE /orgs/{orgId}/teams/{teamId}","href":"/api-reference/v3/orgs/deleteOrgTeam"}]},{"group":"Clients","icon":"user-group","pages":[{"title":"List Clients","openapi":"GET /clients","href":"/api-reference/v3/clients/listClients"},{"title":"Create Client","openapi":"POST /clients","href":"/api-reference/v3/clients/createClient"},{"title":"Get Client","openapi":"GET /clients/{clientId}","href":"/api-reference/v3/clients/getClient"},{"title":"Update Client","openapi":"POST /clients/update","href":"/api-reference/v3/clients/updateClient"},{"title":"Delete Client","openapi":"DELETE /clients/{clientId}","href":"/api-reference/v3/clients/deleteClient"},{"title":"Check Client Email","openapi":"POST /clients/check-email","href":"/api-reference/v3/clients/checkEmail"},{"title":"Change Client Password","openapi":"POST /clients/{clientId}/change-password","href":"/api-reference/v3/clients/changePassword"}]},{"group":"Custom Metrics","icon":"chart-line","pages":[{"title":"List Custom Metrics","openapi":"GET /agents/{agentId}/custom-metrics","href":"/api-reference/v3/customMetrics/listMetrics"},{"title":"Get Single Metric","openapi":"GET /agents/{agentId}/custom-metrics/{metricId}","href":"/api-reference/v3/customMetrics/getMetric"},{"title":"Create Custom Metric","openapi":"POST /agents/{agentId}/custom-metrics","href":"/api-reference/v3/customMetrics/createMetric"},{"title":"Update Custom Metric","openapi":"PUT /agents/{agentId}/custom-metrics/{metricId}","href":"/api-reference/v3/customMetrics/updateMetric"},{"title":"Delete Custom Metric","openapi":"DELETE /agents/{agentId}/custom-metrics/{metricId}","href":"/api-reference/v3/customMetrics/deleteMetric"},{"title":"Get Metric Data","openapi":"GET /agents/{agentId}/custom-metrics/{metricKey}/data","href":"/api-reference/v3/customMetrics/getMetricData"},{"title":"Get All Metrics Data","openapi":"GET /agents/{agentId}/custom-metrics/data","href":"/api-reference/v3/customMetrics/getAllMetricsData"}]},{"group":"Crawler","icon":"globe","pages":[{"title":"Create Crawler Job","openapi":"POST /workspaces/{workspaceId}/crawler/jobs","href":"/api-reference/v3/crawler/createJob"},{"title":"List Crawler Jobs","openapi":"GET /workspaces/{workspaceId}/crawler/jobs","href":"/api-reference/v3/crawler/listJobs"},{"title":"Get Crawler Job","openapi":"GET /workspaces/{workspaceId}/crawler/jobs/{jobId}","href":"/api-reference/v3/crawler/getJob"},{"title":"Delete Crawler Job","openapi":"DELETE /workspaces/{workspaceId}/crawler/jobs/{jobId}","href":"/api-reference/v3/crawler/deleteJob"},{"title":"List Crawler Job Pages","openapi":"GET /workspaces/{workspaceId}/crawler/jobs/{jobId}/pages","href":"/api-reference/v3/crawler/listJobPages"},{"title":"Get Crawler Job Page","openapi":"GET /workspaces/{workspaceId}/crawler/jobs/{jobId}/pages/{pageId}","href":"/api-reference/v3/crawler/getJobPage"}]},{"group":"Workspaces","icon":"users","pages":[{"title":"Create Workspace","openapi":"POST /workspaces","href":"/api-reference/v3/workspaces/post"},{"title":"Workspace Usage","openapi":"POST /workspaces/{uid}/usage","href":"/api-reference/v3/workspaces/usage/get"},{"title":"Get Workspace By ID","openapi":"GET /workspaces/{id}","href":"/api-reference/v3/workspaces/get_id"},{"title":"Get Workspaces","openapi":"GET /workspaces","href":"/api-reference/v3/workspaces/get"},{"title":"Delete Workspace","openapi":"DELETE /workspaces/{id}","href":"/api-reference/v3/workspaces/delete"},{"title":"Update Workspace","openapi":"PATCH /workspaces/{id}","href":"/api-reference/v3/workspaces/update"}]}]},{"group":"Message Agent","icon":"plug","pages":[{"group":"Websockets","pages":[{"asyncapi":"api-reference/asyncapi/interact.yaml interact","href":"/api-reference/asyncapi/interact/websockets/interact-channel","title":"Interact channel","version":null}]}]},{"group":"V2 (Legacy)","pages":[{"title":"Introduction","href":"/api-reference/agents/intro"},{"group":"Agents","icon":"robot","pages":[{"title":"Get Agent","openapi":"GET /v2/agents/{agent_id}","href":"/api-reference/agents/get"},{"title":"Create/Edit Agent","openapi":"POST /v2/agents/{agent_id}","href":"/api-reference/agents/post"},{"title":"Delete Agent","openapi":"DELETE /v2/agents/{agent_id}","href":"/api-reference/agents/delete"},{"title":"Chat Interact","openapi":"POST /agents/{agent_id}/interact/{user_id}","href":"/api-reference/agents/interact/post"},{"title":"Configure State","openapi":"POST /agents/{agent_id}/interact/{user_id}/state","href":"/api-reference/agents/state/post"},{"group":"Knowledge Base","icon":"brain","pages":[{"title":"Get Single KB Doc","openapi":"GET /v2/agents/{agent_id}/kb/{doc_id}","href":"/api-reference/agents/kb/get-single"},{"title":"Create/Edit KB Doc","openapi":"PUT /v2/agents/{agent_id}/kb/{doc_id}","href":"/api-reference/agents/kb/put"},{"title":"Delete KB Doc","openapi":"DELETE /v2/agents/{agent_id}/kb/{doc_id}","href":"/api-reference/agents/kb/delete"},{"title":"Get KB Docs","openapi":"GET /v2/agents/{agent_id}/kb","href":"/api-reference/agents/kb/get"},{"title":"Search KB Docs","openapi":"POST /v2/agents/{agent_id}/kb/search","href":"/api-reference/agents/kb/post"},{"title":"Search Vector DB","openapi":"POST /v2/agents/{agent_id}/kb/vector_search","href":"/api-reference/agents/kb/vector_search"},{"title":"Get KB Stats","openapi":"GET /v2/agents/{agent_id}/stats/kb","href":"/api-reference/agents/kb/stats"}]},{"group":"Conversations","icon":"square-minus","pages":[{"title":"Get All Convos","openapi":"GET /v2/agents/{agent_id}/convos","href":"/api-reference/agents/convos/get"},{"title":"Export Convos","openapi":"GET /v2/agents/{agent_id}/convos/export","href":"/api-reference/agents/convos/export"},{"title":"Create/Edit Convo","openapi":"POST /v2/agents/{agent_id}/convos/{convo_id}","href":"/api-reference/agents/convos/post"},{"title":"Delete Convo","openapi":"DELETE /v2/agents/{agent_id}/convos/{convo_id}","href":"/api-reference/agents/convos/delete"}]},{"group":"Analytics","icon":"chart-column","pages":[{"title":"Get All Analytics","openapi":"GET /v2/agents/{agent_id}/analytics","href":"/api-reference/agents/analytics/get-multi"},{"title":"Get Convo Analytics","openapi":"GET /v2/agents/{agent_id}/analytics/{convo_id}","href":"/api-reference/agents/analytics/get-single"},{"title":"Create/Edit Analytics","openapi":"POST /v2/agents/{agent_id}/analytics/{convo_id}","href":"/api-reference/agents/analytics/post-single"},{"title":"Delete Convo Analytics","openapi":"DELETE /v2/agents/{agent_id}/analytics/{convo_id}","href":"/api-reference/agents/analytics/delete-single"},{"title":"Delete All Analytics","openapi":"DELETE /v2/agents/{agent_id}/analytics","href":"/api-reference/agents/analytics/delete-multi"}]}]},{"group":"Workspaces","icon":"users","pages":[{"title":"Get Workspace","openapi":"GET /v2/workspaces","href":"/api-reference/workspaces/get"},{"title":"Edit Workspace","openapi":"POST /v2/workspaces","href":"/api-reference/workspaces/post"},{"title":"Delete Workspace","openapi":"DELETE /v2/workspaces","href":"/api-reference/workspaces/delete"},{"group":"Agency","icon":"hotel","pages":[{"title":"Get Agency","openapi":"GET /v2/agencies","href":"/api-reference/workspaces/agencies/get"},{"title":"Edit/Create Agency","openapi":"POST /v2/agencies","href":"/api-reference/workspaces/agencies/post"},{"title":"Delete Agency","openapi":"DELETE /v2/agencies","href":"/api-reference/workspaces/agencies/delete"}]},{"group":"Orgs","icon":"building","pages":[{"title":"Get Org Clients","openapi":"GET /v2/orgs","href":"/api-reference/workspaces/orgs/@get"},{"title":"New Org Client","openapi":"PUT /v2/orgs","href":"/api-reference/workspaces/orgs/@put"},{"title":"Get Org Client","openapi":"GET /v2/orgs/{org_id}","href":"/api-reference/workspaces/orgs/get"},{"title":"Edit Org Client","openapi":"POST /v2/orgs/{org_id}","href":"/api-reference/workspaces/orgs/post"},{"title":"Delete Org Client","openapi":"DELETE /v2/orgs/{org_id}","href":"/api-reference/workspaces/orgs/delete"}]},{"group":"Clients","icon":"handshake","pages":[{"title":"Get Clients","openapi":"GET /v2/clients","href":"/api-reference/workspaces/clients/@get"},{"title":"New Client","openapi":"PUT /v2/clients","href":"/api-reference/workspaces/clients/@put"},{"title":"Get Client","openapi":"GET /v2/clients/{client_id}","href":"/api-reference/workspaces/clients/get"},{"title":"Edit Client","openapi":"POST /v2/clients/{client_id}","href":"/api-reference/workspaces/clients/post"},{"title":"Delete Client","openapi":"DELETE /v2/clients/{client_id}","href":"/api-reference/workspaces/clients/delete"}]}]}]}]}]},"basePath":"","title":"Update Tool - Convocore","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}