idrequired
| string(uuid) | The unique identifier for the agent. |
namerequired
| string | The name of the agent. |
icon
| string | The icon of the agent. |
typesrequired
| string[] | The types of the agent. |
directionsrequired
| string[] | The directions of the agent. |
summaryrequired
| string | The summary of the agent. |
| object | The instructions of the agent. |
examplePrompts
| string[] | Example prompts to help users start conversations (max 5, each max 100 chars). |
organizationIdrequired
| string(uuid) | The organization identifier of the agent. |
authPublicClientIdrequired
| string(uuid) | The public client identifier of the agent. |
authPublicClientSecretrequired
| string | The public client secret of the agent. |
authPublicClientAllowedOriginsrequired
| string[] | The allowed origins of the agent. |
| object | Configuration for the chat widget appearance and behavior.(default: {"iconType":"smooai","iconUrl":"https://smoo.ai","requireName":true,"requireEmail":true,"requirePhone":false,"allowAnonymous":false,"colors":{"text":"#f8fafc","background":"#1D3249","primary":"#06CED5","primaryText":"#3A6592","secondary":"#FE0FDA","chatBubbleInbound":"#3A6592","chatBubbleInboundText":"#f8fafc","chatBubbleOutbound":"#97bbec","chatBubbleOutboundText":"#020015","border":"#f8fafc"}}) |
| object | Configuration for the agent's personality and behavior traits.(default: {"preset":"bright","creativity":0.7}) |
template
| stringenum: [customer_support, developer_assistant, knowledge_expert, sales_outreach, internal_helpdesk, custom] | Template used to create this agent. |
visibility
| stringenum: [public, internal] | Where this agent is accessible (public widget or internal dashboard).(default: "public") |
| object | Configuration for agent tools and integrations.(default: {"enabledTools":[]}) |
createdByrequired
| string(uuid) | The user identifier of the agent. |
createdAtrequired
| string(date) | The date and time the agent was created. |
updatedAtrequired
| string(date) | The date and time the agent was last updated. |
