Skip to main content
Agent templates are an optional reseller capability for deploying a consistent starting configuration across downstream organizations. Ordinary organization accounts can configure their own Agents directly and do not need a reseller template.

​
Build a template

  1. Create a disabled draft with POST /api/v2/templates/createTemplate.
  2. Read the returned template and save its ID.
  3. Update the draft with POST /api/v2/templates/{templateId}.
  4. Review the Agent configuration, onboarding fields, integrations, and defaults as one complete customer setup.
  5. Test the template on a disposable or designated Agent before enabling it for customer use.
The website-prefill endpoint can suggest template values from a public site. Treat suggestions as untrusted draft content: review them before saving or applying the template.

​
Create an Agent from a template

Use POST /api/v2/createAgentFromTemplate with the selected Agent account and the template’s declared field values. The operation creates staging and live Agent configurations and publishes the result. Afterward:
  1. Read staging and live configuration from the Agent account.
  2. Confirm the expected template ID and authored values.
  3. Verify dynamic selections such as voice, model, functions, apps, and integrations against that account’s current catalogs.
  4. Run a representative test before handing the Agent to a customer.
Detaching with POST /api/v2/detachAgentFromTemplate preserves the current authored configuration but removes template ownership and edit restrictions. Detach only when the customer should manage the Agent independently.

​
Migrate an existing fleet

Template revisions can affect many Agents. Always start with a dry run:
  1. POST /api/v2/templates/{templateId}/migrate with dryRun:true.
  2. Inspect the returned result, or poll the provided migration status URL when the operation is queued.
  3. Limit sectionsToMigrate to the intended configuration areas.
  4. Do not overwrite customer overrides unless that replacement is explicitly approved.
  5. Run the real migration with dryRun:false only after reviewing the affected Agents.
  6. Re-read representative Agents and test the changed capability.
Disable a template before deleting it. Deletion is appropriate only after confirming it is no longer needed for onboarding or future migrations.