What Can a Template Include?
A template may consist of the following configurable components:- System Prompt - Defines the agent’s role, tone, and knowledge scope. This is the core directive that shapes reasoning and personality.
- Entry Message - A greeting or onboarding message that triggers when the session begins.
- Exit Message - A closing or farewell message when the conversation ends or disconnects.
- Idle Timeout - Specifies how the agent responds when user silence or inactivity occurs.
- Knowledge Base Attachments - Bind knowledge sources such as documents, products, FAQs, or APIs.
- Behavior & Safety Settings - Control boundaries, compliance rules, escalation, and maximum session length.
- Callback Events & Webhooks - Trigger external workflows or UI updates.
Templates ensure that every agent deployed by your organization shares consistent brand voice, intelligence grounding, and conversation workflow - whether you have 1 agent or thousands.
Getting Started
Documents and web pages are indexed and made available to agents through the Knowledge Base component. Once your Knowledge Base is created, upload documents and tag them to your template so all agents derived from it automatically inherit that intelligence.Template creation and management can be performed using the API or visually through our Developer Platform.
Create & Use a Template
1
Step 1 - Create a New Template
Create a conversational template using the API. This example shows a minimal configuration.
Replace
<api-key> with your actual API key generated from our Developer Portal.2
Step 2 - Create an Agent Using This Template
Now use the created template to spin up a fully configured agent automatically.
Replace
template_id with the actual template id returned in Step 1.Why Use Templates?
- Faster Deployment - Clone-ready configurations let you launch new agents in seconds.
- Consistency & Brand Control - Centralized personality and tone definition.
- Scalable to Thousands of Agents - Ideal for enterprise teams or multi-location rollouts.
- Easy Experimentation - Modify templates without rebuilding agents from scratch.
- Best for Real-World Use Cases - Interview agents, onboarding assistants, customer support, AI sales reps, teacher/coach personas, and more.
Know More
Templates - API Reference
Explore the full API set for creating, updating, retrieving, and deleting templates.