Your Wixzel Voice API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.
Body
application/json
Option 1
Option 2
webhook calls your endpoint and works on every call. client asks the caller's app or website to do something, over the realtime session; it is never offered on phone calls.
What the agent passes when it calls the tool, as a JSON Schema object. Describe every property: the agent reads the descriptions to decide what to fill in. At most 30 properties, three levels deep.
Show child attributes
Example:
{ "type": "object", "properties": { "order_id": { "type": "string", "description": "The order number the caller reads out" } }, "required": ["order_id"] }
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Wixzel Voice","colors":{"primary":"#A0D425","light":"#B4E63F","dark":"#A0D425"},"logo":{"light":"https://mintcdn.com/wixzel/HwQTLjpYLGrNSo5e/logo/light.png?fit=max\u0026auto=format\u0026n=HwQTLjpYLGrNSo5e\u0026q=85\u0026s=f77486fb54c4d73acde1ed87b534af5d","dark":"https://mintcdn.com/wixzel/HF4ObqENc3iamXvz/logo/dark.png?fit=max\u0026auto=format\u0026n=HF4ObqENc3iamXvz\u0026q=85\u0026s=9d6e569aacc29f07bf16f1e63276ff9a","href":"https://voice.wixzel.com"},"favicon":"https://mintcdn.com/wixzel/tEejfXfPmKt3Fqur/favicon.ico?fit=max\u0026auto=format\u0026n=tEejfXfPmKt3Fqur\u0026q=85\u0026s=b1931601394f0a112b235257d2e6bb27","api":{"playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer"},"server":"https://api.voice.wixzel.com"}},"appearance":{"default":"dark"},"background":{"color":{"dark":"#0D0D0D"}},"navbar":{"links":[{"href":"https://voice.wixzel.com/pricing","label":"Pricing"},{"href":"https://voice.wixzel.com/guides","label":"Guides"}],"primary":{"type":"button","label":"Get an API key","href":"https://voice.wixzel.com/signup"}},"footer":{"socials":{"website":"https://voice.wixzel.com","github":"https://github.com/aqeelshamz/wixzel-voice-sdks"},"links":[{"header":"Wixzel Voice","items":[{"label":"Facts","href":"https://voice.wixzel.com/facts"},{"label":"Pricing","href":"https://voice.wixzel.com/pricing"},{"label":"Solutions","href":"https://voice.wixzel.com/solutions"},{"label":"Integrations","href":"https://voice.wixzel.com/carriers"},{"label":"Guides","href":"https://voice.wixzel.com/guides"}]}]},"seo":{"metatags":{"og:site_name":"Wixzel Voice","og:image":"https://voice.wixzel.com/opengraph-image"},"organization":{"id":"https://voice.wixzel.com/#organization","name":"Wixzel Voice","legalName":"Aqeel Shamsudheen, trading as Wixzel","url":"https://voice.wixzel.com","logo":"https://voice.wixzel.com/icon-512.png","sameAs":["https://github.com/aqeelshamz/wixzel-voice-sdks","https://www.npmjs.com/package/wixzel-voice","https://www.npmjs.com/package/wixzel-voice-mcp","https://pub.dev/packages/wixzel_voice","https://pub.dev/packages/wixzel_voice_flutter","https://wixzel.com/products/wixzel-voice"]}},"fonts":{"heading":{"family":"Sora"},"body":{"family":"Plus Jakarta Sans"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wixzel","hasAudioNarration":false,"actualSubdomain":"wixzel","customDomains":["docs.voice.wixzel.com"],"gitSource":{"type":"github","owner":"aqeelshamz","repo":"wixzel-voice","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae6bc6f748e6ef8daae3c55","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API reference","count":122},{"language":"default","tag":"Guides","count":19},{"language":"default","tag":"WhatsApp","count":15},{"language":"default","tag":"Knowledge bases","count":11},{"language":"default","tag":"Agents","count":10},{"language":"default","tag":"Carriers","count":8},{"language":"default","tag":"Phone numbers","count":8},{"language":"default","tag":"SIP trunks","count":8},{"language":"default","tag":"Concepts","count":7},{"language":"default","tag":"MCP servers","count":7}]},"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":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/tools/create-a-tool","slug":"/api-reference/tools/create-a-tool","pageMetadata":{"title":"Create a tool","description":"Requires `tools:write`.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tools","href":"/api-reference/tools/create-a-tool","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Requires \", _jsx(_components.code, {\n children: \"tools:write\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a tool","description":"Requires `tools:write`.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tools","href":"/api-reference/tools/create-a-tool","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Tools"],"security":["a12958a9-d5b3-419a-8490-cdfaf84c01bd"],"summary":"Create a tool","description":"Requires `tools:write`.","requestBody":"8e09457a-dd37-4eb1-b1b8-0478468fe8d2","responses":{"201":"ab860038-e7a6-4b7b-b509-7e619118bf64","400":"48e7c96e-9052-4314-be27-d738dafd170a","401":"a30efd6d-74ee-4b01-ac2c-90fdd8614954","403":"fbb8d53e-3566-49c6-abce-ca7b8b185fbe","429":"dea8c377-8af5-44fb-aa7a-beb26511dbac"},"method":"post","type":"path","servers":["50caa847-efef-4272-9503-c28e7b472acd"],"path":"/v1/tools","baseUrlOptions":["https://api.voice.wixzel.com"],"title":"Create a tool","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"`webhook` calls your endpoint and works on every call. `client` asks the caller's app or website to do something, over the realtime session; it is never offered on phone calls.","required":["name","description","type","webhook"],"properties":{"name":{"type":"string","pattern":"^[a-zA-Z_][a-zA-Z0-9_]{0,63}$","description":"What the agent calls it. Unique in the account.","example":"check_order_status","isRequired":true,"uniqueKey":"oneOf.0.name","typeLabel":"string"},"description":{"type":"string","minLength":1,"maxLength":1000,"description":"Tells the agent what the tool does and when to use it.","example":"Look up where an order is. Use it when the caller asks about a delivery.","isRequired":true,"uniqueKey":"oneOf.0.description","typeLabel":"string"},"type":{"type":"string","enum":["webhook"],"isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"enum\u003cstring>"},"webhook":{"type":"object","properties":{"url":{"type":"string","maxLength":2048,"format":"uri","description":"Public https (or http) on port 443 or 80.","example":"https://api.example.com/orders/status","isRequired":true,"uniqueKey":"oneOf.0.webhook.url","typeLabel":"string\u003curi>"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"default":"POST","description":"The arguments are the JSON body, or query parameters for GET and DELETE.","uniqueKey":"oneOf.0.webhook.method","typeLabel":"enum\u003cstring>"},"headers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9-]{0,63}$","example":"Authorization","isRequired":true,"uniqueKey":"oneOf.0.webhook.headers.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","minLength":1,"maxLength":4096,"description":"Write-only, encrypted at rest, never returned. Required on create. On update, omit it to keep the value stored under this name.","example":"Bearer sk_live_…","uniqueKey":"oneOf.0.webhook.headers.items.[INDEX].value","typeLabel":"string"}},"required":["name"],"uniqueKey":"oneOf.0.webhook.headers.items.[INDEX]","typeLabel":"object"},"maxItems":20,"description":"Sent with every request, such as an API key. Replaced as a whole when sent.","uniqueKey":"oneOf.0.webhook.headers","typeLabel":"object[]"},"timeout_ms":{"type":"integer","minimum":1000,"maximum":30000,"default":10000,"description":"How long the agent waits for the answer. The caller hears silence meanwhile, so keep it short.","uniqueKey":"oneOf.0.webhook.timeout_ms","typeLabel":"integer"}},"required":["url"],"isRequired":true,"uniqueKey":"oneOf.0.webhook","typeLabel":"object"},"parameters":{"type":"object","properties":{"type":{"type":"string","enum":["object"],"isRequired":true,"uniqueKey":"oneOf.0.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","additionalProperties":{"type":"object","properties":{"type":{"type":"string","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"oneOf.0.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","maxLength":500,"uniqueKey":"oneOf.0.parameters.properties.additionalProperties.description","typeLabel":"string"},"enum":{"type":"array","items":{"oneOf":[{"type":"string","maxLength":200,"uniqueKey":"oneOf.0.parameters.properties.additionalProperties.enum.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.0.parameters.properties.additionalProperties.enum.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"oneOf.0.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string | number"},"maxItems":50,"uniqueKey":"oneOf.0.parameters.properties.additionalProperties.enum","typeLabel":"(string | number)[]"},"items":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.parameters.properties.additionalProperties.\\items.additionalProperties","typeLabel":"any"},"description":"For `array`: the schema of each item.","uniqueKey":"oneOf.0.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.parameters.properties.additionalProperties.properties.additionalProperties","typeLabel":"any"},"description":"For `object`: its own properties, at most three levels deep in all.","uniqueKey":"oneOf.0.parameters.properties.additionalProperties.properties","typeLabel":"object"},"required":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.parameters.properties.additionalProperties.required","typeLabel":"string[]"}},"required":["type"],"uniqueKey":"oneOf.0.parameters.properties.additionalProperties","typeLabel":"object"},"default":{},"uniqueKey":"oneOf.0.parameters.properties","typeLabel":"object"},"required":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.parameters.required.items.[INDEX]","typeLabel":"string"},"maxItems":30,"uniqueKey":"oneOf.0.parameters.required","typeLabel":"string[]"}},"required":["type"],"description":"What the agent passes when it calls the tool, as a JSON Schema object. Describe every property: the agent reads the descriptions to decide what to fill in. At most 30 properties, three levels deep.","example":{"type":"object","properties":{"order_id":{"type":"string","description":"The order number the caller reads out"}},"required":["order_id"]},"uniqueKey":"oneOf.0.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"`webhook` calls your endpoint and works on every call. `client` asks the caller's app or website to do something, over the realtime session; it is never offered on phone calls.","required":["name","description","type"],"properties":{"name":{"type":"string","pattern":"^[a-zA-Z_][a-zA-Z0-9_]{0,63}$","description":"What the agent calls it. Unique in the account.","example":"check_order_status","isRequired":true,"uniqueKey":"oneOf.1.name","typeLabel":"string"},"description":{"type":"string","minLength":1,"maxLength":1000,"description":"Tells the agent what the tool does and when to use it.","example":"Look up where an order is. Use it when the caller asks about a delivery.","isRequired":true,"uniqueKey":"oneOf.1.description","typeLabel":"string"},"type":{"type":"string","enum":["client"],"isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"enum\u003cstring>"},"parameters":{"type":"object","properties":{"type":{"type":"string","enum":["object"],"isRequired":true,"uniqueKey":"oneOf.1.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","additionalProperties":{"type":"object","properties":{"type":{"type":"string","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"oneOf.1.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","maxLength":500,"uniqueKey":"oneOf.1.parameters.properties.additionalProperties.description","typeLabel":"string"},"enum":{"type":"array","items":{"oneOf":[{"type":"string","maxLength":200,"uniqueKey":"oneOf.1.parameters.properties.additionalProperties.enum.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.1.parameters.properties.additionalProperties.enum.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"oneOf.1.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string | number"},"maxItems":50,"uniqueKey":"oneOf.1.parameters.properties.additionalProperties.enum","typeLabel":"(string | number)[]"},"items":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.1.parameters.properties.additionalProperties.\\items.additionalProperties","typeLabel":"any"},"description":"For `array`: the schema of each item.","uniqueKey":"oneOf.1.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.1.parameters.properties.additionalProperties.properties.additionalProperties","typeLabel":"any"},"description":"For `object`: its own properties, at most three levels deep in all.","uniqueKey":"oneOf.1.parameters.properties.additionalProperties.properties","typeLabel":"object"},"required":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.1.parameters.properties.additionalProperties.required","typeLabel":"string[]"}},"required":["type"],"uniqueKey":"oneOf.1.parameters.properties.additionalProperties","typeLabel":"object"},"default":{},"uniqueKey":"oneOf.1.parameters.properties","typeLabel":"object"},"required":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.parameters.required.items.[INDEX]","typeLabel":"string"},"maxItems":30,"uniqueKey":"oneOf.1.parameters.required","typeLabel":"string[]"}},"required":["type"],"description":"What the agent passes when it calls the tool, as a JSON Schema object. Describe every property: the agent reads the descriptions to decide what to fill in. At most 30 properties, three levels deep.","example":{"type":"object","properties":{"order_id":{"type":"string","description":"The order number the caller reads out"}},"required":["order_id"]},"uniqueKey":"oneOf.1.parameters","typeLabel":"object"},"client":{"type":"object","properties":{"wait_for_result":{"type":"boolean","default":true,"description":"Wait for the app to answer (it can return data to the agent), or tell the agent it is done at once, for actions such as opening a page.","uniqueKey":"oneOf.1.client.wait_for_result","typeLabel":"boolean"},"timeout_ms":{"type":"integer","minimum":1000,"maximum":30000,"default":10000,"uniqueKey":"oneOf.1.client.timeout_ms","typeLabel":"integer"}},"uniqueKey":"oneOf.1.client","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"check_order_status","description":"Look up where an order is. Use it when the caller asks about a delivery.","type":"webhook","webhook":{"url":"https://api.example.com/orders/status","method":"POST","headers":[{"name":"Authorization","value":"Bearer sk_live_…"}],"timeout_ms":10000},"parameters":{"type":"object","properties":{"order_id":{"type":"string","description":"The order number the caller reads out"}},"required":["order_id"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ab860038-e7a6-4b7b-b509-7e619118bf64":{"description":"The created a tool","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{24}$","example":"6a96a3ead6e886d42462dd3e","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","enum":["tool"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"description":{"type":"string","isRequired":true,"uniqueKey":"description","typeLabel":"string"},"type":{"type":"string","enum":["webhook","client"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"parameters":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"parameters.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"parameters","typeLabel":"object"},"webhook":{"oneOf":[{"type":"object","properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"webhook.oneOf.0.url","typeLabel":"string"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"isRequired":true,"uniqueKey":"webhook.oneOf.0.method","typeLabel":"enum\u003cstring>"},"header_names":{"type":"array","items":{"type":"string","uniqueKey":"webhook.oneOf.0.header_names.items.[INDEX]","typeLabel":"string"},"description":"The names of the stored headers. Their values are never returned.","isRequired":true,"uniqueKey":"webhook.oneOf.0.header_names","typeLabel":"string[]"},"timeout_ms":{"type":"integer","isRequired":true,"uniqueKey":"webhook.oneOf.0.timeout_ms","typeLabel":"integer"}},"required":["url","method","header_names","timeout_ms"],"isRequired":true,"uniqueKey":"webhook.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"url":{"type":"string"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"]},"header_names":{"type":"array","items":{"type":"string"},"description":"The names of the stored headers. Their values are never returned."},"timeout_ms":{"type":"integer"}},"required":["url","method","header_names","timeout_ms"],"isRequired":true,"uniqueKey":"webhook.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"webhook","typeLabel":"object | null"},"client":{"oneOf":[{"type":"object","properties":{"wait_for_result":{"type":"boolean","isRequired":true,"uniqueKey":"client.oneOf.0.wait_for_result","typeLabel":"boolean"},"timeout_ms":{"type":"integer","isRequired":true,"uniqueKey":"client.oneOf.0.timeout_ms","typeLabel":"integer"}},"required":["wait_for_result","timeout_ms"],"isRequired":true,"uniqueKey":"client.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"wait_for_result":{"type":"boolean"},"timeout_ms":{"type":"integer"}},"required":["wait_for_result","timeout_ms"],"isRequired":true,"uniqueKey":"client.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"client","typeLabel":"object | null"},"created_at":{"type":"string","format":"date-time","description":"ISO 8601, always UTC.","example":"2026-09-01T12:00:00.000Z","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"ISO 8601, always UTC.","example":"2026-09-01T12:00:00.000Z","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"required":["id","object","name","description","type","parameters","webhook","client","created_at","updated_at"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"6a96a3ead6e886d42462dd3e","object":"tool","name":"\u003cstring>","description":"\u003cstring>","type":"webhook","parameters":{},"webhook":{"url":"\u003cstring>","method":"GET","header_names":["\u003cstring>"],"timeout_ms":123},"client":{"wait_for_result":true,"timeout_ms":123},"created_at":"2026-09-01T12:00:00.000Z","updated_at":"2026-09-01T12:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"48e7c96e-9052-4314-be27-d738dafd170a":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","insufficient_credits","not_found_error","conflict_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Stable machine-readable code.","example":"agent_not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. Do not match on this — match on code.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Quote this when asking for help.","example":"req_01HXYZ...","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"param":{"type":"string","description":"Which field caused the failure, when applicable.","uniqueKey":"error.param","typeLabel":"string"},"doc_url":{"type":"string","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["type","code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"agent_not_found","message":"\u003cstring>","request_id":"req_01HXYZ...","param":"\u003cstring>","doc_url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"a30efd6d-74ee-4b01-ac2c-90fdd8614954":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","insufficient_credits","not_found_error","conflict_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Stable machine-readable code.","example":"agent_not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. Do not match on this — match on code.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Quote this when asking for help.","example":"req_01HXYZ...","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"param":{"type":"string","description":"Which field caused the failure, when applicable.","uniqueKey":"error.param","typeLabel":"string"},"doc_url":{"type":"string","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["type","code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"agent_not_found","message":"\u003cstring>","request_id":"req_01HXYZ...","param":"\u003cstring>","doc_url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"fbb8d53e-3566-49c6-abce-ca7b8b185fbe":{"description":"Key lacks the required scope","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","insufficient_credits","not_found_error","conflict_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Stable machine-readable code.","example":"agent_not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. Do not match on this — match on code.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Quote this when asking for help.","example":"req_01HXYZ...","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"param":{"type":"string","description":"Which field caused the failure, when applicable.","uniqueKey":"error.param","typeLabel":"string"},"doc_url":{"type":"string","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["type","code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"agent_not_found","message":"\u003cstring>","request_id":"req_01HXYZ...","param":"\u003cstring>","doc_url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"dea8c377-8af5-44fb-aa7a-beb26511dbac":{"description":"Rate limited. Retry after the interval in `Retry-After`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","insufficient_credits","not_found_error","conflict_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Stable machine-readable code.","example":"agent_not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. Do not match on this — match on code.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Quote this when asking for help.","example":"req_01HXYZ...","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"param":{"type":"string","description":"Which field caused the failure, when applicable.","uniqueKey":"error.param","typeLabel":"string"},"doc_url":{"type":"string","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["type","code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"agent_not_found","message":"\u003cstring>","request_id":"req_01HXYZ...","param":"\u003cstring>","doc_url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a12958a9-d5b3-419a-8490-cdfaf84c01bd":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your Wixzel Voice API key: `Authorization: Bearer wv_live_...`. Keys are scoped; grant only what the integration needs.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"50caa847-efef-4272-9503-c28e7b472acd":{"url":"https://api.voice.wixzel.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your Wixzel Voice API key: `Authorization: Bearer wv_live_...`. Keys are scoped; grant only what the integration needs.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your Wixzel Voice API key: `Authorization: Bearer wv_live_...`. Keys are scoped; grant only what the integration needs.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"wixzel","siteName":"Wixzel Voice","title":"Create a tool - Wixzel Voice","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T02:55:11.061Z","originalFileLocation":"api-reference/tools/create-a-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=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Requires tools:write.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Wixzel Voice\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wixzel/UnboSZUle7evZMp7/_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/wixzel/UnboSZUle7evZMp7/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wixzel/UnboSZUle7evZMp7/_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/wixzel/UnboSZUle7evZMp7/_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/wixzel/UnboSZUle7evZMp7/_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/wixzel/UnboSZUle7evZMp7/_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/wixzel/UnboSZUle7evZMp7/_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/wixzel/UnboSZUle7evZMp7/_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/wixzel/UnboSZUle7evZMp7/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a tool - Wixzel Voice\">\u003cmeta data-mint-head property=\"og:description\" content=\"Requires tools:write.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Wixzel Voice\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.voice.wixzel.com/api-reference/tools/create-a-tool\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://voice.wixzel.com/opengraph-image\">\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 - Wixzel Voice\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Requires tools:write.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://voice.wixzel.com/opengraph-image\">\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/wixzel/UnboSZUle7evZMp7/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Wixzel Voice\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#A0D425\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.voice.wixzel.com/api-reference/tools/create-a-tool\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/tools/create-a-tool.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://voice.wixzel.com/#organization\",\"name\":\"Wixzel Voice\",\"legalName\":\"Aqeel Shamsudheen, trading as Wixzel\",\"url\":\"https://voice.wixzel.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://voice.wixzel.com/icon-512.png\"},\"sameAs\":[\"https://github.com/aqeelshamz/wixzel-voice-sdks\",\"https://www.npmjs.com/package/wixzel-voice\",\"https://www.npmjs.com/package/wixzel-voice-mcp\",\"https://pub.dev/packages/wixzel_voice\",\"https://pub.dev/packages/wixzel_voice_flutter\",\"https://wixzel.com/products/wixzel-voice\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.voice.wixzel.com#website\",\"name\":\"Wixzel Voice\",\"url\":\"https://docs.voice.wixzel.com\",\"publisher\":{\"@id\":\"https://voice.wixzel.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.voice.wixzel.com/api-reference/tools/create-a-tool#webpage\",\"url\":\"https://docs.voice.wixzel.com/api-reference/tools/create-a-tool\",\"name\":\"Create a tool\",\"description\":\"Requires tools:write.\",\"dateModified\":\"2026-10-28T02:55:11.061Z\",\"isPartOf\":{\"@id\":\"https://docs.voice.wixzel.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.voice.wixzel.com/api-reference/tools/create-a-tool#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.voice.wixzel.com/api-reference/tools/create-a-tool#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.voice.wixzel.com/api-reference/agents/list-agents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Tools\",\"item\":\"https://docs.voice.wixzel.com/api-reference/tools/list-tools\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a tool\",\"item\":\"https://docs.voice.wixzel.com/api-reference/tools/create-a-tool\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.voice.wixzel.com/api-reference/tools/create-a-tool#apireference\",\"headline\":\"Create a tool\",\"name\":\"Create a tool\",\"description\":\"Requires tools:write.\",\"url\":\"https://docs.voice.wixzel.com/api-reference/tools/create-a-tool\",\"mainEntityOfPage\":{\"@id\":\"https://docs.voice.wixzel.com/api-reference/tools/create-a-tool#webpage\"},\"image\":\"https://voice.wixzel.com/opengraph-image\",\"dateModified\":\"2026-10-28T02:55:11.061Z\",\"publisher\":{\"@id\":\"https://voice.wixzel.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.voice.wixzel.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Wixzel Voice\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Wixzel Voice","nav":{"global":null,"groups":[{"group":"Getting started","pages":[{"title":"Wixzel Voice documentation: API, SDKs and MCP server","sidebarTitle":"Overview","href":"/index"},{"title":"Get started with Wixzel Voice: account, key, credit and trunk","sidebarTitle":"Get started","href":"/get-started"},{"title":"Quickstart: place your first AI voice agent phone call with the API","sidebarTitle":"Quickstart","href":"/quickstart"}]},{"group":"Guides","pages":[{"title":"Build an AI voice agent with the API: prompt, voice and call handling","sidebarTitle":"Agents","href":"/agents"},{"title":"Give your voice agent a face: the agent's mascot","sidebarTitle":"Mascots","href":"/mascots"},{"title":"Callers: who called your agent, and blocking them","sidebarTitle":"Callers","href":"/callers"},{"title":"Give your AI phone agent a knowledge base","sidebarTitle":"Knowledge bases","href":"/knowledge-bases"},{"title":"Give your AI phone agent tools: webhooks and app actions","sidebarTitle":"Tools","href":"/tools"},{"title":"Clone a voice for your AI phone agent","sidebarTitle":"Voice cloning","href":"/voice-cloning"},{"title":"Put your AI agent on WhatsApp","sidebarTitle":"WhatsApp","href":"/whatsapp"},{"title":"Wixzel Voice API keys: scopes, rotation and revocation","sidebarTitle":"API keys","href":"/api-keys"},{"title":"Prepaid credits: what an AI phone call costs, billed per second","sidebarTitle":"Credits","href":"/credits"},{"title":"SIP trunks: connect any carrier to Wixzel Voice","sidebarTitle":"SIP trunks","href":"/sip-trunks"},{"title":"Wixzel Voice SDKs for TypeScript and Dart (Flutter)","sidebarTitle":"SDKs","href":"/sdks"},{"title":"Call the Wixzel Voice API from cURL, Node.js and Python","sidebarTitle":"Integrate","href":"/integrate"},{"title":"Wixzel Voice MCP server: connect Claude Code, Codex, Cursor or any MCP client","sidebarTitle":"MCP server","href":"/mcp-server"},{"title":"Let a voice agent use other apps' MCP servers during a call","sidebarTitle":"MCP integrations","href":"/mcp-integrations"},{"title":"Webhooks for AI phone calls: signed events and a delivery log","sidebarTitle":"Webhooks","href":"/webhooks"},{"title":"Realtime API: connect a web or Flutter app to an agent over WebSocket","sidebarTitle":"Realtime: web and mobile","href":"/realtime"},{"title":"Meetings: send an AI voice agent into Zoom, Google Meet or Teams","sidebarTitle":"Meetings","href":"/meetings"},{"title":"Compose a voice AI pipeline: speech-to-text, LLM and text-to-speech","sidebarTitle":"Compose a voice engine","href":"/composing"},{"title":"Self-host Wixzel Voice on your own server","sidebarTitle":"Self-hosting","href":"/self-hosting"}]},{"group":"Carriers","pages":[{"title":"Twilio Elastic SIP Trunking: console steps for Wixzel Voice","sidebarTitle":"Twilio","href":"/carriers/twilio"},{"title":"Telnyx SIP Connection: console steps for Wixzel Voice","sidebarTitle":"Telnyx","href":"/carriers/telnyx"},{"title":"Plivo Zentrunk: console steps for Wixzel Voice","sidebarTitle":"Plivo","href":"/carriers/plivo"},{"title":"Vonage Programmable SIP: console steps for Wixzel Voice","sidebarTitle":"Vonage","href":"/carriers/vonage"},{"title":"Bandwidth SIP trunk: console steps for Wixzel Voice","sidebarTitle":"Bandwidth","href":"/carriers/bandwidth"},{"title":"Exotel vSIP trunk: console steps for Wixzel Voice","sidebarTitle":"Exotel","href":"/carriers/exotel"},{"title":"Vobiz SIP trunk: console steps for Wixzel Voice","sidebarTitle":"Vobiz","href":"/carriers/vobiz"},{"title":"Mobily SIP trunk: setup for Wixzel Voice","sidebarTitle":"Mobily","href":"/carriers/mobily"}]},{"group":"Concepts","pages":[{"title":"Voice engines: STT, LLM and TTS pipelines or one realtime model","sidebarTitle":"Voice engines","href":"/voice-engines"},{"title":"Wixzel Voice billing: per-second metering, itemised usage","sidebarTitle":"Billing","href":"/billing"},{"title":"Authenticate to the Wixzel Voice API with scoped bearer keys","sidebarTitle":"Authentication","href":"/authentication"},{"title":"Wixzel Voice API errors: types, codes and request ids","sidebarTitle":"Errors","href":"/errors"},{"title":"Pagination: walking list endpoints with cursors","sidebarTitle":"Pagination","href":"/pagination"},{"title":"Idempotency keys: retry an AI phone call without paying twice","sidebarTitle":"Idempotency","href":"/idempotency"},{"title":"Wixzel Voice rate limits and concurrent call limits","sidebarTitle":"Rate limits","href":"/rate-limits"}]},{"group":"API reference","pages":[{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agents","href":"/api-reference/agents/list-agents"},{"title":"Create an agent","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents","href":"/api-reference/agents/create-an-agent"},{"title":"Retrieve an agent","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agents/{id}","href":"/api-reference/agents/retrieve-an-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/agents/{id}","href":"/api-reference/agents/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/agents/{id}","href":"/api-reference/agents/update-an-agent"},{"title":"Place a test call","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents/{id}/test-call","href":"/api-reference/agents/place-a-test-call"},{"title":"Generate an agent","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents/generate","href":"/api-reference/agents/generate-an-agent"},{"title":"Update an agent's mascot","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/agents/{id}/mascot","href":"/api-reference/agents/update-an-agents-mascot"},{"title":"Generate a new mascot look","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents/{id}/mascot/generate","href":"/api-reference/agents/generate-a-new-mascot-look"},{"title":"Change a mascot's share id","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents/{id}/mascot/rotate-public-id","href":"/api-reference/agents/change-a-mascots-share-id"}]},{"group":"Realtime","pages":[{"title":"Create a realtime session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/realtime/sessions","href":"/api-reference/realtime/create-a-realtime-session"}]},{"group":"Leads","pages":[{"title":"List leads","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/leads","href":"/api-reference/leads/list-leads"},{"title":"Create a lead","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/leads","href":"/api-reference/leads/create-a-lead"},{"title":"Retrieve a lead","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/leads/{id}","href":"/api-reference/leads/retrieve-a-lead"},{"title":"Delete a lead","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/leads/{id}","href":"/api-reference/leads/delete-a-lead"},{"title":"Update a lead","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/leads/{id}","href":"/api-reference/leads/update-a-lead"},{"title":"Import many leads","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/leads/bulk","href":"/api-reference/leads/import-many-leads"}]},{"group":"Campaigns","pages":[{"title":"Start a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/campaigns/{id}/start","href":"/api-reference/campaigns/start-a-campaign"},{"title":"Pause a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/campaigns/{id}/pause","href":"/api-reference/campaigns/pause-a-campaign"},{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Create a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/campaigns","href":"/api-reference/campaigns/create-a-campaign"},{"title":"Retrieve a campaign","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/campaigns/{id}","href":"/api-reference/campaigns/retrieve-a-campaign"},{"title":"Delete a campaign","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/campaigns/{id}","href":"/api-reference/campaigns/delete-a-campaign"}]},{"group":"Knowledge bases","pages":[{"title":"List knowledge bases","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge-bases","href":"/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"Create a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/knowledge-bases","href":"/api-reference/knowledge-bases/create-a-knowledge-base"},{"title":"Retrieve a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge-bases/{id}","href":"/api-reference/knowledge-bases/retrieve-a-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/knowledge-bases/{id}","href":"/api-reference/knowledge-bases/delete-a-knowledge-base"},{"title":"Update a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/knowledge-bases/{id}","href":"/api-reference/knowledge-bases/update-a-knowledge-base"},{"title":"Draft a knowledge base from a website","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/knowledge-bases/import","href":"/api-reference/knowledge-bases/draft-a-knowledge-base-from-a-website"},{"title":"Draft a knowledge base from a file","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/knowledge-bases/import-file","href":"/api-reference/knowledge-bases/draft-a-knowledge-base-from-a-file"},{"title":"List a knowledge base’s files","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge-bases/{id}/files","href":"/api-reference/knowledge-bases/list-a-knowledge-base’s-files"},{"title":"Add files to a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/knowledge-bases/{id}/files","href":"/api-reference/knowledge-bases/add-files-to-a-knowledge-base"},{"title":"Retrieve a knowledge base file","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge-bases/{id}/files/{fileId}","href":"/api-reference/knowledge-bases/retrieve-a-knowledge-base-file"},{"title":"Remove a knowledge base file","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/knowledge-bases/{id}/files/{fileId}","href":"/api-reference/knowledge-bases/remove-a-knowledge-base-file"}]},{"group":"Phone numbers","pages":[{"title":"List phone numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/phone-numbers","href":"/api-reference/phone-numbers/list-phone-numbers"},{"title":"Create a phone number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/phone-numbers","href":"/api-reference/phone-numbers/create-a-phone-number"},{"title":"Retrieve a phone number","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/phone-numbers/{id}","href":"/api-reference/phone-numbers/retrieve-a-phone-number"},{"title":"Delete a phone number","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/phone-numbers/{id}","href":"/api-reference/phone-numbers/delete-a-phone-number"},{"title":"Update a phone number","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/phone-numbers/{id}","href":"/api-reference/phone-numbers/update-a-phone-number"},{"title":"List the numbers on a carrier account","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sip-trunks/{id}/carrier-numbers","href":"/api-reference/phone-numbers/list-the-numbers-on-a-carrier-account"},{"title":"Search for numbers to buy","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sip-trunks/{id}/available-numbers","href":"/api-reference/phone-numbers/search-for-numbers-to-buy"},{"title":"Buy a number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/phone-numbers/purchase","href":"/api-reference/phone-numbers/buy-a-number"}]},{"group":"SIP trunks","pages":[{"title":"List sip trunks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sip-trunks","href":"/api-reference/sip-trunks/list-sip-trunks"},{"title":"Create a SIP trunk","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sip-trunks","href":"/api-reference/sip-trunks/create-a-sip-trunk"},{"title":"Retrieve a SIP trunk","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sip-trunks/{id}","href":"/api-reference/sip-trunks/retrieve-a-sip-trunk"},{"title":"Delete a SIP trunk","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/sip-trunks/{id}","href":"/api-reference/sip-trunks/delete-a-sip-trunk"},{"title":"Update a SIP trunk","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/sip-trunks/{id}","href":"/api-reference/sip-trunks/update-a-sip-trunk"},{"title":"Check a SIP trunk","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sip-trunks/{id}/status","href":"/api-reference/sip-trunks/check-a-sip-trunk"},{"title":"Test a SIP trunk","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sip-trunks/{id}/test","href":"/api-reference/sip-trunks/test-a-sip-trunk"},{"title":"Recent SIP events","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sip-trunks/{id}/logs","href":"/api-reference/sip-trunks/recent-sip-events"}]},{"group":"MCP servers","pages":[{"title":"List mcp servers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/mcp-servers","href":"/api-reference/mcp-servers/list-mcp-servers"},{"title":"Create an MCP server","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/mcp-servers","href":"/api-reference/mcp-servers/create-an-mcp-server"},{"title":"Retrieve an MCP server","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/mcp-servers/{id}","href":"/api-reference/mcp-servers/retrieve-an-mcp-server"},{"title":"Delete an MCP server","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/mcp-servers/{id}","href":"/api-reference/mcp-servers/delete-an-mcp-server"},{"title":"Update an MCP server","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/mcp-servers/{id}","href":"/api-reference/mcp-servers/update-an-mcp-server"},{"title":"Refresh an MCP server’s tools","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/mcp-servers/{id}/refresh","href":"/api-reference/mcp-servers/refresh-an-mcp-server’s-tools"},{"title":"Connect an OAuth MCP server","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/mcp-servers/{id}/oauth/start","href":"/api-reference/mcp-servers/connect-an-oauth-mcp-server"}]},{"group":"Tools","pages":[{"title":"List tools","description":"Cursor-paginated. Requires `tools:read`.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tools","href":"/api-reference/tools/list-tools"},{"title":"Create a tool","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tools","href":"/api-reference/tools/create-a-tool"},{"title":"Retrieve a tool","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tools/{id}","href":"/api-reference/tools/retrieve-a-tool"},{"title":"Delete a tool","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/tools/{id}","href":"/api-reference/tools/delete-a-tool"},{"title":"Update a tool","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/tools/{id}","href":"/api-reference/tools/update-a-tool"},{"title":"Test a webhook tool","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tools/{id}/test","href":"/api-reference/tools/test-a-webhook-tool"}]},{"group":"Voices","pages":[{"title":"List voices","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voices","href":"/api-reference/voices/list-voices"},{"title":"Clone a voice","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voices","href":"/api-reference/voices/clone-a-voice"},{"title":"Retrieve a voice","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voices/{id}","href":"/api-reference/voices/retrieve-a-voice"},{"title":"Delete a voice","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/voices/{id}","href":"/api-reference/voices/delete-a-voice"},{"title":"Update a voice","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/voices/{id}","href":"/api-reference/voices/update-a-voice"},{"title":"Preview a voice","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voices/{id}/preview","href":"/api-reference/voices/preview-a-voice"}]},{"group":"Appointments","pages":[{"title":"List appointments","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/appointments","href":"/api-reference/appointments/list-appointments"},{"title":"Create an appointment","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/appointments","href":"/api-reference/appointments/create-an-appointment"},{"title":"Retrieve an appointment","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/appointments/{id}","href":"/api-reference/appointments/retrieve-an-appointment"},{"title":"Delete an appointment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/appointments/{id}","href":"/api-reference/appointments/delete-an-appointment"},{"title":"Update an appointment","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/appointments/{id}","href":"/api-reference/appointments/update-an-appointment"}]},{"group":"Callers","pages":[{"title":"List callers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/callers","href":"/api-reference/callers/list-callers"},{"title":"Retrieve a caller","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/callers/{id}","href":"/api-reference/callers/retrieve-a-caller"},{"title":"Block or unblock a caller","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/callers/{id}","href":"/api-reference/callers/block-or-unblock-a-caller"}]},{"group":"Calls","pages":[{"title":"List calls","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/calls","href":"/api-reference/calls/list-calls"},{"title":"Place a call","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/calls","href":"/api-reference/calls/place-a-call"},{"title":"Retrieve a call","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/calls/{id}","href":"/api-reference/calls/retrieve-a-call"},{"title":"Delete a call record","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/calls/{id}","href":"/api-reference/calls/delete-a-call-record"},{"title":"Retrieve a transcript","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/calls/{id}/transcript","href":"/api-reference/calls/retrieve-a-transcript"},{"title":"End a call in progress","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/calls/{id}/hangup","href":"/api-reference/calls/end-a-call-in-progress"}]},{"group":"Usage","pages":[{"title":"List usage events","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage/events","href":"/api-reference/usage/list-usage-events"},{"title":"Summarise usage","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage/summary","href":"/api-reference/usage/summarise-usage"}]},{"group":"Billing","pages":[{"title":"Retrieve your balance","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/billing/balance","href":"/api-reference/billing/retrieve-your-balance"},{"title":"List ledger entries","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/billing/ledger","href":"/api-reference/billing/list-ledger-entries"},{"title":"Add credit","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/billing/topups","href":"/api-reference/billing/add-credit"}]},{"group":"API keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/api-keys","href":"/api-reference/api-keys/create-an-api-key"},{"title":"Rotate an API key","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/api-keys/{id}/rotate","href":"/api-reference/api-keys/rotate-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/api-keys/{id}","href":"/api-reference/api-keys/revoke-an-api-key"}]},{"group":"Engines","pages":[{"title":"List available engines and models","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/engines","href":"/api-reference/engines/list-available-engines-and-models"},{"title":"List an engine's languages","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/engines/{engine}/languages","href":"/api-reference/engines/list-an-engines-languages"},{"title":"List an engine's speaker voices","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/engines/{engine}/voices","href":"/api-reference/engines/list-an-engines-speaker-voices"}]},{"group":"Webhooks","pages":[{"title":"Retrieve the webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhook","href":"/api-reference/webhooks/retrieve-the-webhook-endpoint"},{"title":"Update the webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/webhook","href":"/api-reference/webhooks/update-the-webhook-endpoint"},{"title":"Rotate the signing secret","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhook/rotate-secret","href":"/api-reference/webhooks/rotate-the-signing-secret"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhook/test","href":"/api-reference/webhooks/send-a-test-event"},{"title":"List delivery attempts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhook/deliveries","href":"/api-reference/webhooks/list-delivery-attempts"}]},{"group":"WhatsApp","pages":[{"title":"List WhatsApp numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/accounts","href":"/api-reference/whatsapp/list-whatsapp-numbers"},{"title":"Connect a WhatsApp number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/accounts","href":"/api-reference/whatsapp/connect-a-whatsapp-number"},{"title":"Retrieve a WhatsApp number","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/accounts/{id}","href":"/api-reference/whatsapp/retrieve-a-whatsapp-number"},{"title":"Disconnect a WhatsApp number","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/whatsapp/accounts/{id}","href":"/api-reference/whatsapp/disconnect-a-whatsapp-number"},{"title":"Update a WhatsApp number","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/whatsapp/accounts/{id}","href":"/api-reference/whatsapp/update-a-whatsapp-number"},{"title":"Refresh a WhatsApp number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/accounts/{id}/refresh","href":"/api-reference/whatsapp/refresh-a-whatsapp-number"},{"title":"List message templates","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/templates","href":"/api-reference/whatsapp/list-message-templates"},{"title":"Create a message template","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/templates","href":"/api-reference/whatsapp/create-a-message-template"},{"title":"Sync message templates","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/templates/sync","href":"/api-reference/whatsapp/sync-message-templates"},{"title":"Delete a message template","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/whatsapp/templates/{id}","href":"/api-reference/whatsapp/delete-a-message-template"},{"title":"Send a WhatsApp message","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/whatsapp/messages","href":"/api-reference/whatsapp/send-a-whatsapp-message"},{"title":"List WhatsApp conversations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/conversations","href":"/api-reference/whatsapp/list-whatsapp-conversations"},{"title":"Retrieve a WhatsApp conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/conversations/{id}","href":"/api-reference/whatsapp/retrieve-a-whatsapp-conversation"},{"title":"List scheduled WhatsApp messages","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/whatsapp/scheduled-messages","href":"/api-reference/whatsapp/list-scheduled-whatsapp-messages"},{"title":"Cancel a scheduled WhatsApp message","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/whatsapp/scheduled-messages/{id}","href":"/api-reference/whatsapp/cancel-a-scheduled-whatsapp-message"}]},{"group":"Meetings","pages":[{"title":"Retrieve the meeting integration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/meetings/integration","href":"/api-reference/meetings/retrieve-the-meeting-integration"},{"title":"Connect Attendee","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/meetings/integration","href":"/api-reference/meetings/connect-attendee"},{"title":"Disconnect Attendee","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/meetings/integration","href":"/api-reference/meetings/disconnect-attendee"},{"title":"List meetings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/meetings","href":"/api-reference/meetings/list-meetings"},{"title":"Send an agent to a meeting","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/meetings","href":"/api-reference/meetings/send-an-agent-to-a-meeting"},{"title":"Retrieve a meeting","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/meetings/{id}","href":"/api-reference/meetings/retrieve-a-meeting"},{"title":"Leave a meeting","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/meetings/{id}/leave","href":"/api-reference/meetings/leave-a-meeting"}]}]}]},"basePath":"","title":"Create a tool - Wixzel Voice","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-D9ithiIZ.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}