Skip to main content
POST
Create a new Template
Create a reusable template: the shared configuration that many agents can derive from. Use templates to enforce consistent behavior across a fleet of agents.

What belongs in a template

  • The shared system prompt
  • Attached knowledge bases
  • Attached guardrails
  • LLM, STT, TTS configuration
  • Default avatar (individual agents can override)
  • Callback configuration

What doesn’t

  • Per-user or per-agent identifiers (avatar assignments, meeting emails, agent names)
  • Runtime session data

Example

Response:

Using the template

Once created, spin up agents from it with Create Agent by Template.

Next steps

Authorizations

x-api-key
string
header
required

Body

application/json
template_name
string

Name of the template

Example:

"HR Assistant"

template_system_prompt
string

System prompt text used by the template

Example:

"You are a helpful HR AI Assistant."

config
object

Settings and configuration for the template

knowledge_base
object[] | null

List of knowledge bases attached to this agent.

guardrail
object[] | null

List of guardrails attached to this template.

record
boolean

Whether the call should be recorded

Example:

true

Response

Template created successfully

id
string<uuid>

Unique ID of the newly created template.

Example:

"d65a4f92-44b1-4fe6-b2ac-a1cb66366ddc"

message
string
Example:

"Template created successfully"