Creates a new API tool configuration for the application. Use this endpoint to define a custom API endpoint that agents can call during conversations. Uniqueness: The slug must be unique per appl
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"CometChat Docs","description":"Technical documentation \u0026 Implementation guides to add In-app Messaging \u0026 Voice \u0026 Video Calling to your apps and websites in minutes.","colors":{"primary":"#6851D6","light":"#6851D6","dark":"#6851D6"},"logo":{"light":"https://mintcdn.com/cometchat-22654f5b/rnJE5Ok_8RIDEPUR/logo/light.svg?fit=max\u0026auto=format\u0026n=rnJE5Ok_8RIDEPUR\u0026q=85\u0026s=461a8ced4bf934b4f3a2770f090f2d3c","dark":"https://mintcdn.com/cometchat-22654f5b/rnJE5Ok_8RIDEPUR/logo/dark.svg?fit=max\u0026auto=format\u0026n=rnJE5Ok_8RIDEPUR\u0026q=85\u0026s=12aa48fcf137edde64a9539360548174"},"favicon":"https://mintcdn.com/cometchat-22654f5b/8ODUflBxloB1jkgP/favicon.png?fit=max\u0026auto=format\u0026n=8ODUflBxloB1jkgP\u0026q=85\u0026s=b5c68dc37f6a82e5cfb5f96746e433c8","navbar":{"links":[{"href":"https://app.cometchat.com/","label":"Dashboard"}],"primary":{"type":"button","label":"Contact Support","href":"https://help.cometchat.com/hc/en-us/requests/new"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/cometchat","x":"https://twitter.com/CometChat","github":"https://www.github.com/cometchat"}},"seo":{"metatags":{"charset":"UTF-8","viewport":"width=device-width, initial-scale=1.0","description":"Learn how to integrate, customize, and scale real-time chat using CometChat’s UI Kits, SDKs, and widgets across popular frameworks. Get step-by-step guides, best practices, and implementation details to build production-ready chat experiences.","language":"en"},"indexing":"all"},"errors":{"404":{"redirect":true}},"contextual":{"options":["claude","cursor","chatgpt","vscode","perplexity","mcp","copy"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cometchat-22654f5b","hasAudioNarration":false,"actualSubdomain":"cometchat-22654f5b","customDomains":["www.cometchat.com"],"gitSource":{"type":"github","owner":"cometchat","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad8adbaace1a45c00d9ce01","collectionId":"bf9927bc-3d8d-4a73-bb68-ef43fbe81e1d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad8adbaace1a45c00d9ce01"},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"}},"buildId":"6ad8adbaace1a45c00d9ce01","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"Chat \u0026 Messaging","count":2616},{"language":"default","tag":"UI Kits","count":1327},{"language":"default","tag":"SDKs","count":907},{"language":"default","tag":"Components","count":677},{"language":"default","tag":"Android","count":491},{"language":"default","tag":"APIs","count":473},{"language":"default","tag":"Flutter","count":400},{"language":"default","tag":"iOS","count":370},{"language":"default","tag":"React Native","count":360},{"language":"default","tag":"React","count":320}]},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"help@cometchat.com","showHelpButton":true}},"hasChatPermissions":true,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"assets/feedback-support-ticket.css","content":".feedback-toolbar>div:has(#feedback-thumbs-up){justify-content:flex-start;gap:.75rem}.feedback-toolbar>div>div:has(#feedback-thumbs-up){display:contents}.feedback-toolbar>div>div>div:has(>#feedback-support-ticket),.feedback-toolbar>div>div>div:has(>a[href*=\"github.com\"]){flex-wrap:wrap}@media (min-width:640px){.feedback-toolbar #feedback-thumbs-down{margin-right:1.5rem}}"},{"filePath":"assets/version-selector-placement.css","content":"@media (min-width:1024px){#sidebar-content .text-sm.relative>.pl-2{position:sticky;top:0;z-index:20;background-color:var(--color-background-light)}.dark #sidebar-content .text-sm.relative>.pl-2{background-color:var(--color-background-dark)}#sidebar-content .text-sm.relative>.pl-2::before{content:\"\";position:absolute;left:0;right:0;top:-16px;height:16px;background-color:inherit}#sidebar-content .text-sm.relative>.pl-2>button[aria-haspopup=menu]{width:195px;max-width:195px}#navbar .hidden.lg\\:flex.items-center.gap-x-2{position:absolute;top:123px;left:195px;z-index:30}}@media (max-width:1023.98px){#mobile-nav #navigation-items{display:flex;flex-direction:column;gap:.5rem}#mobile-nav #navigation-items>.flex.flex-col.gap-y-2.mb-6{display:contents}#mobile-nav #navigation-items>button:nth-of-type(1){order:1}#mobile-nav #navigation-items>.flex.flex-col.gap-y-2.mb-6>.flex.flex-wrap.gap-2{order:2}#mobile-nav #navigation-items>button:nth-of-type(2){order:3}#mobile-nav #navigation-items>.flex.flex-col.gap-y-2.mb-6>button{order:4}#mobile-nav #navigation-items>.mt-6{order:5}}"},{"filePath":"assets/global-fixes.css","content":".nav-dropdown-products-selector-trigger{border-radius:999px!important;border:1px solid rgba(15,23,42,.15);transition:border-color .2s ease,background-color .2s ease;width:12rem;max-width:12rem;flex:0 0 12rem;overflow:visible}@media (max-width:1023.98px){#mobile-nav .nav-dropdown-products-selector-trigger{width:auto;max-width:none;flex:initial;border-radius:.85rem!important}}html.dark .nav-dropdown-products-selector-trigger{border-color:rgba(226,232,240,.2)}.nav-dropdown-products-selector-trigger:hover,.nav-dropdown-products-selector-trigger[aria-expanded=true]{border-color:rgba(104,81,214,.7)}.nav-dropdown-products-selector-trigger>span{max-width:none!important;white-space:normal!important;-webkit-line-clamp:unset!important;display:inline!important}.prose :where(img):not(:where([class~=not-prose],[class~=not-prose] *)){margin-top:0;margin-bottom:0}:not(pre)>code{padding:.125rem 0}#content-area #header .mt-2.text-lg p{font-size:.875rem!important;line-height:1.375rem!important}#sidebar-content div.w-\\[78px\\].h-\\[21px\\]{width:auto!important;white-space:nowrap!important;padding:2px 6px!important}"}],"page":{"pagePath":"rest-api/ai-agents-apis/custom-api-tools/create-api-tool","slug":"/rest-api/ai-agents-apis/custom-api-tools/create-api-tool","pageMetadata":{"openapi":"post /ai-agents/agent-builder/api-tools","description":"Creates a new API tool configuration for the application. Use this endpoint to define a custom API endpoint that agents can call during conversations. **Uniqueness:** The slug must be unique per appl","title":"Create API Tool","href":"/rest-api/ai-agents-apis/custom-api-tools/create-api-tool"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Creates a new API tool configuration for the application. Use this endpoint to define a custom API endpoint that agents can call during conversations. \", _jsx(_components.strong, {\n children: \"Uniqueness:\"\n }), \" The slug must be unique per appl\"]\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`For the complete error reference, see `,_jsx(_components.a,{href:`/rest-api/ai-agents-apis/error-codes`,children:`Error Guide`}),`.`]})}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 /ai-agents/agent-builder/api-tools","description":"Creates a new API tool configuration for the application. Use this endpoint to define a custom API endpoint that agents can call during conversations. **Uniqueness:** The slug must be unique per appl","title":"Create API Tool","href":"/rest-api/ai-agents-apis/custom-api-tools/create-api-tool"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/cometchat-22654f5b/36ac8063d2fb5fe5/assets/consent.js","/docs/_mintlify/custom/cometchat-22654f5b/5c3dfb209223f9f6/assets/feedback-support-ticket.js"],"openApiReferenceData":{"operation":{"operationId":"ApiToolsController_createApiTool","parameters":[],"requestBody":"55fe0288-908d-426a-9d79-6b10a6052d04","responses":{"201":"01cb4c2e-14f8-4481-8bdb-4cc0df4d7a97"},"security":["41da81b7-91f8-42a9-bf5c-9e0bdba3e2e8"],"tags":["Agent Builder API Tools"],"description":"Creates a new API tool configuration for the application. Use this endpoint to define a custom API endpoint that agents can call during conversations. **Uniqueness:** The slug must be unique per appl","summary":"Create API Tool","method":"post","type":"path","servers":["ac5c73a8-6b3b-4cfa-b4ba-062310da4e2b"],"path":"/ai-agents/agent-builder/api-tools","baseUrlOptions":["https://{appId}.api-{region}.cometchat.io/v3"],"title":"Create API Tool","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","description":"Slug for the API tool (unique)","example":"create_lead","isRequired":true,"uniqueKey":"slug","typeLabel":"string"},"description":{"type":"string","description":"Description of the API tool","example":"When to use, preconditions, what it returns","isRequired":true,"uniqueKey":"description","typeLabel":"string"},"endpoint":{"type":"string","description":"API endpoint URL","example":"https://api.example.com/leads","isRequired":true,"uniqueKey":"endpoint","typeLabel":"string"},"method":{"type":"string","description":"HTTP method","example":"POST","enum":["GET","POST","PUT","PATCH","DELETE"],"isRequired":true,"uniqueKey":"method","typeLabel":"enum\u003cstring>"},"enableBasicAuth":{"type":"boolean","description":"Whether to enable basic authentication","example":true,"isRequired":true,"uniqueKey":"enableBasicAuth","typeLabel":"boolean"},"name":{"type":"string","description":"Name of the API tool","example":"Create Lead","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"basicAuthUsername":{"type":"string","description":"Basic auth username (required if enableBasicAuth is true)","example":"username","uniqueKey":"basicAuthUsername","typeLabel":"string"},"basicAuthPassword":{"type":"string","description":"Basic auth password (required if enableBasicAuth is true)","example":"password","uniqueKey":"basicAuthPassword","typeLabel":"string"},"headers":{"type":"string","description":"HTTP headers as a JSON string (e.g., '{\"Content-Type\": \"application/json\", \"Authorization\": \"Bearer token\"}')","example":"{\"Content-Type\": \"application/json\", \"Authorization\": \"Bearer token\"}","uniqueKey":"headers","typeLabel":"string"},"bodyTemplate":{"type":"string","description":"Body template for the API request","example":"{\"name\": \"{{name}}\", \"email\": \"{{email}}\"}","uniqueKey":"bodyTemplate","typeLabel":"string"},"allowAdditionalProperties":{"type":"boolean","description":"Whether to allow additional properties","example":false,"default":false,"uniqueKey":"allowAdditionalProperties","typeLabel":"boolean"},"parameters":{"description":"Array of parameters for the API tool","type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Parameter key/name","example":"email","isRequired":true,"uniqueKey":"parameters.items.[INDEX].key","typeLabel":"string"},"type":{"type":"string","description":"Parameter type","example":"string","isRequired":true,"uniqueKey":"parameters.items.[INDEX].type","typeLabel":"string"},"description":{"type":"string","description":"Parameter description","example":"Email of the lead","isRequired":true,"uniqueKey":"parameters.items.[INDEX].description","typeLabel":"string"},"required":{"type":"boolean","description":"Whether the parameter is required","example":false,"uniqueKey":"parameters.items.[INDEX].required","typeLabel":"boolean"}},"required":["key","type","description"],"uniqueKey":"parameters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"parameters","typeLabel":"object[]"},"icon":{"type":"string","description":"Icon for the API Tool","example":"http://localhost:3001","uniqueKey":"icon","typeLabel":"string"}},"required":["slug","description","endpoint","method","enableBasicAuth","name"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"slug":"create_lead","description":"When to use, preconditions, what it returns","endpoint":"https://api.example.com/leads","method":"POST","enableBasicAuth":true,"name":"Create Lead","basicAuthUsername":"username","basicAuthPassword":"password","headers":"{\"Content-Type\": \"application/json\", \"Authorization\": \"Bearer token\"}","bodyTemplate":"{\"name\": \"{{name}}\", \"email\": \"{{email}}\"}","allowAdditionalProperties":false,"parameters":[{"key":"email","type":"string","description":"Email of the lead","required":false}],"icon":"http://localhost:3001"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"01cb4c2e-14f8-4481-8bdb-4cc0df4d7a97":{"description":"API tool created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"_id":{"type":"string","example":"myapp_my-api-tool","uniqueKey":"_id","typeLabel":"string"},"appId":{"type":"string","example":"my-app-id","uniqueKey":"appId","typeLabel":"string"},"slug":{"type":"string","example":"my-api-tool","uniqueKey":"slug","typeLabel":"string"},"name":{"type":"string","example":"My API Tool","uniqueKey":"name","typeLabel":"string"},"description":{"type":"string","example":"Calls an external API","uniqueKey":"description","typeLabel":"string"},"icon":{"type":"string","example":"https://example.com/icon.png","uniqueKey":"icon","typeLabel":"string"},"endpoint":{"type":"string","example":"https://api.example.com/search","uniqueKey":"endpoint","typeLabel":"string"},"method":{"type":"string","example":"GET","uniqueKey":"method","typeLabel":"string"},"enableBasicAuth":{"type":"boolean","example":false,"uniqueKey":"enableBasicAuth","typeLabel":"boolean"},"headers":{"oneOf":[{"type":"string","example":"{\"Content-Type\":\"application/json\"}","uniqueKey":"headers.oneOf.0","typeLabel":"string"},{"type":"null","example":"{\"Content-Type\":\"application/json\"}","uniqueKey":"headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"headers","typeLabel":"string | null"},"bodyTemplate":{"oneOf":[{"type":"string","example":"{\"query\":\"{{query}}\"}","uniqueKey":"bodyTemplate.oneOf.0","typeLabel":"string"},{"type":"null","example":"{\"query\":\"{{query}}\"}","uniqueKey":"bodyTemplate.oneOf.1","typeLabel":"null"}],"uniqueKey":"bodyTemplate","typeLabel":"string | null"},"allowAdditionalProperties":{"type":"boolean","example":false,"uniqueKey":"allowAdditionalProperties","typeLabel":"boolean"},"parameters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"query","uniqueKey":"parameters.items.[INDEX].key","typeLabel":"string"},"type":{"type":"string","example":"string","uniqueKey":"parameters.items.[INDEX].type","typeLabel":"string"},"description":{"type":"string","example":"The search query","uniqueKey":"parameters.items.[INDEX].description","typeLabel":"string"},"required":{"type":"boolean","example":true,"uniqueKey":"parameters.items.[INDEX].required","typeLabel":"boolean"}},"uniqueKey":"parameters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"parameters","typeLabel":"object[]"},"tool":{"type":"object","properties":{"name":{"type":"string","example":"my-api-tool","uniqueKey":"tool.name","typeLabel":"string"},"description":{"type":"string","example":"Calls an external API","uniqueKey":"tool.description","typeLabel":"string"},"parameters":{"type":"object","example":{"type":"object","properties":{},"required":[]},"uniqueKey":"tool.parameters","typeLabel":"object"}},"uniqueKey":"tool","typeLabel":"object"},"createdAt":{"type":"number","example":1700000000000,"uniqueKey":"createdAt","typeLabel":"number"},"updatedAt":{"type":"number","example":1700000000000,"uniqueKey":"updatedAt","typeLabel":"number"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_id":"myapp_my-api-tool","appId":"my-app-id","slug":"my-api-tool","name":"My API Tool","description":"Calls an external API","icon":"https://example.com/icon.png","endpoint":"https://api.example.com/search","method":"GET","enableBasicAuth":false,"headers":"{\"Content-Type\":\"application/json\"}","bodyTemplate":"{\"query\":\"{{query}}\"}","allowAdditionalProperties":false,"parameters":[{"key":"query","type":"string","description":"The search query","required":true}],"tool":{"name":"my-api-tool","description":"Calls an external API","parameters":{"type":"object","properties":{},"required":[]}},"createdAt":1700000000000,"updatedAt":1700000000000}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"41da81b7-91f8-42a9-bf5c-9e0bdba3e2e8":{"apiKey":{"type":"apiKey","description":"API Key (i.e. Rest API Key from the Dashboard).","name":"apikey","in":"header","scopes":[]}}},"servers":{"ac5c73a8-6b3b-4cfa-b4ba-062310da4e2b":{"url":"https://{appId}.api-{region}.cometchat.io/v3","variables":{"appId":{"default":"appId","description":"(Required) App ID"},"region":{"enum":["us","eu","in"],"default":"us","description":"Select Region"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"API Key (i.e. Rest API Key from the Dashboard).","name":"apikey","in":"header","scopes":[]},"schema":{"title":"apikey","type":"string","description":"API Key (i.e. Rest API Key from the Dashboard).","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"apikey"}],"title":"apiKey"}]},"originalFileLocation":"ai-agent-service.json"},"subdomain":"cometchat-22654f5b","siteName":"CometChat Docs","title":"Create API Tool - CometChat Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-27T14:34:36.609Z","originalFileLocation":"rest-api/ai-agents-apis/custom-api-tools/create-api-tool.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates a new API tool configuration for the application. Use this endpoint to define a custom API endpoint that agents can call during conversations. Uniqueness: The slug must be unique per appl\">\u003cmeta data-mint-head name=\"application-name\" content=\"CometChat Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/cometchat-22654f5b/9HQD26P0kBVs3M5H/_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=\"/docs/mintlify-assets/_mintlify/favicons/cometchat-22654f5b/9HQD26P0kBVs3M5H/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/cometchat-22654f5b/9HQD26P0kBVs3M5H/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/cometchat-22654f5b/9HQD26P0kBVs3M5H/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/cometchat-22654f5b/9HQD26P0kBVs3M5H/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/cometchat-22654f5b/9HQD26P0kBVs3M5H/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/cometchat-22654f5b/9HQD26P0kBVs3M5H/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/cometchat-22654f5b/9HQD26P0kBVs3M5H/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/cometchat-22654f5b/9HQD26P0kBVs3M5H/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create API Tool - CometChat Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new API tool configuration for the application. Use this endpoint to define a custom API endpoint that agents can call during conversations. Uniqueness: The slug must be unique per appl\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CometChat Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.cometchat.com/docs/rest-api/ai-agents-apis/custom-api-tools/create-api-tool\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cometchat-22654f5b.mintlify.app/_mintlify/api/og/v2?division=Custom+API+Tools\u0026amp;title=Create+API+Tool\u0026amp;description=Creates+a+new+API+tool+configuration+for+the+application.+Use+this+endpoint+to+define+a+custom+API+endpoint+that+agents+can+call+during+conversations.++**Unique\u0026amp;theme=49fdcba0a8a0d0cce2bd7088\u0026amp;signature=f9530c966cec30071e0488b22dfd9d390532214a46f60865f55c3726a2658771\">\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=\"Create API Tool - CometChat Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new API tool configuration for the application. Use this endpoint to define a custom API endpoint that agents can call during conversations. Uniqueness: The slug must be unique per appl\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cometchat-22654f5b.mintlify.app/_mintlify/api/og/v2?division=Custom+API+Tools\u0026amp;title=Create+API+Tool\u0026amp;description=Creates+a+new+API+tool+configuration+for+the+application.+Use+this+endpoint+to+define+a+custom+API+endpoint+that+agents+can+call+during+conversations.++**Unique\u0026amp;theme=49fdcba0a8a0d0cce2bd7088\u0026amp;signature=f9530c966cec30071e0488b22dfd9d390532214a46f60865f55c3726a2658771\">\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=\"/docs/mintlify-assets/_mintlify/favicons/cometchat-22654f5b/9HQD26P0kBVs3M5H/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"CometChat Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6851D6\">\u003cmeta data-mint-head name=\"charset\" content=\"UTF-8\">\u003cmeta data-mint-head name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\u003cmeta data-mint-head name=\"language\" content=\"en\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.cometchat.com/docs/rest-api/ai-agents-apis/custom-api-tools/create-api-tool\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/rest-api/ai-agents-apis/custom-api-tools/create-api-tool.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.cometchat.com/#organization\",\"name\":\"CometChat Docs\",\"url\":\"https://www.cometchat.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cometchat-22654f5b/rnJE5Ok_8RIDEPUR/logo/light.svg?fit=max\u0026auto=format\u0026n=rnJE5Ok_8RIDEPUR\u0026q=85\u0026s=461a8ced4bf934b4f3a2770f090f2d3c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.cometchat.com/docs#website\",\"name\":\"CometChat Docs\",\"url\":\"https://www.cometchat.com/docs\",\"publisher\":{\"@id\":\"https://www.cometchat.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.cometchat.com/docs/rest-api/ai-agents-apis/custom-api-tools/create-api-tool#webpage\",\"url\":\"https://www.cometchat.com/docs/rest-api/ai-agents-apis/custom-api-tools/create-api-tool\",\"name\":\"Create API Tool\",\"description\":\"Creates a new API tool configuration for the application. Use this endpoint to define a custom API endpoint that agents can call during conversations. Uniqueness: The slug must be unique per appl\",\"dateModified\":\"2026-04-27T14:34:36.609Z\",\"isPartOf\":{\"@id\":\"https://www.cometchat.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.cometchat.com/docs/rest-api/ai-agents-apis/custom-api-tools/create-api-tool#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.cometchat.com/docs/rest-api/ai-agents-apis/custom-api-tools/create-api-tool#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agent Builder APIs\",\"item\":\"https://www.cometchat.com/docs/rest-api/ai-agents-apis/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Custom API Tools\",\"item\":\"https://www.cometchat.com/docs/rest-api/ai-agents-apis/custom-api-tools/list-api-tools\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create API Tool\",\"item\":\"https://www.cometchat.com/docs/rest-api/ai-agents-apis/custom-api-tools/create-api-tool\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.cometchat.com/docs/rest-api/ai-agents-apis/custom-api-tools/create-api-tool#apireference\",\"headline\":\"Create API Tool\",\"name\":\"Create API Tool\",\"description\":\"Creates a new API tool configuration for the application. Use this endpoint to define a custom API endpoint that agents can call during conversations. Uniqueness: The slug must be unique per appl\",\"url\":\"https://www.cometchat.com/docs/rest-api/ai-agents-apis/custom-api-tools/create-api-tool\",\"mainEntityOfPage\":{\"@id\":\"https://www.cometchat.com/docs/rest-api/ai-agents-apis/custom-api-tools/create-api-tool#webpage\"},\"dateModified\":\"2026-04-27T14:34:36.609Z\",\"publisher\":{\"@id\":\"https://www.cometchat.com/#organization\"},\"isPartOf\":{\"@id\":\"https://www.cometchat.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"CometChat Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"CometChat Docs","nav":{"global":null,"products":[{"product":"Home","pages":[{"title":"Home","href":""}]},{"product":"Home","hidden":true,"pages":[{"title":"Home","href":"/on-premise-deployment/docker/overview","hidden":true}]},{"product":"Chat \u0026 Messaging","pages":[{"title":"Chat \u0026 Messaging","href":"/chat-call"}]},{"product":"Voice \u0026 Video Calling","pages":[{"title":"Voice \u0026 Video Calling","href":"/calls"}]},{"product":"AI Agents","tabs":[{"tab":"AI Agents","pages":[{"title":"AI Agents","href":"/ai-agents"}]},{"tab":"Agent Builder","pages":[{"title":"Agent Builder","href":"/ai-agents/agent-builder/overview"}]},{"tab":"Bring Your Own Agent","dropdowns":[{"dropdown":"Mastra","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cometchat-22654f5b/images/icons/mastra.svg","pages":[{"title":"Create an AI Agent with Mastra","sidebarTitle":"Create AI Agent","href":"/ai-agents/mastra"},{"title":"AI Agent Actions","sidebarTitle":"Actions","href":"/ai-agents/mastra-actions"},{"title":"AI Agent Tools","sidebarTitle":"Tools","href":"/ai-agents/mastra-tools"},{"title":"RuntimeContext","href":"/ai-agents/mastra-runtime-context"},{"title":"Card Messages","sidebarTitle":"Card Messages","href":"/ai-agents/mastra-card-messages"},{"group":"Guides","pages":[{"title":"Build Your Knowledge Agent with Mastra","sidebarTitle":"Knowledge Agent","href":"/ai-agents/mastra-knowledge-agent"},{"title":"Build Your Frontend Actions Agent with Mastra","sidebarTitle":"Frontend Actions Agent","href":"/ai-agents/mastra-frontend-actions-agent"},{"title":"Build Your Backend Tools Agent with Mastra","sidebarTitle":"Backend Tools Agent","href":"/ai-agents/mastra-backend-tools-agent"},{"title":"Build Your Orchestrator Agent with Mastra","sidebarTitle":"Orchestrator Agent","href":"/ai-agents/mastra-orchestrator-agent"}]},{"group":"Tutorials","pages":[{"title":"Build a Product Hunt Agent with Mastra","sidebarTitle":"Product Hunt Agent","href":"/ai-agents/mastra-product-hunt-agent"},{"title":"Build a PDF Knowledge Agent with Mastra","sidebarTitle":"PDF Knowledge Agent","href":"/ai-agents/mastra-knowlege-agent-pdf"}]}]},{"dropdown":"CrewAI","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cometchat-22654f5b/images/icons/crew-ai.svg","pages":[{"title":"Create an AI Agent with CrewAI","sidebarTitle":"Create AI Agent","href":"/ai-agents/crew-ai"},{"title":"AI Agent Actions","sidebarTitle":"Actions","href":"/ai-agents/crew-ai-actions"},{"title":"AI Agent Tools","sidebarTitle":"Tools","href":"/ai-agents/crew-ai-tools"},{"title":"Card Messages","sidebarTitle":"Card Messages","href":"/ai-agents/crew-ai-card-messages"},{"group":"Guides","pages":[{"title":"Build Your Knowledge Agent with CrewAI","sidebarTitle":"Knowledge Agent","href":"/ai-agents/crew-ai-knowledge-agent"}]},{"group":"Tutorials","pages":[{"title":"Build a Product Hunt Agent with CrewAI","sidebarTitle":"Product Hunt Agent","href":"/ai-agents/crew-ai-product-hunt-agent"}]}]},{"dropdown":"Agno","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cometchat-22654f5b/images/icons/agno.svg","pages":[{"title":"Create an AI Agent with Agno","sidebarTitle":"Create AI Agent","href":"/ai-agents/agno"},{"title":"AI Agent Actions","sidebarTitle":"Actions","href":"/ai-agents/agno-actions"},{"title":"AI Agent Tools","sidebarTitle":"Tools","href":"/ai-agents/agno-tools"},{"title":"Card Messages","sidebarTitle":"Card Messages","href":"/ai-agents/agno-card-messages"},{"group":"Guides","pages":[{"title":"Build Your Knowledge Agent with Agno","sidebarTitle":"Knowledge Agent","href":"/ai-agents/agno-knowledge-agent"}]},{"group":"Tutorials","pages":[{"title":"Launch a Product Hunt Agent with Agno","sidebarTitle":"Product Hunt Agent","href":"/ai-agents/agno-product-hunt-agent"}]}]},{"dropdown":"Vercel AI","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cometchat-22654f5b/images/icons/vercel.png","pages":[{"title":"Create an AI Agent with Vercel AI SDK","sidebarTitle":"Create AI Agent","href":"/ai-agents/vercel"},{"title":"AI Agent Actions","sidebarTitle":"Actions","href":"/ai-agents/vercel-actions"},{"title":"AI Agent Tools","sidebarTitle":"Tools","href":"/ai-agents/vercel-tools"},{"title":"Card Messages","sidebarTitle":"Card Messages","href":"/ai-agents/vercel-card-messages"},{"group":"Guides","pages":[{"title":"Build Your Knowledge Agent with Vercel AI SDK","sidebarTitle":"Knowledge Agent","href":"/ai-agents/vercel-knowledge-agent"}]},{"group":"Tutorials","pages":[{"title":"Build a Product Hunt Agent with Vercel AI SDK","sidebarTitle":"Product Hunt Agent","href":"/ai-agents/vercel-product-hunt-agent"}]}]},{"dropdown":"LangGraph","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cometchat-22654f5b/images/icons/lang-graph.svg","pages":[{"title":"Create an AI Agent with LangGraph","sidebarTitle":"Create AI Agent","href":"/ai-agents/langgraph"},{"title":"Card Messages","sidebarTitle":"Card Messages","href":"/ai-agents/langgraph-card-messages"},{"group":"Guides","pages":[{"title":"Build Your Knowledge Agent with LangGraph","sidebarTitle":"Knowledge Agent","href":"/ai-agents/langgraph-knowledge-agent"}]},{"group":"Tutorials","pages":[{"title":"Launch a Product Hunt Agent with LangGraph","sidebarTitle":"Product Hunt Agent","href":"/ai-agents/langgraph-product-hunt-agent"}]}]},{"dropdown":"AG2","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cometchat-22654f5b/images/icons/ag2.svg","pages":[{"title":"Create an AI Agent with AG2","sidebarTitle":"Create AI Agent","href":"/ai-agents/ag2"},{"title":"AI Agent Actions","sidebarTitle":"Actions","href":"/ai-agents/ag2-actions"},{"title":"AI Agent Tools","sidebarTitle":"Tools","href":"/ai-agents/ag2-tools"},{"title":"Card Messages","sidebarTitle":"Card Messages","href":"/ai-agents/ag2-card-messages"},{"group":"Guides","pages":[{"title":"Build Your Knowledge Agent with AG2","sidebarTitle":"Knowledge Agent","href":"/ai-agents/ag2-knowledge-agent"}]},{"group":"Tutorials","pages":[{"title":"Build a Product Hunt Agent with AG2","sidebarTitle":"Product Hunt Agent","href":"/ai-agents/ag2-product-hunt-agent"}]}]},{"dropdown":"AG-UI","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cometchat-22654f5b/images/icons/agui.svg","pages":[{"title":"CometChat AG-UI Integration","sidebarTitle":"AG-UI","href":"/ai-agents/ag-ui"},{"title":"AI Agent Actions","sidebarTitle":"Actions","href":"/ai-agents/ag-ui-actions"},{"title":"AI Agent Tools","sidebarTitle":"Tools","href":"/ai-agents/ag-ui-tools"},{"title":"Card Messages","sidebarTitle":"Card Messages","href":"/ai-agents/ag-ui-card-messages"},{"group":"Guides","pages":[{"title":"CometChat AG-UI Agents","sidebarTitle":"CometChat AG-UI Agents","href":"/ai-agents/cometchat-ag-ui-byoa"}]},{"group":"Implementation","pages":[{"title":"AG-UI Express.js Implementation","sidebarTitle":"Express.js","href":"/ai-agents/cometchat-ag-ui-express"},{"title":"AG-UI NestJS Implementation","sidebarTitle":"NestJS","href":"/ai-agents/cometchat-ag-ui-nestjs"}]}]}]},{"tab":"Widget Builder","pages":[{"title":"Widget Builder","href":"/ai-agents/chat-widget"}]},{"tab":"Custom Bots","hidden":true,"pages":[{"title":"Custom Bots","href":"/ai-chatbots/custom-bots"}]},{"tab":"APIs","groups":[{"group":"BYO Agent APIs","pages":[{"title":"BYO Agent APIs","sidebarTitle":"Overview","href":"/rest-api/byo-ai-agents-apis/overview"},{"title":"Setup \u0026 Authentication","icon":"key","url":"/rest-api/authentication","href":"/rest-api/byo-ai-agents-apis/setup-and-authentication"},{"title":"Users \u0026 Groups","icon":"users","url":"/rest-api/users","href":"/rest-api/byo-ai-agents-apis/users-and-groups"},{"group":"BYO Agents","icon":"robot","expanded":false,"pages":[{"openapi":"post /ai-agents/agents","title":"Create BYO Agent","href":"/rest-api/byo-ai-agents-apis/agents/create-byo-agent"},{"openapi":"get /ai-agents/agents","title":"List BYO Agents","href":"/rest-api/byo-ai-agents-apis/agents/list-byo-agents"},{"openapi":"patch /ai-agents/agents/{uid}","title":"Update BYO Agent","href":"/rest-api/byo-ai-agents-apis/agents/update-byo-agent"},{"openapi":"delete /ai-agents/agents/{uid}","title":"Delete BYO Agent","href":"/rest-api/byo-ai-agents-apis/agents/delete-byo-agent"}]},{"group":"Tools","icon":"wrench","expanded":false,"pages":[{"openapi":"get /ai-agents/tools","title":"List Tools","href":"/rest-api/byo-ai-agents-apis/tools/list-tools"},{"openapi":"get /ai-agents/tools/{name}","title":"Get Tool","href":"/rest-api/byo-ai-agents-apis/tools/get-tool"},{"openapi":"post /ai-agents/tools","title":"Create Tool","href":"/rest-api/byo-ai-agents-apis/tools/create-tool"},{"openapi":"put /ai-agents/tools/{name}","title":"Update Tool","href":"/rest-api/byo-ai-agents-apis/tools/update-tool"},{"openapi":"delete /ai-agents/tools/{name}","title":"Delete Tool","href":"/rest-api/byo-ai-agents-apis/tools/delete-tool"}]},{"group":"Troubleshoot","icon":"circle-question","expanded":false,"pages":[{"title":"Error Codes","sidebarTitle":"Error Codes","href":"/rest-api/byo-ai-agents-apis/error-codes"},{"title":"Properties and Constraints","sidebarTitle":"Properties and Constraints","href":"/rest-api/byo-ai-agents-apis/properties-and-constraints"}]}]},{"group":"Agent Builder APIs","pages":[{"title":"Agent Builder APIs","sidebarTitle":"Overview","href":"/rest-api/ai-agents-apis/overview"},{"title":"Setup \u0026 Authentication","icon":"key","url":"/rest-api/authentication","href":"/rest-api/ai-agents-apis/setup-and-authentication"},{"title":"Users \u0026 Groups","icon":"users","url":"/rest-api/users","href":"/rest-api/ai-agents-apis/users-and-groups"},{"group":"Agents","icon":"robot","expanded":false,"pages":[{"openapi":"post /ai-agents/agent-builder/agents","title":"Create Agent","href":"/rest-api/ai-agents-apis/agents/create-agent"},{"openapi":"get /ai-agents/agent-builder/agents","title":"List Agents","href":"/rest-api/ai-agents-apis/agents/list-agents"},{"openapi":"get /ai-agents/agent-builder/agents/{uid}","title":"Get Agent","href":"/rest-api/ai-agents-apis/agents/get-agent"},{"openapi":"patch /ai-agents/agent-builder/agents/{uid}","title":"Update Agent","href":"/rest-api/ai-agents-apis/agents/update-agent"},{"openapi":"delete /ai-agents/agent-builder/agents/{uid}","title":"Delete Agent","href":"/rest-api/ai-agents-apis/agents/delete-agent"},{"openapi":"get /ai-agents/agent-builder/agents/{uid}/tools/search","title":"Search Agent Tools","href":"/rest-api/ai-agents-apis/agents/search-agent-tools"},{"openapi":"get /ai-agents/agent-builder/agents/{uid}/enabled-items","title":"List Agent Tools and Actions","href":"/rest-api/ai-agents-apis/agents/list-agent-tools-and-actions"},{"openapi":"get /ai-agents/agent-builder/agents/available-models","title":"List Available Models","href":"/rest-api/ai-agents-apis/agents/list-available-models"}]},{"group":"Tools","icon":"wrench","expanded":false,"pages":[{"openapi":"patch /ai-agents/agent-builder/agents/{uid}/tools/add","title":"Add Tools to Agent","href":"/rest-api/ai-agents-apis/tools/add-tools-to-agent"},{"openapi":"patch /ai-agents/agent-builder/agents/{uid}/tools/remove","title":"Remove Tools from Agent","href":"/rest-api/ai-agents-apis/tools/remove-tools-from-agent"},{"openapi":"get /ai-agents/agent-builder/agents/{uid}/tools/{slug}/actions","title":"Get actions available within a tool for agent","href":"/rest-api/ai-agents-apis/tools/get-tool-actions-for-agent"},{"openapi":"patch /ai-agents/agent-builder/agents/{uid}/tools/{slug}/actions/add","title":"Enable actions for a tool","href":"/rest-api/ai-agents-apis/tools/enable-tool-actions"},{"openapi":"patch /ai-agents/agent-builder/agents/{uid}/tools/{slug}/actions/remove","title":"Remove actions for a tool","href":"/rest-api/ai-agents-apis/tools/remove-tool-actions"}]},{"group":"Custom API Tools","icon":"code","expanded":false,"pages":[{"openapi":"get /ai-agents/agent-builder/api-tools","title":"List API Tools","href":"/rest-api/ai-agents-apis/custom-api-tools/list-api-tools"},{"openapi":"get /ai-agents/agent-builder/api-tools/{slug}","description":"Retrieves a single custom API tool by its slug.","title":"Get API Tool","href":"/rest-api/ai-agents-apis/custom-api-tools/get-api-tool"},{"openapi":"post /ai-agents/agent-builder/api-tools","title":"Create API Tool","href":"/rest-api/ai-agents-apis/custom-api-tools/create-api-tool"},{"openapi":"patch /ai-agents/agent-builder/api-tools/{slug}","description":"Updates an existing API tool by its slug. Use this endpoint to modify an API tool's parameters, description, or endpoint configuration.","title":"Update API Tool","href":"/rest-api/ai-agents-apis/custom-api-tools/update-api-tool"},{"openapi":"delete /ai-agents/agent-builder/api-tools/{slug}","title":"Delete API Tool","href":"/rest-api/ai-agents-apis/custom-api-tools/delete-api-tool"},{"openapi":"patch /ai-agents/agent-builder/agents/{uid}/api-tools/add","title":"Add API Tools to Agent","href":"/rest-api/ai-agents-apis/custom-api-tools/add-api-tools-to-agent"},{"openapi":"patch /ai-agents/agent-builder/agents/{uid}/api-tools/remove","title":"Remove API Tools from Agent","href":"/rest-api/ai-agents-apis/custom-api-tools/remove-api-tools-from-agent"}]},{"group":"Frontend Actions","icon":"window","expanded":false,"pages":[{"openapi":"get /ai-agents/agent-builder/frontend-actions","title":"List Frontend Actions","href":"/rest-api/ai-agents-apis/frontend-actions/list-frontend-actions"},{"openapi":"get /ai-agents/agent-builder/frontend-actions/{id}","title":"Get Frontend Action","href":"/rest-api/ai-agents-apis/frontend-actions/get-frontend-action"},{"openapi":"post /ai-agents/agent-builder/frontend-actions","title":"Create Frontend Action","href":"/rest-api/ai-agents-apis/frontend-actions/create-frontend-action"},{"openapi":"patch /ai-agents/agent-builder/frontend-actions/{id}","title":"Update Frontend Action","href":"/rest-api/ai-agents-apis/frontend-actions/update-frontend-action"},{"openapi":"delete /ai-agents/agent-builder/frontend-actions/{id}","title":"Delete Frontend Action","href":"/rest-api/ai-agents-apis/frontend-actions/delete-frontend-action"},{"openapi":"patch /ai-agents/agent-builder/agents/{uid}/frontend-actions/add","title":"Add Frontend Actions to Agent","href":"/rest-api/ai-agents-apis/frontend-actions/add-frontend-actions-to-agent"},{"openapi":"patch /ai-agents/agent-builder/agents/{uid}/frontend-actions/remove","title":"Remove Frontend Actions from Agent","href":"/rest-api/ai-agents-apis/frontend-actions/remove-frontend-actions-from-agent"}]},{"group":"MCP Servers","icon":"server","expanded":false,"pages":[{"openapi":"get /ai-agents/agent-builder/mcp-servers","title":"List MCP Servers","href":"/rest-api/ai-agents-apis/mcp-servers/list-mcp-servers"},{"openapi":"get /ai-agents/agent-builder/mcp-servers/{slug}","title":"Get MCP Server","href":"/rest-api/ai-agents-apis/mcp-servers/get-mcp-server"},{"openapi":"post /ai-agents/agent-builder/mcp-servers","title":"Create MCP Server","href":"/rest-api/ai-agents-apis/mcp-servers/create-mcp-server"},{"openapi":"patch /ai-agents/agent-builder/mcp-servers/{slug}","title":"Update MCP Server","href":"/rest-api/ai-agents-apis/mcp-servers/update-mcp-server"},{"openapi":"delete /ai-agents/agent-builder/mcp-servers/{slug}","title":"Delete MCP Server","href":"/rest-api/ai-agents-apis/mcp-servers/delete-mcp-server"},{"openapi":"patch /ai-agents/agent-builder/agents/{uid}/mcp/add","title":"Add MCP Servers to Agent","href":"/rest-api/ai-agents-apis/mcp-servers/add-mcp-servers-to-agent"},{"openapi":"patch /ai-agents/agent-builder/agents/{uid}/mcp/remove","title":"Remove MCP Servers from Agent","href":"/rest-api/ai-agents-apis/mcp-servers/remove-mcp-servers-from-agent"}]},{"group":"Knowledge Base","icon":"book","expanded":false,"pages":[{"openapi":"get /ai-agents/agent-builder/knowledge-base","title":"List Knowledge Base Records","href":"/rest-api/ai-agents-apis/knowledge-base/list-knowledge-base-records"},{"openapi":"get /ai-agents/agent-builder/knowledge-base/{sourceType}/{uniqueId}/pages","title":"Get Source Pages","href":"/rest-api/ai-agents-apis/knowledge-base/get-source-pages"},{"openapi":"patch /ai-agents/agent-builder/knowledge-base/{sourceType}/{uniqueId}/sync","title":"Retry Knowledge Base Source Indexing","href":"/rest-api/ai-agents-apis/knowledge-base/retry-knowledge-base-source-indexing"},{"openapi":"post /ai-agents/agent-builder/knowledge-base/uploads/initiate","title":"Initiate File Uploads","href":"/rest-api/ai-agents-apis/knowledge-base/initiate-file-uploads"},{"openapi":"delete /ai-agents/agent-builder/knowledge-base/uploads/{uniqueId}","title":"Delete Uploaded File","href":"/rest-api/ai-agents-apis/knowledge-base/delete-uploaded-file"},{"openapi":"get /ai-agents/agent-builder/knowledge-base/text","title":"List Text Entries","href":"/rest-api/ai-agents-apis/knowledge-base/list-text-entries"},{"openapi":"get /ai-agents/agent-builder/knowledge-base/text/{uniqueId}","title":"Get Text Entry","href":"/rest-api/ai-agents-apis/knowledge-base/get-text-entry"},{"openapi":"post /ai-agents/agent-builder/knowledge-base/text","title":"Create Text Entry","href":"/rest-api/ai-agents-apis/knowledge-base/create-text-detail"},{"openapi":"patch /ai-agents/agent-builder/knowledge-base/text/{uniqueId}","title":"Update Text Entry","href":"/rest-api/ai-agents-apis/knowledge-base/update-text-detail"},{"openapi":"delete /ai-agents/agent-builder/knowledge-base/text/{uniqueId}","title":"Delete Text Entry","href":"/rest-api/ai-agents-apis/knowledge-base/delete-text-detail"},{"openapi":"post /ai-agents/agent-builder/knowledge-base/status/poll","title":"Poll Knowledge Base Status","href":"/rest-api/ai-agents-apis/knowledge-base/poll-knowledge-base-status"},{"openapi":"patch /ai-agents/agent-builder/agents/{uid}/knowledge-base/{sourceType}/add","title":"Add Files to Agent Knowledge Base","href":"/rest-api/ai-agents-apis/knowledge-base/add-knowledge-base-files"},{"openapi":"patch /ai-agents/agent-builder/agents/{uid}/knowledge-base/{sourceType}/remove","title":"Remove Files from Agent Knowledge Base","href":"/rest-api/ai-agents-apis/knowledge-base/remove-knowledge-base-files"},{"openapi":"post /ai-agents/agent-builder/knowledge-base/website/individual-page","title":"Scrape Single Page","href":"/rest-api/ai-agents-apis/knowledge-base/scrape-single-page"},{"openapi":"post /ai-agents/agent-builder/knowledge-base/website/scrape","title":"Crawl Website","href":"/rest-api/ai-agents-apis/knowledge-base/scrape-website"},{"openapi":"get /ai-agents/agent-builder/knowledge-base/website/{parentUniqueId}/discovered-urls","title":"Get Discovered URLs","href":"/rest-api/ai-agents-apis/knowledge-base/get-discovered-urls"},{"openapi":"post /ai-agents/agent-builder/knowledge-base/website/{parentUniqueId}/discovered-urls/process","title":"Process Discovered URLs","href":"/rest-api/ai-agents-apis/knowledge-base/process-discovered-urls"},{"openapi":"delete /ai-agents/agent-builder/knowledge-base/website/{uniqueId}","title":"Delete Website","href":"/rest-api/ai-agents-apis/knowledge-base/delete-website"},{"openapi":"post /ai-agents/agent-builder/knowledge-base/website/{parentUniqueId}/discovered-urls/status/poll","title":"Poll Discovered URLs Status","href":"/rest-api/ai-agents-apis/knowledge-base/poll-discovered-urls-status"},{"openapi":"patch /ai-agents/agent-builder/knowledge-base/website/{parentUniqueId}/discovered-urls/sync","title":"Retry Indexing for Website Pages","href":"/rest-api/ai-agents-apis/knowledge-base/retry-indexing-for-website-pages"}]},{"group":"Variables","icon":"brackets-curly","expanded":false,"pages":[{"openapi":"get /ai-agents/agent-builder/agents/variables/all","title":"List All Variables","href":"/rest-api/ai-agents-apis/variables/get-all-available-variables"},{"openapi":"post /ai-agents/agent-builder/agents/variables/custom","title":"Create Custom Variable","href":"/rest-api/ai-agents-apis/variables/create-custom-variable"},{"openapi":"patch /ai-agents/agent-builder/agents/variables/custom/{variableId}","title":"Update Custom Variable","href":"/rest-api/ai-agents-apis/variables/update-custom-variable"},{"openapi":"delete /ai-agents/agent-builder/agents/variables/custom/{variableId}","title":"Delete Custom Variable","href":"/rest-api/ai-agents-apis/variables/delete-custom-variable"}]},{"group":"Troubleshoot","icon":"circle-question","expanded":false,"pages":[{"title":"Error Codes","sidebarTitle":"Error Codes","href":"/rest-api/ai-agents-apis/error-codes"},{"title":"Properties and Constraints","sidebarTitle":"Properties and Constraints","href":"/rest-api/ai-agents-apis/properties-and-constraints"}]}]}]}]},{"product":"AI Moderation","pages":[{"title":"AI Moderation","href":"/moderation/overview"}]},{"product":"Notifications","pages":[{"title":"Notifications","href":"/notifications"}]},{"product":"Campaigns","pages":[{"title":"Campaigns","href":"/campaigns"}]},{"product":"Insights","pages":[{"title":"Insights","href":"/insights"}]}]},"title":"Create API Tool - CometChat Docs","buildId":"dpl_3DJU2xKhT5gDPFQL5Tqv7AFnkWsF","deploymentId":"dpl_3DJU2xKhT5gDPFQL5Tqv7AFnkWsF","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DsGgv5pK.js","utils-B0h6ZXi-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-IgrnFwPw.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C49-TBER.js","snippetPresets-BPHn-9OB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CGBwAHwX.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BjABHCCH.js","shallow-C0Uj5sOI.js","getApiPlaygroundDisplay-BnYiIeY4.js","CodeSnippet-BJWWrlBw.js","CodeSnippets-bxE5aDye.js","Page-BBU7roUf.js","getPastedJson-BAjriezQ.js","icon-BqcS52QC.js","MethodPill-BPGyN9me.js","DuplicateIcon-CCf2giLL.js","createIcon-CVH8aNt2.js","DynamicMarkdown-BklwmxA6.js","SectionHeading-DYCZQFxh.js","axios-vUo_bRtp.js","Markdown-D26rHnOC.js","clsx-DkiOUx4h.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DI8jfVGc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DwJy-csb.js"]}