Skip to main content
POST
Create a new Agent from a template
Create a new agent from a saved template. The template supplies the shared configuration (prompt, knowledge, guardrails, LLM, TTS); you pass in the per-agent overrides (avatar, email, per-user context).

Why templates

Templates keep configuration consistent across many agents. If you run 50 agents that share the same behavior but differ in avatar and per-user context, define the behavior once as a template and spawn agents from it. The new agent inherits everything attached to the template, including its knowledge bases, tools, MCPs, and guardrails. You don’t need to pass any of that again in this request.

Required fields

  • template_id: the template to instantiate from
  • avatar_key_id: the visual identity for this specific agent

Optional fields

  • email: used for external meetings as the meeting invite identity
  • context_override: inject per-agent context that will be appended to the shared system prompt

Example

Response:

Common patterns

Per-customer rollout

Loop over your customer list; for each customer, spin up a template-derived agent with per-customer context:

Next steps

Authorizations

x-api-key
string
header
required

Body

application/json
avatar_ids
string[]
required

List of avatar IDs to associate with the new agent

template_id
string<uuid>
required

ID of the template to use for creating the agent

Response

Agent created successfully

id
string<uuid>

ID of the newly created agent

message
string

Confirmation message