A new look for the agent’s mascot from a website_url, a description, or both; send neither for a random one. The agent’s prompt never changes. Its knowledge base is rewritten from the website only with refresh_knowledge, and one is made from the website only if it has none. Answers at once with mascot.status: building; poll the agent. The share link and widget keep working meanwhile, with the old look. Same limits as generating an agent. Requires agents:write, and knowledge_bases:write when a knowledge base is made or rewritten.
POST
/
v1
/
agents
/
{id}
/
mascot
/
generate
Generate a new mascot look
curl --request POST \ --url https://api.voice.wixzel.com/v1/agents/{id}/mascot/generate \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "website_url": "https://example.com", "description": "A calm, friendly receptionist for a dental clinic in Kochi. Teal.", "refresh_knowledge": true}'
import requests
url = "https://api.voice.wixzel.com/v1/agents/{id}/mascot/generate"
payload = {
"website_url": "https://example.com",
"description": "A calm, friendly receptionist for a dental clinic in Kochi. Teal.",
"refresh_knowledge": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
With website_url: rewrite the agent’s knowledge base from the website. This also changes what it says on phone calls. Without it the website only sets the look (and gives the agent a knowledge base if it has none).
{"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/agents/generate-a-new-mascot-look","slug":"/api-reference/agents/generate-a-new-mascot-look","pageMetadata":{"title":"Generate a new mascot look","description":"A new look for the agent's mascot from a `website_url`, a `description`, or both; send neither for a random one. The agent's prompt never changes. Its knowledge base is rewritten from the website only with `refresh_knowledge`, and one is made from the website only if it has none. Answers at once with `mascot.status: building`; poll the agent. The share link and widget keep working meanwhile, with the old look. Same limits as generating an agent. Requires `agents:write`, and `knowledge_bases:write` when a knowledge base is made or rewritten.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents/{id}/mascot/generate","href":"/api-reference/agents/generate-a-new-mascot-look","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: [\"A new look for the agent’s mascot from a \", _jsx(_components.code, {\n children: \"website_url\"\n }), \", a \", _jsx(_components.code, {\n children: \"description\"\n }), \", or both; send neither for a random one. The agent’s prompt never changes. Its knowledge base is rewritten from the website only with \", _jsx(_components.code, {\n children: \"refresh_knowledge\"\n }), \", and one is made from the website only if it has none. Answers at once with \", _jsx(_components.code, {\n children: \"mascot.status: building\"\n }), \"; poll the agent. The share link and widget keep working meanwhile, with the old look. Same limits as generating an agent. Requires \", _jsx(_components.code, {\n children: \"agents:write\"\n }), \", and \", _jsx(_components.code, {\n children: \"knowledge_bases:write\"\n }), \" when a knowledge base is made or rewritten.\"]\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":"Generate a new mascot look","description":"A new look for the agent's mascot from a `website_url`, a `description`, or both; send neither for a random one. The agent's prompt never changes. Its knowledge base is rewritten from the website only with `refresh_knowledge`, and one is made from the website only if it has none. Answers at once with `mascot.status: building`; poll the agent. The share link and widget keep working meanwhile, with the old look. Same limits as generating an agent. Requires `agents:write`, and `knowledge_bases:write` when a knowledge base is made or rewritten.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents/{id}/mascot/generate","href":"/api-reference/agents/generate-a-new-mascot-look","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Agents"],"security":["82bfcb19-1433-4d26-ad90-9b953e6cdb8b"],"summary":"Generate a new mascot look","description":"A new look for the agent's mascot from a `website_url`, a `description`, or both; send neither for a random one. The agent's prompt never changes. Its knowledge base is rewritten from the website only with `refresh_knowledge`, and one is made from the website only if it has none. Answers at once with `mascot.status: building`; poll the agent. The share link and widget keep working meanwhile, with the old look. Same limits as generating an agent. Requires `agents:write`, and `knowledge_bases:write` when a knowledge base is made or rewritten.","parameters":["fb7a0f90-5c95-42ad-a9ac-37e98f94cab6"],"requestBody":"d11f927e-0b0d-4c11-9552-ec7f4c72c1e7","responses":{"202":"a59dfe12-db09-42f1-8ecd-6de60d333889","400":"a6ddc22e-ca86-4775-a1a8-6f377227d6cd","401":"192ffd76-bbb3-4cde-a581-0111dc707612","403":"6a04e9a8-6199-4e1d-b7a7-d0f846cc255a","404":"2a160a36-4449-457b-8744-c0b74fd57fc9","409":"8fecb56f-9fd2-4ca7-92d6-356abb4e6aae","429":"0adeb01b-92ca-4f7e-8c42-fc3e97994c77","503":"cf206572-094d-4183-b513-9f253894d878"},"method":"post","type":"path","servers":["50caa847-efef-4272-9503-c28e7b472acd"],"path":"/v1/agents/{id}/mascot/generate","baseUrlOptions":["https://api.voice.wixzel.com"],"title":"Generate a new mascot look","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fb7a0f90-5c95-42ad-a9ac-37e98f94cab6":{"schema":{"type":"string","pattern":"^[0-9a-f]{24}$","example":"6a96a3ead6e886d42462dd3e","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"name":"id","in":"path"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"website_url":{"type":"string","maxLength":2048,"format":"uri","description":"A website to take the business’s name, colour, tone and facts from. Read once, not stored.","example":"https://example.com","uniqueKey":"website_url","typeLabel":"string\u003curi>"},"description":{"type":"string","minLength":1,"maxLength":1000,"description":"The business and how it should come across: the brand, its tone, a colour.","example":"A calm, friendly receptionist for a dental clinic in Kochi. Teal.","uniqueKey":"description","typeLabel":"string"},"refresh_knowledge":{"type":"boolean","description":"With `website_url`: rewrite the agent’s knowledge base from the website. This also changes what it says on phone calls. Without it the website only sets the look (and gives the agent a knowledge base if it has none).","uniqueKey":"refresh_knowledge","typeLabel":"boolean"}},"description":"A new look for the agent’s mascot from a website, a description, or both; send neither for a random one. The agent’s prompt is never changed.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"website_url":"https://example.com","description":"A calm, friendly receptionist for a dental clinic in Kochi. Teal.","refresh_knowledge":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a59dfe12-db09-42f1-8ecd-6de60d333889":{"description":"The agent, its mascot building","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":["agent"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"system_prompt":{"type":"string","isRequired":true,"uniqueKey":"system_prompt","typeLabel":"string"},"opening_message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"opening_message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"opening_message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"opening_message","typeLabel":"string | null"},"voice":{"oneOf":[{"type":"object","properties":{"stt":{"type":"object","properties":{"model":{"type":"string","pattern":"^[a-z0-9_-]+\\/[a-zA-Z0-9._-]+(?:\\/[a-zA-Z0-9._-]+)*$","example":"deepgram/nova-3","isRequired":true,"uniqueKey":"voice.oneOf.0.stt.model","typeLabel":"string"},"language":{"type":"string","default":"en-US","description":"BCP-47 tag, or \"multi\" for automatic detection.","uniqueKey":"voice.oneOf.0.stt.language","typeLabel":"string"},"endpointing_ms":{"type":"integer","minimum":100,"maximum":2000,"description":"Silence before a turn is considered finished, in milliseconds. Lower is snappier and more prone to cutting people off. Default 300.","uniqueKey":"voice.oneOf.0.stt.endpointing_ms","typeLabel":"integer"}},"required":["model"],"uniqueKey":"voice.oneOf.0.stt","typeLabel":"object"},"llm":{"type":"object","properties":{"model":{"type":"string","pattern":"^[a-z0-9_-]+\\/[a-zA-Z0-9._-]+(?:\\/[a-zA-Z0-9._-]+)*$","example":"openrouter/openai/gpt-6-luna","isRequired":true,"uniqueKey":"voice.oneOf.0.llm.model","typeLabel":"string"},"temperature":{"type":"number","minimum":0,"maximum":2,"uniqueKey":"voice.oneOf.0.llm.temperature","typeLabel":"number"},"max_tokens":{"type":"integer","minimum":1,"maximum":4096,"description":"Caps reply length. Long replies cost the caller waiting time as well as money.","uniqueKey":"voice.oneOf.0.llm.max_tokens","typeLabel":"integer"}},"required":["model"],"uniqueKey":"voice.oneOf.0.llm","typeLabel":"object"},"tts":{"type":"object","properties":{"model":{"type":"string","pattern":"^[a-z0-9_-]+\\/[a-zA-Z0-9._-]+(?:\\/[a-zA-Z0-9._-]+)*$","example":"elevenlabs/eleven_flash_v2_5","isRequired":true,"uniqueKey":"voice.oneOf.0.tts.model","typeLabel":"string"},"voice":{"type":"string","example":"21m00Tcm4TlvDq8ikWAM","uniqueKey":"voice.oneOf.0.tts.voice","typeLabel":"string"},"stability":{"type":"number","minimum":0,"maximum":1,"description":"Higher is more consistent and flatter; lower is more expressive and more variable. ElevenLabs only.","uniqueKey":"voice.oneOf.0.tts.stability","typeLabel":"number"},"similarity_boost":{"type":"number","minimum":0,"maximum":1,"description":"How closely the output tracks the original voice recording. ElevenLabs only.","uniqueKey":"voice.oneOf.0.tts.similarity_boost","typeLabel":"number"},"speed":{"type":"number","minimum":0.7,"maximum":1.2,"description":"Speaking rate, 1 being the voice's natural pace. ElevenLabs only.","uniqueKey":"voice.oneOf.0.tts.speed","typeLabel":"number"}},"required":["model"],"uniqueKey":"voice.oneOf.0.tts","typeLabel":"object"},"realtime":{"type":"object","properties":{"model":{"type":"string","pattern":"^[a-z0-9_-]+\\/[a-zA-Z0-9._-]+(?:\\/[a-zA-Z0-9._-]+)*$","example":"google/gemini-live","isRequired":true,"uniqueKey":"voice.oneOf.0.realtime.model","typeLabel":"string"},"voice":{"type":"string","example":"Charon","uniqueKey":"voice.oneOf.0.realtime.voice","typeLabel":"string"},"language":{"type":"string","default":"auto","uniqueKey":"voice.oneOf.0.realtime.language","typeLabel":"string"}},"required":["model"],"uniqueKey":"voice.oneOf.0.realtime","typeLabel":"object"},"turn_taking":{"type":"object","properties":{"interrupt_sensitivity":{"type":"string","enum":["low","normal","high"],"default":"normal","description":"How readily the agent stops talking when the caller speaks.","uniqueKey":"voice.oneOf.0.turn_taking.interrupt_sensitivity","typeLabel":"enum\u003cstring>"},"silence_wait_ms":{"type":"integer","minimum":200,"maximum":3000,"description":"Extra silence tolerated after an utterance that sounded unfinished, in milliseconds. Default 500.","uniqueKey":"voice.oneOf.0.turn_taking.silence_wait_ms","typeLabel":"integer"}},"uniqueKey":"voice.oneOf.0.turn_taking","typeLabel":"object"}},"description":"Either a composed pipeline (stt + llm + tts) or a single realtime model. Not both.","isRequired":true,"uniqueKey":"voice.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"stt":{"type":"object","properties":{"model":{"type":"string","pattern":"^[a-z0-9_-]+\\/[a-zA-Z0-9._-]+(?:\\/[a-zA-Z0-9._-]+)*$","example":"deepgram/nova-3"},"language":{"type":"string","default":"en-US","description":"BCP-47 tag, or \"multi\" for automatic detection."},"endpointing_ms":{"type":"integer","minimum":100,"maximum":2000,"description":"Silence before a turn is considered finished, in milliseconds. Lower is snappier and more prone to cutting people off. Default 300."}},"required":["model"]},"llm":{"type":"object","properties":{"model":{"type":"string","pattern":"^[a-z0-9_-]+\\/[a-zA-Z0-9._-]+(?:\\/[a-zA-Z0-9._-]+)*$","example":"openrouter/openai/gpt-6-luna"},"temperature":{"type":"number","minimum":0,"maximum":2},"max_tokens":{"type":"integer","minimum":1,"maximum":4096,"description":"Caps reply length. Long replies cost the caller waiting time as well as money."}},"required":["model"]},"tts":{"type":"object","properties":{"model":{"type":"string","pattern":"^[a-z0-9_-]+\\/[a-zA-Z0-9._-]+(?:\\/[a-zA-Z0-9._-]+)*$","example":"elevenlabs/eleven_flash_v2_5"},"voice":{"type":"string","example":"21m00Tcm4TlvDq8ikWAM"},"stability":{"type":"number","minimum":0,"maximum":1,"description":"Higher is more consistent and flatter; lower is more expressive and more variable. ElevenLabs only."},"similarity_boost":{"type":"number","minimum":0,"maximum":1,"description":"How closely the output tracks the original voice recording. ElevenLabs only."},"speed":{"type":"number","minimum":0.7,"maximum":1.2,"description":"Speaking rate, 1 being the voice's natural pace. ElevenLabs only."}},"required":["model"]},"realtime":{"type":"object","properties":{"model":{"type":"string","pattern":"^[a-z0-9_-]+\\/[a-zA-Z0-9._-]+(?:\\/[a-zA-Z0-9._-]+)*$","example":"google/gemini-live"},"voice":{"type":"string","example":"Charon"},"language":{"type":"string","default":"auto"}},"required":["model"]},"turn_taking":{"type":"object","properties":{"interrupt_sensitivity":{"type":"string","enum":["low","normal","high"],"default":"normal","description":"How readily the agent stops talking when the caller speaks."},"silence_wait_ms":{"type":"integer","minimum":200,"maximum":3000,"description":"Extra silence tolerated after an utterance that sounded unfinished, in milliseconds. Default 500."}}}},"description":"Either a composed pipeline (stt + llm + tts) or a single realtime model. Not both.","isRequired":true,"uniqueKey":"voice.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"voice","typeLabel":"object | null"},"language":{"type":"string","isRequired":true,"uniqueKey":"language","typeLabel":"string"},"knowledge_base_id":{"oneOf":[{"type":"string","pattern":"^[0-9a-f]{24}$","example":"6a96a3ead6e886d42462dd3e","isRequired":true,"uniqueKey":"knowledge_base_id.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^[0-9a-f]{24}$","example":"6a96a3ead6e886d42462dd3e","isRequired":true,"uniqueKey":"knowledge_base_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"knowledge_base_id","typeLabel":"string | null"},"outbound_phone_number_id":{"oneOf":[{"type":"string","pattern":"^[0-9a-f]{24}$","example":"6a96a3ead6e886d42462dd3e","isRequired":true,"uniqueKey":"outbound_phone_number_id.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^[0-9a-f]{24}$","example":"6a96a3ead6e886d42462dd3e","isRequired":true,"uniqueKey":"outbound_phone_number_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"outbound_phone_number_id","typeLabel":"string | null"},"appointment_booking_enabled":{"type":"boolean","isRequired":true,"uniqueKey":"appointment_booking_enabled","typeLabel":"boolean"},"human_transfer":{"type":"object","properties":{"destinations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,63}$","description":"Your own id for this destination. This, and `name`, are all the model is ever told.","example":"billing","isRequired":true,"uniqueKey":"human_transfer.destinations.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":100,"description":"What the agent calls this destination when it offers or announces a transfer.","example":"Billing team","isRequired":true,"uniqueKey":"human_transfer.destinations.items.[INDEX].name","typeLabel":"string"},"phone_number":{"type":"string","pattern":"^\\+[1-9]\\d{6,14}$","description":"Dialled server-side. Never sent to the model.","example":"+14155550100","isRequired":true,"uniqueKey":"human_transfer.destinations.items.[INDEX].phone_number","typeLabel":"string"},"type":{"type":"string","enum":["phone"],"default":"phone","description":"Only `phone` today. Warm transfer to another agent is not built.","uniqueKey":"human_transfer.destinations.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","default":true,"uniqueKey":"human_transfer.destinations.items.[INDEX].enabled","typeLabel":"boolean"},"ring_timeout_seconds":{"oneOf":[{"type":"integer","minimum":5,"maximum":60,"description":"Overrides the transfer-wide timeout for this destination. Null inherits it.","uniqueKey":"human_transfer.destinations.items.[INDEX].ring_timeout_seconds.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":5,"maximum":60,"description":"Overrides the transfer-wide timeout for this destination. Null inherits it.","uniqueKey":"human_transfer.destinations.items.[INDEX].ring_timeout_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"human_transfer.destinations.items.[INDEX].ring_timeout_seconds","typeLabel":"integer | null"}},"required":["id","name","phone_number"],"uniqueKey":"human_transfer.destinations.items.[INDEX]","typeLabel":"object"},"maxItems":50,"description":"Replaced as a whole on update, so send the complete list every time.","isRequired":true,"uniqueKey":"human_transfer.destinations","typeLabel":"object[]"},"enabled":{"type":"boolean","default":false,"uniqueKey":"human_transfer.enabled","typeLabel":"boolean"},"mode":{"type":"string","enum":["blind"],"default":"blind","description":"The caller is handed straight over. Attended transfer, where the agent speaks to the human first, is not built yet.","uniqueKey":"human_transfer.mode","typeLabel":"enum\u003cstring>"},"default_destination_id":{"oneOf":[{"type":"string","description":"Used when the caller asks for \"a person\" without naming one. Must be an enabled destination.","uniqueKey":"human_transfer.default_destination_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Used when the caller asks for \"a person\" without naming one. Must be an enabled destination.","uniqueKey":"human_transfer.default_destination_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"human_transfer.default_destination_id","typeLabel":"string | null"},"ring_timeout_seconds":{"type":"integer","minimum":5,"maximum":60,"default":20,"description":"How long a destination may ring before the caller is handed back to the agent.","uniqueKey":"human_transfer.ring_timeout_seconds","typeLabel":"integer"},"max_transfers_per_call":{"type":"integer","minimum":1,"maximum":10,"default":3,"description":"Stops a loop where the agent keeps re-dialling an unreachable human.","uniqueKey":"human_transfer.max_transfers_per_call","typeLabel":"integer"},"return_to_agent_on_failure":{"type":"boolean","default":true,"uniqueKey":"human_transfer.return_to_agent_on_failure","typeLabel":"boolean"}},"required":["destinations"],"description":"Hand a live caller to a person. Replaced as a whole on update, never merged.","isRequired":true,"uniqueKey":"human_transfer","typeLabel":"object"},"mcp_server_ids":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{24}$","example":"6a96a3ead6e886d42462dd3e","uniqueKey":"mcp_server_ids.items.[INDEX]","typeLabel":"string"},"description":"MCP servers whose enabled tools this agent can use during a call.","isRequired":true,"uniqueKey":"mcp_server_ids","typeLabel":"string[]"},"tool_ids":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{24}$","example":"6a96a3ead6e886d42462dd3e","uniqueKey":"tool_ids.items.[INDEX]","typeLabel":"string"},"description":"Your own tools (webhook and client) this agent can use during a call.","isRequired":true,"uniqueKey":"tool_ids","typeLabel":"string[]"},"mascot":{"type":"object","properties":{"spec":{"type":"object","properties":{"format":{"type":"string","enum":["wixzel.mascot"],"isRequired":true,"uniqueKey":"mascot.spec.format","typeLabel":"enum\u003cstring>"},"version":{"type":"number","enum":[1],"isRequired":true,"uniqueKey":"mascot.spec.version","typeLabel":"enum\u003cnumber>"},"name":{"type":"string","isRequired":true,"uniqueKey":"mascot.spec.name","typeLabel":"string"},"color":{"type":"string","example":"#1388ff","isRequired":true,"uniqueKey":"mascot.spec.color","typeLabel":"string"},"shape":{"type":"object","properties":{"kind":{"type":"string","enum":["circle","drop","triangle","cloud","pill","flower","squircle","blob","heart","custom"],"description":"The body. `blob` is a random soft blob picked by `seed`; `custom` is your own outline in `points`.","example":"drop","isRequired":true,"uniqueKey":"mascot.spec.shape.kind","typeLabel":"enum\u003cstring>"},"rotation":{"type":"number","description":"Degrees, + clockwise. Clamped to −45…45. A few degrees of tilt makes it feel alive.","example":-8,"uniqueKey":"mascot.spec.shape.rotation","typeLabel":"number"},"aspect":{"type":"number","description":"Width relative to height. Clamped to 0.6…1.6.","example":1,"uniqueKey":"mascot.spec.shape.aspect","typeLabel":"number"},"seed":{"type":"number","description":"`blob` only: which blob.","example":7,"uniqueKey":"mascot.spec.shape.seed","typeLabel":"number"},"points":{"type":"array","items":{"type":"number","uniqueKey":"mascot.spec.shape.points.items.[INDEX]","typeLabel":"number"},"maxItems":2000,"description":"`custom` only: a closed outline as x,y pairs in −1…1 (at least three points).","uniqueKey":"mascot.spec.shape.points","typeLabel":"number[]"}},"required":["kind"],"isRequired":true,"uniqueKey":"mascot.spec.shape","typeLabel":"object"},"eyes":{"type":"object","properties":{"style":{"type":"string","enum":["pill","round","block","line"],"description":"`pill` tall capsules, `round` dots, `block` big rounded rectangles, `line` sleepy dashes.","example":"pill","isRequired":true,"uniqueKey":"mascot.spec.eyes.style","typeLabel":"enum\u003cstring>"},"color":{"type":"string","example":"#ffffff","isRequired":true,"uniqueKey":"mascot.spec.eyes.color","typeLabel":"string"},"width":{"type":"number","description":"One eye, in body units (the body is 2 units tall). 0.05…0.6.","example":0.2,"isRequired":true,"uniqueKey":"mascot.spec.eyes.width","typeLabel":"number"},"height":{"type":"number","description":"0.05…0.8.","example":0.42,"isRequired":true,"uniqueKey":"mascot.spec.eyes.height","typeLabel":"number"},"gap":{"type":"number","description":"Centre to centre. 0.1…1.2.","example":0.42,"isRequired":true,"uniqueKey":"mascot.spec.eyes.gap","typeLabel":"number"},"x":{"type":"number","description":"Where the pair sits, from the body’s centre. −0.6…0.6.","example":0,"isRequired":true,"uniqueKey":"mascot.spec.eyes.x","typeLabel":"number"},"y":{"type":"number","description":"Negative is up. −0.7…0.6.","example":-0.12,"isRequired":true,"uniqueKey":"mascot.spec.eyes.y","typeLabel":"number"},"tilt":{"type":"number","description":"Degrees both eyes lean. −60…60.","example":0,"isRequired":true,"uniqueKey":"mascot.spec.eyes.tilt","typeLabel":"number"},"turn":{"type":"number","description":"Shrinks one eye so the face looks turned (+ shrinks the right). −0.6…0.6.","example":0,"uniqueKey":"mascot.spec.eyes.turn","typeLabel":"number"}},"required":["style","color","width","height","gap","x","y","tilt"],"isRequired":true,"uniqueKey":"mascot.spec.eyes","typeLabel":"object"},"mouth":{"type":"object","properties":{"style":{"type":"string","enum":["smile"],"isRequired":true,"uniqueKey":"mascot.spec.mouth.style","typeLabel":"enum\u003cstring>"},"width":{"type":"number","description":"Worked out from the eye width.","isRequired":true,"uniqueKey":"mascot.spec.mouth.width","typeLabel":"number"},"y":{"type":"number","description":"Below the body’s centre, worked out from the eyes.","isRequired":true,"uniqueKey":"mascot.spec.mouth.y","typeLabel":"number"}},"required":["style","width","y"],"description":"Always a smile under the eyes, set by the server. It opens and closes with the voice.","isRequired":true,"uniqueKey":"mascot.spec.mouth","typeLabel":"object"},"personality":{"type":"object","properties":{"bounce":{"type":"number","isRequired":true,"uniqueKey":"mascot.spec.personality.bounce","typeLabel":"number"},"energy":{"type":"number","isRequired":true,"uniqueKey":"mascot.spec.personality.energy","typeLabel":"number"}},"required":["bounce","energy"],"isRequired":true,"uniqueKey":"mascot.spec.personality","typeLabel":"object"}},"required":["format","version","name","color","shape","eyes","mouth","personality"],"description":"The whole mascot. Draw it with the mascot runtime, or port the renderer: it is one shape and two eyes.","isRequired":true,"uniqueKey":"mascot.spec","typeLabel":"object"},"welcome_message":{"oneOf":[{"type":"string","description":"Shown in its speech bubble on the share page and the website widget before a call. Null uses the agent’s opening line.","example":"Hi! I’m Molly from Smile Dental. Tap Call to talk to me.","isRequired":true,"uniqueKey":"mascot.welcome_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Shown in its speech bubble on the share page and the website widget before a call. Null uses the agent’s opening line.","example":"Hi! I’m Molly from Smile Dental. Tap Call to talk to me.","isRequired":true,"uniqueKey":"mascot.welcome_message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"mascot.welcome_message","typeLabel":"string | null"},"status":{"type":"string","enum":["ready","building","failed"],"description":"`building` while a generation runs; poll the agent until it is `ready` or `failed`. A failed build leaves the agent working, with the look it had.","isRequired":true,"uniqueKey":"mascot.status","typeLabel":"enum\u003cstring>"},"status_detail":{"oneOf":[{"type":"string","enum":["reading_website","designing","writing_knowledge","saving"],"description":"While building: the step it is on.","isRequired":true,"uniqueKey":"mascot.status_detail.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["reading_website","designing","writing_knowledge","saving"],"description":"While building: the step it is on.","isRequired":true,"uniqueKey":"mascot.status_detail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"mascot.status_detail","typeLabel":"enum\u003cstring> | null"},"error":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"mascot.error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"mascot.error.oneOf.0.message","typeLabel":"string"}},"required":["code","message"],"description":"Why the last build failed.","isRequired":true,"uniqueKey":"mascot.error.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"description":"Why the last build failed.","isRequired":true,"uniqueKey":"mascot.error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"mascot.error","typeLabel":"object | null"},"source":{"type":"object","properties":{"type":{"type":"string","enum":["manual","description","website","surprise"],"description":"How the mascot was first made. Editing it later does not change this.","isRequired":true,"uniqueKey":"mascot.source.type","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"mascot.source.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"mascot.source.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"mascot.source.description","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"mascot.source.url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"mascot.source.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"mascot.source.url","typeLabel":"string | null"}},"required":["type","description","url"],"isRequired":true,"uniqueKey":"mascot.source","typeLabel":"object"},"brand":{"type":"object","properties":{"primary_color":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"mascot.brand.primary_color.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"mascot.brand.primary_color.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"mascot.brand.primary_color","typeLabel":"string | null"},"site_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"mascot.brand.site_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"mascot.brand.site_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"mascot.brand.site_name","typeLabel":"string | null"}},"required":["primary_color","site_name"],"description":"What was read off the website, when it was made from one.","isRequired":true,"uniqueKey":"mascot.brand","typeLabel":"object"},"public_id":{"oneOf":[{"type":"string","description":"The id in its share link and embed code. Null until sharing is first turned on.","example":"m_4fT9qLx2Bv8K","isRequired":true,"uniqueKey":"mascot.public_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The id in its share link and embed code. Null until sharing is first turned on.","example":"m_4fT9qLx2Bv8K","isRequired":true,"uniqueKey":"mascot.public_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"mascot.public_id","typeLabel":"string | null"},"sharing":{"type":"object","properties":{"link":{"type":"boolean","description":"Anyone with the share link can see the mascot and call it. Calls are billed to you.","isRequired":true,"uniqueKey":"mascot.sharing.link","typeLabel":"boolean"},"embed":{"type":"boolean","description":"The website widget works, on the domains in `embed_origins` only. Calls are billed to you.","isRequired":true,"uniqueKey":"mascot.sharing.embed","typeLabel":"boolean"},"embed_origins":{"type":"array","items":{"type":"string","uniqueKey":"mascot.sharing.embed_origins.items.[INDEX]","typeLabel":"string"},"description":"Sites allowed to embed the mascot, as origins.","example":["https://example.com","https://www.example.com"],"isRequired":true,"uniqueKey":"mascot.sharing.embed_origins","typeLabel":"string[]"},"max_call_seconds":{"type":"integer","description":"Longest public call.","example":300,"isRequired":true,"uniqueKey":"mascot.sharing.max_call_seconds","typeLabel":"integer"},"daily_minutes":{"type":"integer","description":"Public call minutes per day across everyone, after which calls are refused until midnight UTC.","example":60,"isRequired":true,"uniqueKey":"mascot.sharing.daily_minutes","typeLabel":"integer"},"calls_per_visitor_daily":{"type":"integer","description":"Public calls one visitor (by IP address) may make per day.","example":3,"isRequired":true,"uniqueKey":"mascot.sharing.calls_per_visitor_daily","typeLabel":"integer"},"max_concurrent_calls":{"type":"integer","description":"Public calls at once, so a busy page cannot take every call slot your account has.","example":2,"isRequired":true,"uniqueKey":"mascot.sharing.max_concurrent_calls","typeLabel":"integer"},"caller_info":{"type":"string","enum":["none","contact","google"],"description":"What a caller must give before a call through the share link or website widget: `none`, `contact` (a name and a phone number or email), or `google` (a Google sign-in, which identifies them to you and never creates a Wixzel account). Callers from the app are already signed in.","isRequired":true,"uniqueKey":"mascot.sharing.caller_info","typeLabel":"enum\u003cstring>"}},"required":["link","embed","embed_origins","max_call_seconds","daily_minutes","calls_per_visitor_daily","max_concurrent_calls","caller_info"],"isRequired":true,"uniqueKey":"mascot.sharing","typeLabel":"object"},"updated_at":{"type":"string","format":"date-time","description":"ISO 8601, always UTC.","example":"2026-09-01T12:00:00.000Z","isRequired":true,"uniqueKey":"mascot.updated_at","typeLabel":"string\u003cdate-time>"}},"required":["spec","welcome_message","status","status_detail","error","source","brand","public_id","sharing","updated_at"],"description":"The agent’s animated face, for the share link, the website widget and your own apps. Every agent has one.","isRequired":true,"uniqueKey":"mascot","typeLabel":"object"},"whatsapp":{"type":"object","properties":{"account_id":{"oneOf":[{"type":"string","pattern":"^[0-9a-f]{24}$","description":"The WhatsApp number this agent sends from during phone calls. In a WhatsApp chat it always replies from the number the chat is on.","example":"6a96a3ead6e886d42462dd3e","isRequired":true,"uniqueKey":"whatsapp.account_id.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^[0-9a-f]{24}$","description":"The WhatsApp number this agent sends from during phone calls. In a WhatsApp chat it always replies from the number the chat is on.","example":"6a96a3ead6e886d42462dd3e","isRequired":true,"uniqueKey":"whatsapp.account_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"whatsapp.account_id","typeLabel":"string | null"},"tools":{"type":"object","properties":{"messages":{"type":"boolean","description":"Send the caller free text on WhatsApp, inside their 24-hour window.","isRequired":true,"uniqueKey":"whatsapp.tools.messages","typeLabel":"boolean"},"templates":{"type":"boolean","description":"Send approved templates from `allowed_templates` and the purpose templates.","isRequired":true,"uniqueKey":"whatsapp.tools.templates","typeLabel":"boolean"},"media":{"type":"boolean","description":"Send knowledge-base files whose original was kept: brochures, photos, videos.","isRequired":true,"uniqueKey":"whatsapp.tools.media","typeLabel":"boolean"},"schedule":{"type":"boolean","description":"Schedule a reminder or follow-up template for later.","isRequired":true,"uniqueKey":"whatsapp.tools.schedule","typeLabel":"boolean"},"interactive":{"type":"boolean","description":"Offer reply buttons and lists, in a WhatsApp chat.","isRequired":true,"uniqueKey":"whatsapp.tools.interactive","typeLabel":"boolean"}},"required":["messages","templates","media","schedule","interactive"],"isRequired":true,"uniqueKey":"whatsapp.tools","typeLabel":"object"},"templates":{"type":"object","properties":{"follow_up":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"whatsapp.templates.follow_up.oneOf.0.name","typeLabel":"string"},"language":{"oneOf":[{"type":"string","maxLength":20,"uniqueKey":"whatsapp.templates.follow_up.oneOf.0.language.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":20,"uniqueKey":"whatsapp.templates.follow_up.oneOf.0.language.oneOf.1","typeLabel":"null"}],"uniqueKey":"whatsapp.templates.follow_up.oneOf.0.language","typeLabel":"string | null"}},"required":["name"],"isRequired":true,"uniqueKey":"whatsapp.templates.follow_up.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string","minLength":1,"maxLength":512},"language":{"oneOf":[{"type":"string","maxLength":20},{"type":"null","maxLength":20}]}},"required":["name"],"isRequired":true,"uniqueKey":"whatsapp.templates.follow_up.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"whatsapp.templates.follow_up","typeLabel":"object | null"},"reminder":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"whatsapp.templates.reminder.oneOf.0.name","typeLabel":"string"},"language":{"oneOf":[{"type":"string","maxLength":20,"uniqueKey":"whatsapp.templates.reminder.oneOf.0.language.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":20,"uniqueKey":"whatsapp.templates.reminder.oneOf.0.language.oneOf.1","typeLabel":"null"}],"uniqueKey":"whatsapp.templates.reminder.oneOf.0.language","typeLabel":"string | null"}},"required":["name"],"isRequired":true,"uniqueKey":"whatsapp.templates.reminder.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string","minLength":1,"maxLength":512},"language":{"oneOf":[{"type":"string","maxLength":20},{"type":"null","maxLength":20}]}},"required":["name"],"isRequired":true,"uniqueKey":"whatsapp.templates.reminder.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"whatsapp.templates.reminder","typeLabel":"object | null"},"booking_confirmation":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"whatsapp.templates.booking_confirmation.oneOf.0.name","typeLabel":"string"},"language":{"oneOf":[{"type":"string","maxLength":20,"uniqueKey":"whatsapp.templates.booking_confirmation.oneOf.0.language.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":20,"uniqueKey":"whatsapp.templates.booking_confirmation.oneOf.0.language.oneOf.1","typeLabel":"null"}],"uniqueKey":"whatsapp.templates.booking_confirmation.oneOf.0.language","typeLabel":"string | null"}},"required":["name"],"isRequired":true,"uniqueKey":"whatsapp.templates.booking_confirmation.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string","minLength":1,"maxLength":512},"language":{"oneOf":[{"type":"string","maxLength":20},{"type":"null","maxLength":20}]}},"required":["name"],"isRequired":true,"uniqueKey":"whatsapp.templates.booking_confirmation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"whatsapp.templates.booking_confirmation","typeLabel":"object | null"}},"required":["follow_up","reminder","booking_confirmation"],"description":"The template used for each purpose.","isRequired":true,"uniqueKey":"whatsapp.templates","typeLabel":"object"},"allowed_templates":{"type":"array","items":{"type":"string","maxLength":512,"uniqueKey":"whatsapp.allowed_templates.items.[INDEX]","typeLabel":"string"},"maxItems":20,"description":"Template names the agent may send by its own choice, besides the purpose templates.","isRequired":true,"uniqueKey":"whatsapp.allowed_templates","typeLabel":"string[]"},"auto_booking_confirmation":{"type":"boolean","description":"Send `booking_confirmation` as soon as the agent books an appointment.","isRequired":true,"uniqueKey":"whatsapp.auto_booking_confirmation","typeLabel":"boolean"},"auto_reminder_minutes":{"type":"integer","minimum":0,"maximum":10080,"description":"Send `reminder` this many minutes before each appointment the agent books. 0 is off.","isRequired":true,"uniqueKey":"whatsapp.auto_reminder_minutes","typeLabel":"integer"},"chat_model":{"oneOf":[{"type":"string","maxLength":200,"description":"The text model for WhatsApp chats. Null uses the agent’s own model on the classic engine, or the default.","example":"openrouter/openai/gpt-6-luna","isRequired":true,"uniqueKey":"whatsapp.chat_model.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":200,"description":"The text model for WhatsApp chats. Null uses the agent’s own model on the classic engine, or the default.","example":"openrouter/openai/gpt-6-luna","isRequired":true,"uniqueKey":"whatsapp.chat_model.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"whatsapp.chat_model","typeLabel":"string | null"},"max_sends_per_call":{"type":"integer","minimum":1,"maximum":10,"description":"The most WhatsApp messages one call or chat turn may send through tools.","isRequired":true,"uniqueKey":"whatsapp.max_sends_per_call","typeLabel":"integer"},"allow_marketing":{"type":"boolean","description":"Whether the agent may send marketing-category templates.","isRequired":true,"uniqueKey":"whatsapp.allow_marketing","typeLabel":"boolean"}},"required":["account_id","tools","templates","allowed_templates","auto_booking_confirmation","auto_reminder_minutes","chat_model","max_sends_per_call","allow_marketing"],"description":"WhatsApp: the number it sends from on calls, and its WhatsApp tools.","isRequired":true,"uniqueKey":"whatsapp","typeLabel":"object"},"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>"}},"required":["id","object","name","system_prompt","opening_message","voice","language","knowledge_base_id","outbound_phone_number_id","appointment_booking_enabled","human_transfer","mcp_server_ids","tool_ids","mascot","whatsapp","created_at"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"6a96a3ead6e886d42462dd3e","object":"agent","name":"\u003cstring>","system_prompt":"\u003cstring>","opening_message":"\u003cstring>","voice":{"stt":{"model":"deepgram/nova-3","language":"en-US","endpointing_ms":1050},"llm":{"model":"openrouter/openai/gpt-6-luna","temperature":1,"max_tokens":2048},"tts":{"model":"elevenlabs/eleven_flash_v2_5","voice":"21m00Tcm4TlvDq8ikWAM","stability":0.5,"similarity_boost":0.5,"speed":0.95},"realtime":{"model":"google/gemini-live","voice":"Charon","language":"auto"},"turn_taking":{"interrupt_sensitivity":"normal","silence_wait_ms":1600}},"language":"\u003cstring>","knowledge_base_id":"6a96a3ead6e886d42462dd3e","outbound_phone_number_id":"6a96a3ead6e886d42462dd3e","appointment_booking_enabled":true,"human_transfer":{"destinations":[{"id":"billing","name":"Billing team","phone_number":"+14155550100","type":"phone","enabled":true,"ring_timeout_seconds":32}],"enabled":false,"mode":"blind","default_destination_id":"\u003cstring>","ring_timeout_seconds":20,"max_transfers_per_call":3,"return_to_agent_on_failure":true},"mcp_server_ids":["6a96a3ead6e886d42462dd3e"],"tool_ids":["6a96a3ead6e886d42462dd3e"],"mascot":{"spec":{"format":"wixzel.mascot","version":1,"name":"\u003cstring>","color":"#1388ff","shape":{"kind":"drop","rotation":-8,"aspect":1,"seed":7,"points":[123]},"eyes":{"style":"pill","color":"#ffffff","width":0.2,"height":0.42,"gap":0.42,"x":0,"y":-0.12,"tilt":0,"turn":0},"mouth":{"style":"smile","width":123,"y":123},"personality":{"bounce":123,"energy":123}},"welcome_message":"Hi! I’m Molly from Smile Dental. Tap Call to talk to me.","status":"ready","status_detail":"reading_website","error":{"code":"\u003cstring>","message":"\u003cstring>"},"source":{"type":"manual","description":"\u003cstring>","url":"\u003cstring>"},"brand":{"primary_color":"\u003cstring>","site_name":"\u003cstring>"},"public_id":"m_4fT9qLx2Bv8K","sharing":{"link":true,"embed":true,"embed_origins":["https://example.com","https://www.example.com"],"max_call_seconds":300,"daily_minutes":60,"calls_per_visitor_daily":3,"max_concurrent_calls":2,"caller_info":"none"},"updated_at":"2026-09-01T12:00:00.000Z"},"whatsapp":{"account_id":"6a96a3ead6e886d42462dd3e","tools":{"messages":true,"templates":true,"media":true,"schedule":true,"interactive":true},"templates":{"follow_up":{"name":"\u003cstring>","language":"\u003cstring>"},"reminder":{"name":"\u003cstring>","language":"\u003cstring>"},"booking_confirmation":{"name":"\u003cstring>","language":"\u003cstring>"}},"allowed_templates":["\u003cstring>"],"auto_booking_confirmation":true,"auto_reminder_minutes":5040,"chat_model":"openrouter/openai/gpt-6-luna","max_sends_per_call":5,"allow_marketing":true},"created_at":"2026-09-01T12:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"a6ddc22e-ca86-4775-a1a8-6f377227d6cd":{"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"},"192ffd76-bbb3-4cde-a581-0111dc707612":{"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"},"6a04e9a8-6199-4e1d-b7a7-d0f846cc255a":{"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"},"2a160a36-4449-457b-8744-c0b74fd57fc9":{"description":"No such record","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"},"8fecb56f-9fd2-4ca7-92d6-356abb4e6aae":{"description":"A build is already running","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"},"0adeb01b-92ca-4f7e-8c42-fc3e97994c77":{"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"},"cf206572-094d-4183-b513-9f253894d878":{"description":"Generation is not configured on this server","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":{"82bfcb19-1433-4d26-ad90-9b953e6cdb8b":{"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":"Generate a new mascot look - Wixzel Voice","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T02:55:10.589Z","originalFileLocation":"api-reference/agents/generate-a-new-mascot-look.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=\"A new look for the agent\u0026#x27;s mascot from a website_url, a description, or both; send neither for a random one. The agent\u0026#x27;s prompt never changes. Its knowledge base is rewritten from the website only with refresh_knowledge, and one is made from the website only if it has none. Answers at once with mascot.status: building; poll the agent. The share link and widget keep working meanwhile, with the old look. Same limits as generating an agent. Requires agents:write, and knowledge_bases:write when a knowledge base is made or rewritten.\">\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=\"Generate a new mascot look - Wixzel Voice\">\u003cmeta data-mint-head property=\"og:description\" content=\"A new look for the agent\u0026#x27;s mascot from a website_url, a description, or both; send neither for a random one. The agent\u0026#x27;s prompt never changes. Its knowledge base is rewritten from the website only with refresh_knowledge, and one is made from the website only if it has none. Answers at once with mascot.status: building; poll the agent. The share link and widget keep working meanwhile, with the old look. Same limits as generating an agent. Requires agents:write, and knowledge_bases:write when a knowledge base is made or rewritten.\">\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/agents/generate-a-new-mascot-look\">\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=\"Generate a new mascot look - Wixzel Voice\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"A new look for the agent\u0026#x27;s mascot from a website_url, a description, or both; send neither for a random one. The agent\u0026#x27;s prompt never changes. Its knowledge base is rewritten from the website only with refresh_knowledge, and one is made from the website only if it has none. Answers at once with mascot.status: building; poll the agent. The share link and widget keep working meanwhile, with the old look. Same limits as generating an agent. Requires agents:write, and knowledge_bases:write when a knowledge base is made or rewritten.\">\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/agents/generate-a-new-mascot-look\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/agents/generate-a-new-mascot-look.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/agents/generate-a-new-mascot-look#webpage\",\"url\":\"https://docs.voice.wixzel.com/api-reference/agents/generate-a-new-mascot-look\",\"name\":\"Generate a new mascot look\",\"description\":\"A new look for the agent's mascot from a website_url, a description, or both; send neither for a random one. The agent's prompt never changes. Its knowledge base is rewritten from the website only with refresh_knowledge, and one is made from the website only if it has none. Answers at once with mascot.status: building; poll the agent. The share link and widget keep working meanwhile, with the old look. Same limits as generating an agent. Requires agents:write, and knowledge_bases:write when a knowledge base is made or rewritten.\",\"dateModified\":\"2026-10-28T02:55:10.589Z\",\"isPartOf\":{\"@id\":\"https://docs.voice.wixzel.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.voice.wixzel.com/api-reference/agents/generate-a-new-mascot-look#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.voice.wixzel.com/api-reference/agents/generate-a-new-mascot-look#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\":\"Agents\",\"item\":\"https://docs.voice.wixzel.com/api-reference/agents/list-agents\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Generate a new mascot look\",\"item\":\"https://docs.voice.wixzel.com/api-reference/agents/generate-a-new-mascot-look\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.voice.wixzel.com/api-reference/agents/generate-a-new-mascot-look#apireference\",\"headline\":\"Generate a new mascot look\",\"name\":\"Generate a new mascot look\",\"description\":\"A new look for the agent's mascot from a website_url, a description, or both; send neither for a random one. The agent's prompt never changes. Its knowledge base is rewritten from the website only with refresh_knowledge, and one is made from the website only if it has none. Answers at once with mascot.status: building; poll the agent. The share link and widget keep working meanwhile, with the old look. Same limits as generating an agent. Requires agents:write, and knowledge_bases:write when a knowledge base is made or rewritten.\",\"url\":\"https://docs.voice.wixzel.com/api-reference/agents/generate-a-new-mascot-look\",\"mainEntityOfPage\":{\"@id\":\"https://docs.voice.wixzel.com/api-reference/agents/generate-a-new-mascot-look#webpage\"},\"image\":\"https://voice.wixzel.com/opengraph-image\",\"dateModified\":\"2026-10-28T02:55:10.589Z\",\"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","description":"Replace its look with an edited spec (normalised like a new one), change its speech bubble, or change `sharing`. Turning on the share link or the website widget lets anyone talk to the agent on your credit, within the caps in `sharing`, so `sharing` also needs `calls:write`. Requires `agents:write`.","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","description":"Gives the agent's mascot a new `public_id`. Its old share link and embed code stop working at once. Requires `agents:write` and `calls:write`.","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","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","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":"Generate a new mascot look - 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"]}