Skip to main content
POST
Generate a new mascot look

Authorizations

Authorization
string
header
required

Your Wixzel Voice API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.

Path Parameters

id
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

Body

application/json

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.

website_url
string<uri>

A website to take the business’s name, colour, tone and facts from. Read once, not stored.

Maximum string length: 2048
Example:

"https://example.com"

description
string

The business and how it should come across: the brand, its tone, a colour.

Required string length: 1 - 1000
Example:

"A calm, friendly receptionist for a dental clinic in Kochi. Teal."

refresh_knowledge
boolean

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).

Response

The agent, its mascot building

id
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

object
enum<string>
required
Available options:
agent
name
string
required
system_prompt
string
required
opening_message
string | null
required
voice
object | null
required

Either a composed pipeline (stt + llm + tts) or a single realtime model. Not both.

language
string
required
knowledge_base_id
string | null
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

outbound_phone_number_id
string | null
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

appointment_booking_enabled
boolean
required
human_transfer
object
required

Hand a live caller to a person. Replaced as a whole on update, never merged.

mcp_server_ids
string[]
required

MCP servers whose enabled tools this agent can use during a call.

Pattern: ^[0-9a-f]{24}$
tool_ids
string[]
required

Your own tools (webhook and client) this agent can use during a call.

Pattern: ^[0-9a-f]{24}$
mascot
object
required

The agent’s animated face, for the share link, the website widget and your own apps. Every agent has one.

whatsapp
object
required

WhatsApp: the number it sends from on calls, and its WhatsApp tools.

created_at
string<date-time>
required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"