Requires Editor, Admin, or Owner. Choose a typed definition for an HTTP API, end call, transfer call, calculator, or MCP tool. The request schema lists the configuration for each type.Tools with a stored credential, nonempty headers, or preset parameter values additionally require Admin or Owner. MCP configuration can contact the configured server to discover tools. Creating a tool does not automatically attach it to an agent. Each successful request creates another resource.Tools managed by an integration cannot be created, edited, duplicated, archived, or restored through the general tool endpoints; these attempts return 409. Do not set integration_provider or integration_id yourself. Manage Calendly access through its connection endpoints.
Bandwidth Labs OAuth access token. Uses the user's selected workspace; the workspace header is not required. Do not also send an API key. Bearer-only operations may additionally require the Labs super_user role.
Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace ID to access. The key owner must be a current member. Missing or invalid IDs return 400; non-member workspaces return 403. Not required for bearer authentication, which uses the user's selected workspace.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Bandwidth Agent Builder","colors":{"primary":"#005EB8","light":"#0099D6","dark":"#005EB8"},"logo":{"light":"https://mintcdn.com/harmonair/JkEwLaC7cZDc9A3-/logo/light.svg?fit=max\u0026auto=format\u0026n=JkEwLaC7cZDc9A3-\u0026q=85\u0026s=6636082101afd784cb46a6fba1624fc7","dark":"https://mintcdn.com/harmonair/JkEwLaC7cZDc9A3-/logo/dark.svg?fit=max\u0026auto=format\u0026n=JkEwLaC7cZDc9A3-\u0026q=85\u0026s=8bab76a8ee0963c0a9a7890055ce3900","href":"/getting-started/index"},"favicon":"https://mintcdn.com/harmonair/JkEwLaC7cZDc9A3-/favicon.png?fit=max\u0026auto=format\u0026n=JkEwLaC7cZDc9A3-\u0026q=85\u0026s=a7cd5945297fa4480145aa817887ba88","api":{"openapi":"api-reference/openapi.json","examples":{"defaults":"all","languages":["curl","python","javascript"]}},"navbar":{"links":[{"href":"https://labs.bandwidth.com/","label":"Bandwidth Labs"}],"primary":{"type":"button","label":"Open console","href":"https://agents.labs.bandwidth.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/bandwidth-inc"}},"search":{"prompt":"Search guides, API endpoints, and MCP tools"},"contextual":{"options":["copy","view"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"harmonair","hasAudioNarration":false,"actualSubdomain":"harmonair","customDomains":["docs.agents.labs.bandwidth.com"],"gitSource":{"type":"github","owner":"bandwidth","repo":"innovation-studio-voai-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae7aec9b26903148c75c820","collectionId":"5b33fd57-cc8f-489a-b9bd-7cf5307390b0","liveDeploymentHistoryId":"6ae7aec9b26903148c75c820","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae7aec9b26903148c75c820","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"API Reference","count":169},{"language":"default","tag":"User guides","count":45},{"language":"default","tag":"MCP","count":35},{"language":"default","tag":"Agents","count":34},{"language":"default","tag":"Build and test agents","count":20},{"language":"default","tag":"Get started","count":16},{"language":"default","tag":"Campaigns","count":15},{"language":"default","tag":"Telephony Configurations","count":15},{"language":"default","tag":"Tools","count":15},{"language":"default","tag":"Reports","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/tools/create","slug":"/api-reference/tools/create","pageMetadata":{"title":"Create a tool","description":"Create a reusable tool for agents in the workspace.","openapi":"POST /api/v1/tools/","href":"/api-reference/tools/create"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a reusable tool for agents in the workspace.\"\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={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Requires Editor, Admin, or Owner. Choose a typed `,_jsx(_components.code,{children:`definition`}),` for an HTTP API, end call, transfer call, calculator, or MCP tool. The request schema lists the configuration for each type.`]}),`\n`,_jsx(_components.p,{children:`Tools with a stored credential, nonempty headers, or preset parameter values additionally require Admin or Owner. MCP configuration can contact the configured server to discover tools. Creating a tool does not automatically attach it to an agent. Each successful request creates another resource.`}),`\n`,_jsxs(_components.p,{children:[`Tools managed by an integration cannot be created, edited, duplicated, archived, or restored through the general tool endpoints; these attempts return `,_jsx(_components.code,{children:`409`}),`. Do not set `,_jsx(_components.code,{children:`integration_provider`}),` or `,_jsx(_components.code,{children:`integration_id`}),` yourself. Manage Calendly access through its `,_jsx(_components.a,{href:`/api-reference/calendly/status`,children:`connection endpoints`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a tool","description":"Create a reusable tool for agents in the workspace.","openapi":"POST /api/v1/tools/","href":"/api-reference/tools/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Create a reusable tool for agents in the workspace.","operationId":"create_tool_api_v1_tools__post","parameters":["65d62524-07ad-434a-b21c-1d0a5af90f10"],"requestBody":"9388ce81-868d-4e9c-9770-2fafca665246","responses":{"200":"0d51039f-81af-4392-b9ab-981c78a9e91d","400":"083958ea-29f5-498f-a530-0bec3ff93d7e","401":"70fd9228-155e-4af8-a08b-d7f1ba5d43a2","403":"0e758b37-9457-475d-b550-572ac21443f9","404":"3bad4592-6d0c-4b99-bf41-e2fbfa6bb342","409":"eab8063c-0f3c-427b-8867-8b9a326ef54b","422":"cec78836-ebc7-442e-9931-d825b1a7be03"},"security":["6576575a-da29-46b2-b00f-af591eae626e","b13219f2-5616-4b00-aa76-c58387fdbb47"],"summary":"Create a tool","tags":["tools"],"method":"post","type":"path","servers":["864d1b67-b892-495f-83bc-cd0d89836ea3"],"path":"/api/v1/tools/","baseUrlOptions":["https://agents.labs.bandwidth.com"],"title":"Create a tool","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"65d62524-07ad-434a-b21c-1d0a5af90f10":{"description":"Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace ID to access. The key owner must be a current member. Missing or invalid IDs return 400; non-member workspaces return 403. Not required for bearer authentication, which uses the user's selected workspace.","in":"header","name":"X-VOAI-ORGANIZATION-ID","required":false,"schema":{"oneOf":[{"type":"string","title":"X-Voai-Organization-Id","description":"Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace ID to access. The key owner must be a current member. Missing or invalid IDs return 400; non-member workspaces return 403. Not required for bearer authentication, which uses the user's selected workspace.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"X-Voai-Organization-Id","description":"Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace ID to access. The key owner must be a current member. Missing or invalid IDs return 400; non-member workspaces return 403. Not required for bearer authentication, which uses the user's selected workspace.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"definition":{"oneOf":[{"type":"object","title":"HttpApiToolDefinition","required":["type","config"],"properties":{"config":{"properties":{"method":{"enum":["GET","POST","PUT","PATCH","DELETE"],"title":"Method","type":"string","isRequired":true,"uniqueKey":"definition.oneOf.0.config.method","typeLabel":"enum\u003cstring>"},"url":{"title":"Url","type":"string","isRequired":true,"uniqueKey":"definition.oneOf.0.config.url","typeLabel":"string"},"credential_uuid":{"oneOf":[{"type":"string","title":"Credential Uuid","uniqueKey":"definition.oneOf.0.config.credential_uuid.oneOf.0","typeLabel":"string"},{"type":"null","title":"Credential Uuid","uniqueKey":"definition.oneOf.0.config.credential_uuid.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.oneOf.0.config.credential_uuid","typeLabel":"string | null"},"customMessage":{"oneOf":[{"type":"string","title":"Custommessage","uniqueKey":"definition.oneOf.0.config.customMessage.oneOf.0","typeLabel":"string"},{"type":"null","title":"Custommessage","uniqueKey":"definition.oneOf.0.config.customMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.oneOf.0.config.customMessage","typeLabel":"string | null"},"customMessageRecordingId":{"oneOf":[{"type":"string","title":"Custommessagerecordingid","uniqueKey":"definition.oneOf.0.config.customMessageRecordingId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Custommessagerecordingid","uniqueKey":"definition.oneOf.0.config.customMessageRecordingId.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.oneOf.0.config.customMessageRecordingId","typeLabel":"string | null"},"customMessageType":{"oneOf":[{"type":"string","title":"Custommessagetype","enum":["text","audio"],"uniqueKey":"definition.oneOf.0.config.customMessageType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Custommessagetype","uniqueKey":"definition.oneOf.0.config.customMessageType.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.oneOf.0.config.customMessageType","typeLabel":"enum\u003cstring> | null"},"headers":{"oneOf":[{"type":"object","title":"Headers","additionalProperties":{"type":"string","uniqueKey":"definition.oneOf.0.config.headers.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"definition.oneOf.0.config.headers.oneOf.0","typeLabel":"Headers · object"},{"type":"null","title":"Headers","uniqueKey":"definition.oneOf.0.config.headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.oneOf.0.config.headers","typeLabel":"Headers · object | null"},"parameters":{"oneOf":[{"type":"array","items":{"properties":{"description":{"title":"Description","type":"string","isRequired":true,"uniqueKey":"definition.oneOf.0.config.parameters.oneOf.0.items.[INDEX].description","typeLabel":"string"},"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"definition.oneOf.0.config.parameters.oneOf.0.items.[INDEX].name","typeLabel":"string"},"type":{"enum":["string","number","boolean","object","array"],"title":"Type","type":"string","isRequired":true,"uniqueKey":"definition.oneOf.0.config.parameters.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"required":{"default":true,"title":"Required","type":"boolean","uniqueKey":"definition.oneOf.0.config.parameters.oneOf.0.items.[INDEX].required","typeLabel":"boolean"}},"required":["name","type","description"],"title":"ToolParameter","type":"object","uniqueKey":"definition.oneOf.0.config.parameters.oneOf.0.items.[INDEX]","typeLabel":"ToolParameter · object"},"title":"Parameters","uniqueKey":"definition.oneOf.0.config.parameters.oneOf.0","typeLabel":"ToolParameter · object[]"},{"type":"null","title":"Parameters","uniqueKey":"definition.oneOf.0.config.parameters.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.oneOf.0.config.parameters","typeLabel":"ToolParameter · object[] | null"},"preset_parameters":{"oneOf":[{"type":"array","items":{"properties":{"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"definition.oneOf.0.config.preset_parameters.oneOf.0.items.[INDEX].name","typeLabel":"string"},"type":{"enum":["string","number","boolean","object","array"],"title":"Type","type":"string","isRequired":true,"uniqueKey":"definition.oneOf.0.config.preset_parameters.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value_template":{"title":"Value Template","type":"string","isRequired":true,"uniqueKey":"definition.oneOf.0.config.preset_parameters.oneOf.0.items.[INDEX].value_template","typeLabel":"string"},"required":{"default":true,"title":"Required","type":"boolean","uniqueKey":"definition.oneOf.0.config.preset_parameters.oneOf.0.items.[INDEX].required","typeLabel":"boolean"}},"required":["name","type","value_template"],"title":"PresetToolParameter","type":"object","uniqueKey":"definition.oneOf.0.config.preset_parameters.oneOf.0.items.[INDEX]","typeLabel":"PresetToolParameter · object"},"title":"Preset Parameters","uniqueKey":"definition.oneOf.0.config.preset_parameters.oneOf.0","typeLabel":"PresetToolParameter · object[]"},{"type":"null","title":"Preset Parameters","uniqueKey":"definition.oneOf.0.config.preset_parameters.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.oneOf.0.config.preset_parameters","typeLabel":"PresetToolParameter · object[] | null"},"timeout_ms":{"oneOf":[{"type":"integer","title":"Timeout Ms","default":5000,"minimum":1,"uniqueKey":"definition.oneOf.0.config.timeout_ms.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Timeout Ms","default":5000,"uniqueKey":"definition.oneOf.0.config.timeout_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.oneOf.0.config.timeout_ms","typeLabel":"integer | null"}},"required":["method","url"],"title":"HttpApiConfig","type":"object","isRequired":true,"uniqueKey":"definition.oneOf.0.config","typeLabel":"HttpApiConfig · object"},"type":{"const":"http_api","title":"Type","type":"string","isRequired":true,"uniqueKey":"definition.oneOf.0.type","typeLabel":"string"},"schema_version":{"default":1,"title":"Schema Version","type":"integer","uniqueKey":"definition.oneOf.0.schema_version","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"definition.oneOf.0","typeLabel":"HttpApiToolDefinition · object"},{"type":"object","title":"EndCallToolDefinition","required":["type","config"],"properties":{"config":{"properties":{"audioRecordingId":{"oneOf":[{"type":"string","title":"Audiorecordingid","uniqueKey":"definition.oneOf.1.config.audioRecordingId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Audiorecordingid","uniqueKey":"definition.oneOf.1.config.audioRecordingId.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.oneOf.1.config.audioRecordingId","typeLabel":"string | null"},"customMessage":{"oneOf":[{"type":"string","title":"Custommessage","uniqueKey":"definition.oneOf.1.config.customMessage.oneOf.0","typeLabel":"string"},{"type":"null","title":"Custommessage","uniqueKey":"definition.oneOf.1.config.customMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.oneOf.1.config.customMessage","typeLabel":"string | null"},"endCallReason":{"default":false,"title":"Endcallreason","type":"boolean","uniqueKey":"definition.oneOf.1.config.endCallReason","typeLabel":"boolean"},"endCallReasonDescription":{"oneOf":[{"type":"string","title":"Endcallreasondescription","uniqueKey":"definition.oneOf.1.config.endCallReasonDescription.oneOf.0","typeLabel":"string"},{"type":"null","title":"Endcallreasondescription","uniqueKey":"definition.oneOf.1.config.endCallReasonDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.oneOf.1.config.endCallReasonDescription","typeLabel":"string | null"},"messageType":{"default":"none","enum":["none","custom","audio"],"title":"Messagetype","type":"string","uniqueKey":"definition.oneOf.1.config.messageType","typeLabel":"enum\u003cstring>"}},"title":"EndCallConfig","type":"object","isRequired":true,"uniqueKey":"definition.oneOf.1.config","typeLabel":"EndCallConfig · object"},"type":{"const":"end_call","title":"Type","type":"string","isRequired":true,"uniqueKey":"definition.oneOf.1.type","typeLabel":"string"},"schema_version":{"default":1,"title":"Schema Version","type":"integer","uniqueKey":"definition.oneOf.1.schema_version","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"definition.oneOf.1","typeLabel":"EndCallToolDefinition · object"},{"type":"object","title":"TransferCallToolDefinition","required":["type","config"],"properties":{"config":{"properties":{"destination":{"title":"Destination","type":"string","isRequired":true,"uniqueKey":"definition.oneOf.2.config.destination","typeLabel":"string"},"audioRecordingId":{"oneOf":[{"type":"string","title":"Audiorecordingid","uniqueKey":"definition.oneOf.2.config.audioRecordingId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Audiorecordingid","uniqueKey":"definition.oneOf.2.config.audioRecordingId.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.oneOf.2.config.audioRecordingId","typeLabel":"string | null"},"customMessage":{"oneOf":[{"type":"string","title":"Custommessage","uniqueKey":"definition.oneOf.2.config.customMessage.oneOf.0","typeLabel":"string"},{"type":"null","title":"Custommessage","uniqueKey":"definition.oneOf.2.config.customMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.oneOf.2.config.customMessage","typeLabel":"string | null"},"messageType":{"default":"none","enum":["none","custom","audio"],"title":"Messagetype","type":"string","uniqueKey":"definition.oneOf.2.config.messageType","typeLabel":"enum\u003cstring>"},"timeout":{"default":30,"maximum":120,"minimum":5,"title":"Timeout","type":"integer","uniqueKey":"definition.oneOf.2.config.timeout","typeLabel":"integer"}},"required":["destination"],"title":"TransferCallConfig","type":"object","isRequired":true,"uniqueKey":"definition.oneOf.2.config","typeLabel":"TransferCallConfig · object"},"type":{"const":"transfer_call","title":"Type","type":"string","isRequired":true,"uniqueKey":"definition.oneOf.2.type","typeLabel":"string"},"schema_version":{"default":1,"title":"Schema Version","type":"integer","uniqueKey":"definition.oneOf.2.schema_version","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"definition.oneOf.2","typeLabel":"TransferCallToolDefinition · object"},{"type":"object","title":"CalculatorToolDefinition","required":["type"],"properties":{"type":{"const":"calculator","title":"Type","type":"string","isRequired":true,"uniqueKey":"definition.oneOf.3.type","typeLabel":"string"},"schema_version":{"default":1,"title":"Schema Version","type":"integer","uniqueKey":"definition.oneOf.3.schema_version","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"definition.oneOf.3","typeLabel":"CalculatorToolDefinition · object"},{"type":"object","title":"McpToolDefinition","required":["type","config"],"properties":{"config":{"properties":{"url":{"title":"Url","type":"string","isRequired":true,"uniqueKey":"definition.oneOf.4.config.url","typeLabel":"string"},"account_name":{"oneOf":[{"type":"string","title":"Account Name","description":"Connected account display name for a managed integration.","uniqueKey":"definition.oneOf.4.config.account_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Account Name","description":"Connected account display name for a managed integration.","uniqueKey":"definition.oneOf.4.config.account_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.oneOf.4.config.account_name","typeLabel":"string | null"},"credential_uuid":{"oneOf":[{"type":"string","title":"Credential Uuid","uniqueKey":"definition.oneOf.4.config.credential_uuid.oneOf.0","typeLabel":"string"},{"type":"null","title":"Credential Uuid","uniqueKey":"definition.oneOf.4.config.credential_uuid.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.oneOf.4.config.credential_uuid","typeLabel":"string | null"},"discovered_tools":{"items":{"additionalProperties":true,"type":"object","uniqueKey":"definition.oneOf.4.config.discovered_tools.items.[INDEX]","typeLabel":"object"},"title":"Discovered Tools","type":"array","uniqueKey":"definition.oneOf.4.config.discovered_tools","typeLabel":"Discovered Tools · object[]"},"integration_id":{"oneOf":[{"type":"string","title":"Integration Id","description":"Server-managed source integration identifier. Use the integration connection APIs rather than setting this during tool creation or update.","uniqueKey":"definition.oneOf.4.config.integration_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Integration Id","description":"Server-managed source integration identifier. Use the integration connection APIs rather than setting this during tool creation or update.","uniqueKey":"definition.oneOf.4.config.integration_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.oneOf.4.config.integration_id","typeLabel":"string | null"},"integration_provider":{"oneOf":[{"type":"string","title":"Integration Provider","description":"Server-managed source integration provider. Use the integration connection APIs rather than setting this during tool creation or update.","uniqueKey":"definition.oneOf.4.config.integration_provider.oneOf.0","typeLabel":"string"},{"type":"null","title":"Integration Provider","description":"Server-managed source integration provider. Use the integration connection APIs rather than setting this during tool creation or update.","uniqueKey":"definition.oneOf.4.config.integration_provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.oneOf.4.config.integration_provider","typeLabel":"string | null"},"sse_read_timeout_secs":{"default":300,"minimum":0,"title":"Sse Read Timeout Secs","type":"integer","uniqueKey":"definition.oneOf.4.config.sse_read_timeout_secs","typeLabel":"integer"},"timeout_secs":{"default":30,"minimum":0,"title":"Timeout Secs","type":"integer","uniqueKey":"definition.oneOf.4.config.timeout_secs","typeLabel":"integer"},"tools_filter":{"items":{"type":"string","uniqueKey":"definition.oneOf.4.config.tools_filter.items.[INDEX]","typeLabel":"string"},"title":"Tools Filter","type":"array","uniqueKey":"definition.oneOf.4.config.tools_filter","typeLabel":"string[]"},"transport":{"const":"streamable_http","default":"streamable_http","title":"Transport","type":"string","uniqueKey":"definition.oneOf.4.config.transport","typeLabel":"string"}},"required":["url"],"title":"McpToolConfig","type":"object","isRequired":true,"uniqueKey":"definition.oneOf.4.config","typeLabel":"McpToolConfig · object"},"type":{"const":"mcp","title":"Type","type":"string","isRequired":true,"uniqueKey":"definition.oneOf.4.type","typeLabel":"string"},"schema_version":{"default":1,"title":"Schema Version","type":"integer","uniqueKey":"definition.oneOf.4.schema_version","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"definition.oneOf.4","typeLabel":"McpToolDefinition · object"}],"isRequired":true,"uniqueKey":"definition","typeLabel":"HttpApiToolDefinition · object | EndCallToolDefinition · object | TransferCallToolDefinition · object | CalculatorToolDefinition · object | McpToolDefinition · object"},"name":{"maxLength":255,"title":"Name","type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"category":{"default":"http_api","enum":["http_api","end_call","transfer_call","calculator","native","integration","mcp"],"title":"Category","type":"string","uniqueKey":"category","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"type":"string","title":"Description","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"icon":{"oneOf":[{"type":"string","title":"Icon","default":"globe","maxLength":50,"uniqueKey":"icon.oneOf.0","typeLabel":"string"},{"type":"null","title":"Icon","default":"globe","uniqueKey":"icon.oneOf.1","typeLabel":"null"}],"uniqueKey":"icon","typeLabel":"string | null"},"icon_color":{"oneOf":[{"type":"string","title":"Icon Color","default":"#3B82F6","maxLength":7,"uniqueKey":"icon_color.oneOf.0","typeLabel":"string"},{"type":"null","title":"Icon Color","default":"#3B82F6","uniqueKey":"icon_color.oneOf.1","typeLabel":"null"}],"uniqueKey":"icon_color","typeLabel":"string | null"}},"required":["name","definition"],"title":"CreateToolRequest","type":"object","uniqueKey":"","typeLabel":"CreateToolRequest · object"},"example":{"name":"Lookup order","category":"http_api","definition":{"type":"http_api","config":{"method":"GET","url":"https://api.example.com/orders","timeout_ms":5000}}},"examples":{"Example":{"title":"Example","value":{"name":"Lookup order","category":"http_api","definition":{"type":"http_api","config":{"method":"GET","url":"https://api.example.com/orders","timeout_ms":5000}}}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"0d51039f-81af-4392-b9ab-981c78a9e91d":{"content":{"application/json":{"schema":{"properties":{"category":{"title":"Category","type":"string","isRequired":true,"uniqueKey":"category","typeLabel":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"definition":{"additionalProperties":true,"title":"Definition","type":"object","isRequired":true,"uniqueKey":"definition","typeLabel":"Definition · object"},"description":{"oneOf":[{"type":"string","title":"Description","isRequired":true,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","isRequired":true,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"description","typeLabel":"string | null"},"icon":{"oneOf":[{"type":"string","title":"Icon","isRequired":true,"uniqueKey":"icon.oneOf.0","typeLabel":"string"},{"type":"null","title":"Icon","isRequired":true,"uniqueKey":"icon.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"icon","typeLabel":"string | null"},"icon_color":{"oneOf":[{"type":"string","title":"Icon Color","isRequired":true,"uniqueKey":"icon_color.oneOf.0","typeLabel":"string"},{"type":"null","title":"Icon Color","isRequired":true,"uniqueKey":"icon_color.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"icon_color","typeLabel":"string | null"},"id":{"title":"Id","type":"integer","isRequired":true,"uniqueKey":"id","typeLabel":"integer"},"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"status":{"title":"Status","type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"tool_uuid":{"title":"Tool Uuid","type":"string","isRequired":true,"uniqueKey":"tool_uuid","typeLabel":"string"},"updated_at":{"oneOf":[{"type":"string","title":"Updated At","format":"date-time","isRequired":true,"uniqueKey":"updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Updated At","isRequired":true,"uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time> | null"},"created_by":{"oneOf":[{"type":"object","title":"CreatedByResponse","required":["id","provider_id"],"properties":{"id":{"title":"Id","type":"integer","isRequired":true,"uniqueKey":"created_by.oneOf.0.id","typeLabel":"integer"},"provider_id":{"title":"Provider Id","type":"string","isRequired":true,"uniqueKey":"created_by.oneOf.0.provider_id","typeLabel":"string"}},"uniqueKey":"created_by.oneOf.0","typeLabel":"CreatedByResponse · object"},{"type":"null","uniqueKey":"created_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_by","typeLabel":"CreatedByResponse · object | null"}},"required":["id","tool_uuid","name","description","category","icon","icon_color","status","definition","created_at","updated_at"],"title":"ToolResponse","type":"object","uniqueKey":"","typeLabel":"ToolResponse · object"},"examples":{"Example":{"title":"Example","value":{"category":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","definition":{},"description":"\u003cstring>","icon":"\u003cstring>","icon_color":"\u003cstring>","id":123,"name":"\u003cstring>","status":"\u003cstring>","tool_uuid":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z","created_by":{"id":123,"provider_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Successful Response","exampleType":"generated"},"083958ea-29f5-498f-a530-0bec3ff93d7e":{"description":"Invalid request or missing/invalid workspace header with an API key.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"70fd9228-155e-4af8-a08b-d7f1ba5d43a2":{"description":"Missing, invalid, or expired credential.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"0e758b37-9457-475d-b550-572ac21443f9":{"description":"The account lacks access to the workspace, resource, or required role.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"3bad4592-6d0c-4b99-bf41-e2fbfa6bb342":{"description":"Not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"eab8063c-0f3c-427b-8867-8b9a326ef54b":{"description":"Managed integration tools must be created through their source integration.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"cec78836-ebc7-442e-9931-d825b1a7be03":{"content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"title":"Location","type":"array","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"title":"Error Type","type":"string","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"ctx":{"title":"Context","type":"object","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"title":"Detail","type":"array","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"title":"HTTPValidationError","type":"object","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","ctx":{},"input":"\u003cunknown>"}]}}},"exampleType":"generated"}},"description":"Validation Error","exampleType":"generated"}},"security":{"6576575a-da29-46b2-b00f-af591eae626e":{"LabsAuth":{"description":"Bandwidth Labs OAuth access token. Uses the user's selected workspace; the workspace header is not required. Do not also send an API key. Bearer-only operations may additionally require the Labs `super_user` role.","scheme":"bearer","type":"http","scopes":[],"schemeName":"LabsAuth"}},"b13219f2-5616-4b00-aa76-c58387fdbb47":{"LabsApiKey":{"description":"Bandwidth Labs API key. Also send `X-VOAI-ORGANIZATION-ID` with a positive local workspace ID belonging to the key owner. Access follows the owner's current workspace role. Do not also send a bearer token. API keys cannot access bearer-only or Labs `super_user` operations.","in":"header","name":"X-BW-LABS-AGENTS-API-KEY","type":"apiKey","scopes":[],"schemeName":"LabsApiKey"}}},"servers":{"864d1b67-b892-495f-83bc-cd0d89836ea3":{"url":"https://agents.labs.bandwidth.com","description":"Workspace API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Bandwidth Labs OAuth access token. Uses the user's selected workspace; the workspace header is not required. Do not also send an API key. Bearer-only operations may additionally require the Labs `super_user` role.","scheme":"bearer","type":"http","scopes":[],"schemeName":"LabsAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bandwidth Labs OAuth access token. Uses the user's selected workspace; the workspace header is not required. Do not also send an API key. Bearer-only operations may additionally require the Labs `super_user` role.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"LabsAuth","name":"Authorization"}],"title":"LabsAuth"},{"schemes":[{"scheme":{"description":"Bandwidth Labs API key. Also send `X-VOAI-ORGANIZATION-ID` with a positive local workspace ID belonging to the key owner. Access follows the owner's current workspace role. Do not also send a bearer token. API keys cannot access bearer-only or Labs `super_user` operations.","in":"header","name":"X-BW-LABS-AGENTS-API-KEY","type":"apiKey","scopes":[],"schemeName":"LabsApiKey"},"schema":{"title":"X-BW-LABS-AGENTS-API-KEY","type":"string","description":"Bandwidth Labs API key. Also send `X-VOAI-ORGANIZATION-ID` with a positive local workspace ID belonging to the key owner. Access follows the owner's current workspace role. Do not also send a bearer token. API keys cannot access bearer-only or Labs `super_user` operations.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"LabsApiKey","name":"X-BW-LABS-AGENTS-API-KEY"}],"title":"LabsApiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"harmonair","siteName":"Bandwidth Agent Builder","title":"Create a tool - Bandwidth Agent Builder","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-01T21:03:17.452Z","originalFileLocation":"api-reference/tools/create.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=\"Create a reusable tool for agents in the workspace.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Bandwidth Agent Builder\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/harmonair/H2rLokpOBJgewPcX/_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/harmonair/H2rLokpOBJgewPcX/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/harmonair/H2rLokpOBJgewPcX/_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/harmonair/H2rLokpOBJgewPcX/_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/harmonair/H2rLokpOBJgewPcX/_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/harmonair/H2rLokpOBJgewPcX/_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/harmonair/H2rLokpOBJgewPcX/_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/harmonair/H2rLokpOBJgewPcX/_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/harmonair/H2rLokpOBJgewPcX/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a tool - Bandwidth Agent Builder\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a reusable tool for agents in the workspace.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bandwidth Agent Builder\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.agents.labs.bandwidth.com/api-reference/tools/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://harmonair.mintlify.site/_mintlify/api/og/v2?division=Tools\u0026amp;title=Create+a+tool\u0026amp;description=Create+a+reusable+tool+for+agents+in+the+workspace.\u0026amp;theme=17ecdc8190b2c51f07b9a393\u0026amp;signature=f8ab911db5142f0e6b575eeb95068a4906f3594088b2ca2c770653e4a3e63d9e\">\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 a tool - Bandwidth Agent Builder\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a reusable tool for agents in the workspace.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://harmonair.mintlify.site/_mintlify/api/og/v2?division=Tools\u0026amp;title=Create+a+tool\u0026amp;description=Create+a+reusable+tool+for+agents+in+the+workspace.\u0026amp;theme=17ecdc8190b2c51f07b9a393\u0026amp;signature=f8ab911db5142f0e6b575eeb95068a4906f3594088b2ca2c770653e4a3e63d9e\">\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/harmonair/H2rLokpOBJgewPcX/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bandwidth Agent Builder\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#005EB8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.agents.labs.bandwidth.com/api-reference/tools/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/tools/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.agents.labs.bandwidth.com/#organization\",\"name\":\"Bandwidth Agent Builder\",\"url\":\"https://docs.agents.labs.bandwidth.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/harmonair/JkEwLaC7cZDc9A3-/logo/light.svg?fit=max\u0026auto=format\u0026n=JkEwLaC7cZDc9A3-\u0026q=85\u0026s=6636082101afd784cb46a6fba1624fc7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.agents.labs.bandwidth.com#website\",\"name\":\"Bandwidth Agent Builder\",\"url\":\"https://docs.agents.labs.bandwidth.com\",\"publisher\":{\"@id\":\"https://docs.agents.labs.bandwidth.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.agents.labs.bandwidth.com/api-reference/tools/create#webpage\",\"url\":\"https://docs.agents.labs.bandwidth.com/api-reference/tools/create\",\"name\":\"Create a tool\",\"description\":\"Create a reusable tool for agents in the workspace.\",\"dateModified\":\"2026-11-01T21:03:17.452Z\",\"isPartOf\":{\"@id\":\"https://docs.agents.labs.bandwidth.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.agents.labs.bandwidth.com/api-reference/tools/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.agents.labs.bandwidth.com/api-reference/tools/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Tools\",\"item\":\"https://docs.agents.labs.bandwidth.com/api-reference/tools/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a tool\",\"item\":\"https://docs.agents.labs.bandwidth.com/api-reference/tools/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.agents.labs.bandwidth.com/api-reference/tools/create#apireference\",\"headline\":\"Create a tool\",\"name\":\"Create a tool\",\"description\":\"Create a reusable tool for agents in the workspace.\",\"url\":\"https://docs.agents.labs.bandwidth.com/api-reference/tools/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.agents.labs.bandwidth.com/api-reference/tools/create#webpage\"},\"dateModified\":\"2026-11-01T21:03:17.452Z\",\"publisher\":{\"@id\":\"https://docs.agents.labs.bandwidth.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.agents.labs.bandwidth.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Bandwidth Agent Builder\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Bandwidth Agent Builder","nav":{"global":null,"tabs":[{"tab":"User guides","icon":"book-open","pages":[{"title":"User guides","href":"/getting-started"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Get started","pages":[{"title":"API overview","href":"/api-reference/overview"},{"title":"REST API quickstart","href":"/developer/quickstart"},{"title":"Create and manage API keys","href":"/api-reference/api-keys"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Workspaces and permissions","href":"/api-reference/workspaces"},{"title":"Errors and retries","href":"/api-reference/errors"}]},{"group":"Agents","pages":[{"title":"Overview","href":"/api-reference/agents"},{"title":"List agents","openapi":"GET /api/v1/workflow/fetch","href":"/api-reference/agents/list"},{"title":"List agent names","openapi":"GET /api/v1/workflow/summary","href":"/api-reference/agents/summary"},{"title":"Get Agent Count","openapi":"GET /api/v1/workflow/count","href":"/api-reference/agents/count"},{"title":"Get Agent","openapi":"GET /api/v1/workflow/fetch/{workflow_id}","href":"/api-reference/agents/get"},{"title":"Create an agent from a definition","openapi":"POST /api/v1/workflow/create/definition","href":"/api-reference/agents/create-from-definition"},{"title":"Create from Template","openapi":"POST /api/v1/workflow/create/template","href":"/api-reference/agents/create-from-template"},{"title":"Create from a catalog template","openapi":"POST /api/v1/workflow/create/from-catalog","href":"/api-reference/agents/create-from-catalog"},{"title":"Update Agent","openapi":"PUT /api/v1/workflow/{workflow_id}","href":"/api-reference/agents/update"},{"title":"Create a draft","openapi":"POST /api/v1/workflow/{workflow_id}/create-draft","href":"/api-reference/agents/create-draft"},{"title":"Duplicate an agent","openapi":"POST /api/v1/workflow/{workflow_id}/duplicate","href":"/api-reference/agents/duplicate"},{"title":"Move an agent to a folder","openapi":"PUT /api/v1/workflow/{workflow_id}/folder","href":"/api-reference/agents/move-folder"},{"title":"Archive Agent","openapi":"PUT /api/v1/workflow/{workflow_id}/status","href":"/api-reference/agents/archive"},{"title":"Delete an agent","openapi":"DELETE /api/v1/workflow/{workflow_id}","href":"/api-reference/agents/delete"},{"title":"Validate Workflow","openapi":"POST /api/v1/workflow/{workflow_id}/validate","href":"/api-reference/agents/validate"},{"title":"Publish an agent","openapi":"POST /api/v1/workflow/{workflow_id}/publish","href":"/api-reference/agents/publish"},{"title":"List agent versions","openapi":"GET /api/v1/workflow/{workflow_id}/versions","href":"/api-reference/agents/versions"},{"title":"Restore a previous version to draft","openapi":"POST /api/v1/workflow/{workflow_id}/versions/{definition_id}/rollback","href":"/api-reference/agents/rollback"},{"title":"List saved templates","openapi":"GET /api/v1/workflow/templates","href":"/api-reference/agents/templates"},{"title":"Duplicate a saved template","openapi":"POST /api/v1/workflow/templates/duplicate","href":"/api-reference/agents/duplicate-template"},{"group":"Agent runs","pages":[{"title":"List Runs","openapi":"GET /api/v1/workflow/{workflow_id}/runs","href":"/api-reference/agents/runs/list"},{"title":"Get Run","openapi":"GET /api/v1/workflow/{workflow_id}/runs/{run_id}","href":"/api-reference/agents/runs/get"},{"title":"Create a browser run","openapi":"POST /api/v1/workflow/{workflow_id}/runs","href":"/api-reference/agents/runs/create"},{"title":"Get a run trace","openapi":"GET /api/v1/workflow/{workflow_id}/runs/{run_id}/trace","href":"/api-reference/agents/runs/trace"},{"title":"Download an agent run report","openapi":"GET /api/v1/workflow/{workflow_id}/report","href":"/api-reference/agents/runs/report"}]}]},{"group":"Node types","pages":[{"title":"List node types","openapi":"GET /api/v1/node-types","href":"/api-reference/node-types/list"},{"title":"Get a node type","openapi":"GET /api/v1/node-types/{name}","href":"/api-reference/node-types/get"}]},{"group":"Conversations","pages":[{"title":"List conversations","openapi":"GET /api/v1/conversations","href":"/api-reference/conversations/list"},{"title":"List conversation agents","openapi":"GET /api/v1/conversations/agents","href":"/api-reference/conversations/agents"},{"title":"Get a conversation","openapi":"GET /api/v1/conversations/{run_id}","href":"/api-reference/conversations/get"},{"title":"Update a conversation review","openapi":"PATCH /api/v1/conversations/{run_id}/review","href":"/api-reference/conversations/review"},{"title":"Export conversations","openapi":"GET /api/v1/conversations/export","href":"/api-reference/conversations/export"}]},{"group":"Text testing","pages":[{"title":"Create a text test session","openapi":"POST /api/v1/workflow/{workflow_id}/text-chat/sessions","href":"/api-reference/text-chat/create"},{"title":"Get a text test session","openapi":"GET /api/v1/workflow/{workflow_id}/text-chat/sessions/{run_id}","href":"/api-reference/text-chat/get"},{"title":"Send a test message","openapi":"POST /api/v1/workflow/{workflow_id}/text-chat/sessions/{run_id}/messages","href":"/api-reference/text-chat/message"},{"title":"Rewind a text test session","openapi":"POST /api/v1/workflow/{workflow_id}/text-chat/sessions/{run_id}/rewind","href":"/api-reference/text-chat/rewind"}]},{"group":"Tools","pages":[{"title":"List tools","description":"List reusable workspace tools, optionally filtered by status or category.","openapi":"GET /api/v1/tools/","href":"/api-reference/tools/list"},{"title":"Create a tool","openapi":"POST /api/v1/tools/","href":"/api-reference/tools/create"},{"title":"Get a tool","description":"Retrieve a tool definition and metadata.","openapi":"GET /api/v1/tools/{tool_uuid}","href":"/api-reference/tools/get"},{"title":"Update a tool","openapi":"PUT /api/v1/tools/{tool_uuid}","href":"/api-reference/tools/update"},{"title":"Duplicate a tool","openapi":"POST /api/v1/tools/{tool_uuid}/duplicate","href":"/api-reference/tools/duplicate"},{"title":"Archive a tool","openapi":"DELETE /api/v1/tools/{tool_uuid}","href":"/api-reference/tools/archive"},{"title":"Restore a tool","openapi":"POST /api/v1/tools/{tool_uuid}/unarchive","href":"/api-reference/tools/unarchive"},{"title":"List tool execution logs","openapi":"GET /api/v1/tools/{tool_uuid}/logs","href":"/api-reference/tools/logs"},{"title":"Test an HTTP tool","openapi":"POST /api/v1/tools/{tool_uuid}/test","href":"/api-reference/tools/test"},{"title":"Refresh an MCP tool catalog","openapi":"POST /api/v1/tools/{tool_uuid}/mcp/refresh","href":"/api-reference/tools/refresh"}]},{"group":"Credentials","pages":[{"title":"List outbound credentials","openapi":"GET /api/v1/credentials/","href":"/api-reference/credentials/list"},{"title":"Get outbound credential metadata","openapi":"GET /api/v1/credentials/{credential_uuid}","href":"/api-reference/credentials/get"},{"title":"Create an outbound credential","openapi":"POST /api/v1/credentials/","href":"/api-reference/credentials/create"},{"title":"Update an outbound credential","openapi":"PUT /api/v1/credentials/{credential_uuid}","href":"/api-reference/credentials/update"},{"title":"Delete an outbound credential","openapi":"DELETE /api/v1/credentials/{credential_uuid}","href":"/api-reference/credentials/delete"}]},{"group":"Folders","pages":[{"title":"List folders","openapi":"GET /api/v1/folder/","href":"/api-reference/folders/list"},{"title":"Create a folder","openapi":"POST /api/v1/folder/","href":"/api-reference/folders/create"},{"title":"Rename a folder","openapi":"PUT /api/v1/folder/{folder_id}","href":"/api-reference/folders/rename"},{"title":"Delete a folder","openapi":"DELETE /api/v1/folder/{folder_id}","href":"/api-reference/folders/delete"}]},{"group":"Knowledge base","pages":[{"title":"Create a document upload URL","openapi":"POST /api/v1/knowledge-base/upload-url","href":"/api-reference/knowledge-base/upload"},{"title":"Process a document","openapi":"POST /api/v1/knowledge-base/process-document","href":"/api-reference/knowledge-base/process"},{"title":"List documents","openapi":"GET /api/v1/knowledge-base/documents","href":"/api-reference/knowledge-base/list"},{"title":"Get a document","openapi":"GET /api/v1/knowledge-base/documents/{document_uuid}","href":"/api-reference/knowledge-base/get"},{"title":"Delete a document","openapi":"DELETE /api/v1/knowledge-base/documents/{document_uuid}","href":"/api-reference/knowledge-base/delete"},{"title":"Search knowledge-base chunks","openapi":"POST /api/v1/knowledge-base/search","href":"/api-reference/knowledge-base/search"}]},{"group":"Audio library","pages":[{"title":"List audio recordings","openapi":"GET /api/v1/workflow-recordings/","href":"/api-reference/audio/list"},{"title":"Create audio upload URLs","openapi":"POST /api/v1/workflow-recordings/upload-url","href":"/api-reference/audio/upload"},{"title":"Register uploaded recordings","openapi":"POST /api/v1/workflow-recordings/","href":"/api-reference/audio/create"},{"title":"Rename a recording ID","openapi":"PATCH /api/v1/workflow-recordings/{id}","href":"/api-reference/audio/rename"},{"title":"Delete a recording","openapi":"DELETE /api/v1/workflow-recordings/{recording_id}","href":"/api-reference/audio/delete"},{"title":"Transcribe an audio file","openapi":"POST /api/v1/workflow-recordings/transcribe","href":"/api-reference/audio/transcribe"},{"title":"Create an ambient audio upload URL","openapi":"POST /api/v1/workflow/ambient-noise/upload-url","href":"/api-reference/audio/ambient"}]},{"group":"Runs","pages":[{"title":"Overview","href":"/api-reference/runs"},{"title":"Trigger an Outbound Agent Run by API Trigger Node","openapi":"POST /api/v1/public/agent/{uuid}","href":"/api-reference/runs/trigger"},{"title":"Trigger an Outbound Agent Run by Agent UUID","openapi":"POST /api/v1/public/agent/workflow/{workflow_uuid}","href":"/api-reference/runs/trigger-workflow"}]},{"group":"Campaigns","pages":[{"title":"Overview","href":"/api-reference/campaigns"},{"title":"Upload Contacts CSV","openapi":"POST /api/v1/s3/presigned-upload-url","href":"/api-reference/campaigns/upload-contacts"},{"title":"Create Campaign","openapi":"POST /api/v1/campaign/create","href":"/api-reference/campaigns/create"},{"title":"List Campaigns","openapi":"GET /api/v1/campaign/","href":"/api-reference/campaigns/list"},{"title":"Get Campaign","openapi":"GET /api/v1/campaign/{campaign_id}","href":"/api-reference/campaigns/get"},{"title":"Update Campaign","openapi":"PATCH /api/v1/campaign/{campaign_id}","href":"/api-reference/campaigns/update"},{"title":"Start Campaign","openapi":"POST /api/v1/campaign/{campaign_id}/start","href":"/api-reference/campaigns/start"},{"title":"Pause Campaign","openapi":"POST /api/v1/campaign/{campaign_id}/pause","href":"/api-reference/campaigns/pause"},{"title":"Resume Campaign","openapi":"POST /api/v1/campaign/{campaign_id}/resume","href":"/api-reference/campaigns/resume"},{"title":"Get Campaign Progress","openapi":"GET /api/v1/campaign/{campaign_id}/progress","href":"/api-reference/campaigns/progress"},{"title":"Get Campaign Runs","openapi":"GET /api/v1/campaign/{campaign_id}/runs","href":"/api-reference/campaigns/runs"},{"title":"Create a redial campaign","openapi":"POST /api/v1/campaign/{campaign_id}/redial","href":"/api-reference/campaigns/redial"},{"title":"Download campaign source","openapi":"GET /api/v1/campaign/{campaign_id}/source-download-url","href":"/api-reference/campaigns/source"},{"title":"Download a campaign report","openapi":"GET /api/v1/campaign/{campaign_id}/report","href":"/api-reference/campaigns/report"},{"title":"Get campaign defaults","openapi":"GET /api/v1/organizations/campaign-defaults","href":"/api-reference/campaigns/defaults"}]},{"group":"Telephony Configurations","pages":[{"title":"Overview","href":"/api-reference/telephony-configs"},{"title":"List Supported Providers","openapi":"GET /api/v1/organizations/telephony-providers/metadata","href":"/api-reference/telephony-configs/providers"},{"title":"List Configurations","openapi":"GET /api/v1/organizations/telephony-configs","href":"/api-reference/telephony-configs/list"},{"title":"Create Configuration","openapi":"POST /api/v1/organizations/telephony-configs","href":"/api-reference/telephony-configs/create"},{"title":"Get Configuration","openapi":"GET /api/v1/organizations/telephony-configs/{config_id}","href":"/api-reference/telephony-configs/get"},{"title":"Update Configuration","openapi":"PUT /api/v1/organizations/telephony-configs/{config_id}","href":"/api-reference/telephony-configs/update"},{"title":"Delete Configuration","openapi":"DELETE /api/v1/organizations/telephony-configs/{config_id}","href":"/api-reference/telephony-configs/delete"},{"title":"Set Default Outbound","openapi":"POST /api/v1/organizations/telephony-configs/{config_id}/set-default-outbound","href":"/api-reference/telephony-configs/set-default-outbound"},{"group":"Phone Numbers","pages":[{"title":"List Phone Numbers","openapi":"GET /api/v1/organizations/telephony-configs/{config_id}/phone-numbers","href":"/api-reference/telephony-configs/phone-numbers/list"},{"title":"Add Phone Number","openapi":"POST /api/v1/organizations/telephony-configs/{config_id}/phone-numbers","href":"/api-reference/telephony-configs/phone-numbers/create"},{"title":"Get Phone Number","openapi":"GET /api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}","href":"/api-reference/telephony-configs/phone-numbers/get"},{"title":"Update Phone Number","openapi":"PUT /api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}","href":"/api-reference/telephony-configs/phone-numbers/update"},{"title":"Delete Phone Number","openapi":"DELETE /api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}","href":"/api-reference/telephony-configs/phone-numbers/delete"},{"title":"Set Default Caller","openapi":"POST /api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}/set-default-caller","href":"/api-reference/telephony-configs/phone-numbers/set-default-caller"}]},{"title":"Get telephony configuration warnings","openapi":"GET /api/v1/organizations/telephony-config-warnings","href":"/api-reference/telephony-configs/warnings"}]},{"group":"Account","pages":[{"title":"Get your profile","openapi":"GET /api/v1/user/profile","href":"/api-reference/account/profile"},{"title":"Update your profile","openapi":"PATCH /api/v1/user/profile","href":"/api-reference/account/update-profile"},{"title":"Get notification preferences","openapi":"GET /api/v1/user/notifications","href":"/api-reference/account/notifications"},{"title":"Update notification preferences","openapi":"PATCH /api/v1/user/notifications","href":"/api-reference/account/update-notifications"}]},{"group":"Workspace management","pages":[{"title":"List your workspaces","openapi":"GET /api/v1/user/workspaces","href":"/api-reference/workspace-management/list"},{"title":"Switch the selected workspace group","openapi":"POST /api/v1/user/groups/{group_id}/switch","href":"/api-reference/workspace-management/switch"},{"title":"Create a workspace","openapi":"POST /api/v1/user/tenants","href":"/api-reference/workspace-management/create"},{"title":"Rename a workspace","openapi":"PATCH /api/v1/user/workspaces/{tenant_id}","href":"/api-reference/workspace-management/rename"},{"title":"Create a workspace group","openapi":"POST /api/v1/user/groups","href":"/api-reference/workspace-management/create-group"}]},{"group":"AI connections","pages":[{"title":"Get AI configuration options","openapi":"GET /api/v1/user/configurations/defaults","href":"/api-reference/ai-connections/defaults"},{"title":"Get AI connections","openapi":"GET /api/v1/user/configurations/user","href":"/api-reference/ai-connections/get"},{"title":"Update AI connections","openapi":"PUT /api/v1/user/configurations/user","href":"/api-reference/ai-connections/update"},{"title":"Check AI connection status","openapi":"GET /api/v1/user/configurations/user/validate","href":"/api-reference/ai-connections/validate"},{"title":"List AI credential metadata","openapi":"GET /api/v1/user/configurations/credentials","href":"/api-reference/ai-connections/credentials"},{"title":"Create an AI credential","openapi":"POST /api/v1/user/configurations/credentials","href":"/api-reference/ai-connections/create-credential"},{"title":"List provider voices","openapi":"GET /api/v1/user/configurations/voices/{provider}","href":"/api-reference/ai-connections/voices"}]},{"group":"Calendly","pages":[{"title":"Get Calendly connection","openapi":"GET /api/v1/integrations/calendly","href":"/api-reference/calendly/status"},{"title":"Start a Calendly connection","openapi":"POST /api/v1/integrations/calendly/connect","href":"/api-reference/calendly/connect"},{"title":"Complete Calendly authorization","openapi":"POST /api/v1/integrations/calendly/callback","href":"/api-reference/calendly/callback"},{"title":"Refresh Calendly tools","openapi":"POST /api/v1/integrations/calendly/refresh","href":"/api-reference/calendly/refresh"},{"title":"Disconnect Calendly","openapi":"POST /api/v1/integrations/calendly/disconnect","href":"/api-reference/calendly/disconnect"}]},{"group":"Members and invitations","pages":[{"title":"List members","openapi":"GET /api/v1/organizations/members","href":"/api-reference/members/list"},{"title":"Get membership counts","openapi":"GET /api/v1/organizations/members/stats","href":"/api-reference/members/stats"},{"title":"Change a member role","openapi":"PUT /api/v1/organizations/members/{member_id}/role","href":"/api-reference/members/role"},{"title":"Remove a member","openapi":"DELETE /api/v1/organizations/members/{member_id}","href":"/api-reference/members/remove"},{"title":"List pending invitations","openapi":"GET /api/v1/organizations/invites","href":"/api-reference/members/invites"},{"title":"Invite members","openapi":"POST /api/v1/organizations/invites","href":"/api-reference/members/invite"},{"title":"Revoke an invitation","openapi":"DELETE /api/v1/organizations/invites/{invite_id}","href":"/api-reference/members/revoke-invite"},{"title":"Get invitation details","openapi":"GET /api/v1/organizations/invites/{token}/details","href":"/api-reference/members/invite-details"},{"title":"Accept an invitation","openapi":"POST /api/v1/organizations/invites/{token}/accept","href":"/api-reference/members/accept-invite"}]},{"group":"Observability connections","pages":[{"title":"Get the Datadog connection","openapi":"GET /api/v1/organizations/datadog","href":"/api-reference/observability/datadog"},{"title":"Save the Datadog connection","openapi":"PUT /api/v1/organizations/datadog","href":"/api-reference/observability/save-datadog"},{"title":"Test the Datadog credential","openapi":"POST /api/v1/organizations/datadog/test","href":"/api-reference/observability/test-datadog"},{"title":"Remove the Datadog connection","openapi":"DELETE /api/v1/organizations/datadog","href":"/api-reference/observability/delete-datadog"},{"title":"Get the Langfuse connection","openapi":"GET /api/v1/organizations/langfuse-credentials","href":"/api-reference/observability/langfuse"},{"title":"Save the Langfuse connection","openapi":"POST /api/v1/organizations/langfuse-credentials","href":"/api-reference/observability/save-langfuse"},{"title":"Remove the Langfuse connection","openapi":"DELETE /api/v1/organizations/langfuse-credentials","href":"/api-reference/observability/delete-langfuse"}]},{"group":"Reports","pages":[{"title":"Get a daily report","openapi":"GET /api/v1/organizations/reports/daily","href":"/api-reference/reports/daily"},{"title":"List report agents","openapi":"GET /api/v1/organizations/reports/workflows","href":"/api-reference/reports/workflows"},{"title":"Get top agents by recent activity","openapi":"GET /api/v1/organizations/reports/top-workflows","href":"/api-reference/reports/top-workflows"},{"title":"Get analytics overview","openapi":"GET /api/v1/organizations/reports/overview","href":"/api-reference/reports/overview"},{"title":"Get call volume","openapi":"GET /api/v1/organizations/reports/call-volume","href":"/api-reference/reports/call-volume"},{"title":"Get call outcomes","openapi":"GET /api/v1/organizations/reports/outcomes","href":"/api-reference/reports/outcomes"},{"title":"Get provider usage","openapi":"GET /api/v1/organizations/reports/providers","href":"/api-reference/reports/providers"},{"title":"Get call activity heatmap","openapi":"GET /api/v1/organizations/reports/heatmap","href":"/api-reference/reports/heatmap"},{"title":"Get usage by model","openapi":"GET /api/v1/organizations/reports/usage-by-model","href":"/api-reference/reports/usage-by-model"},{"title":"Rank agents for a reporting period","openapi":"GET /api/v1/organizations/reports/top-workflows-extended","href":"/api-reference/reports/top-workflows-extended"},{"title":"Get daily run details","openapi":"GET /api/v1/organizations/reports/daily/runs","href":"/api-reference/reports/daily-runs"},{"title":"List analytics runs","openapi":"GET /api/v1/organizations/reports/runs","href":"/api-reference/reports/runs"},{"title":"Get call performance","openapi":"GET /api/v1/organizations/reports/call-performance","href":"/api-reference/reports/call-performance"}]},{"group":"Usage","pages":[{"title":"Get current-period usage","openapi":"GET /api/v1/organizations/usage/current-period","href":"/api-reference/usage/current"},{"title":"List usage runs","openapi":"GET /api/v1/organizations/usage/runs","href":"/api-reference/usage/runs"},{"title":"Export usage runs","openapi":"GET /api/v1/organizations/usage/runs/report","href":"/api-reference/usage/export"},{"title":"Get daily usage","openapi":"GET /api/v1/organizations/usage/daily-breakdown","href":"/api-reference/usage/daily"}]},{"group":"Files","pages":[{"title":"Create a file download URL","openapi":"GET /api/v1/s3/signed-url","href":"/api-reference/files/download"},{"title":"Get file metadata","openapi":"GET /api/v1/s3/file-metadata","href":"/api-reference/files/metadata"}]},{"group":"Calls","pages":[{"title":"Test a call by trigger","openapi":"POST /api/v1/public/agent/test/{uuid}","href":"/api-reference/calls/test-trigger"},{"title":"Test a call by agent UUID","openapi":"POST /api/v1/public/agent/test/workflow/{workflow_uuid}","href":"/api-reference/calls/test-agent"},{"title":"Place a draft test call","openapi":"POST /api/v1/telephony/initiate-call","href":"/api-reference/calls/test-phone"}]},{"group":"Integration guides","pages":[{"title":"Agent UUID","href":"/configurations/agent-uuid"},{"title":"Receive call results","href":"/developer/webhooks"},{"title":"Workflow Definition Schema","href":"/developer/workflow-schema"}]}]},{"tab":"MCP","icon":"plug","pages":[{"title":"MCP","href":"/integrations/mcp"}]}]},"basePath":"","title":"Create a tool - Bandwidth Agent Builder","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}