Chatbots

Functions for creating, reading, and updating chatbots.

Chatbots are agents of type Chatbot. The chatbotId is the same value as the agentId (agt_…). You can pass either chatbotId or agentId to the read/update functions. Agent linking and scheduling functions also work against a chatbot's id.

---

chatbot-create

Create a chatbot with explicit fields. Placement uses the scoped folder when set, otherwise org root.

Input

Field	Type	Required	Description
name	string	Yes	Short snake_case identifier (letters, digits, underscores).
shortDescription	string	Yes	Brief summary for listings.
systemPrompt	string	Yes	Full system / task instructions.
agentGuidelines	string	No	Optional extra guidelines.
conversationStarters	array	No	Up to 2 starters, each \{ name, prompt \}.

Output

Field	Type	Description
chatbotId	string	Id of the new chatbot (= agentId, agt_…).
agentId	string	Same value as chatbotId.
versionId	string	Id of the created version.

---

chatbot-read

Read one chatbot: metadata, current version, system prompt, guidelines, conversation starters, linked tools / integrations / tables / workflows / knowledge bases, and schedules.

Input

Field	Type	Required	Description
chatbotId	string	One of	Chatbot id (= agentId, agt_…).
agentId	string	One of	Alias for chatbotId.

Output

Field	Type	Description
chatbotId	string	The chatbot id.
chatbot	object	Full payload (same shape as agent-read's agent).

---

chatbot-update

Update an existing chatbot (same fields as chatbot-create). Only include fields that should change. Commits a new draft version that the user must deploy.

Input

Field	Type	Required	Description
chatbotId / agentId	string	Yes	Chatbot id (= agentId).
name	string	No	New snake_case name.
shortDescription	string	No	New summary.
systemPrompt	string	No	New system prompt.
agentGuidelines	string	No	New guidelines.
conversationStarters	array	No	When set, replaces all starters (max 2).

Output

Field	Type	Description
chatbotId	string	The chatbot id.
agentId	string	Same value.
versionId	string	The committed draft version id.