Instantiate a template as a live agent
Clone a pre-built template into the caller’s tenant as a new live agent — the template’s system prompt, model, and voice configuration rendered against the organization’s jurisdiction, including compliance preroll where applicable. Optional body { name, description } overrides the template defaults so multiple instances of the same template do not collide on name. Returns 404 when the template id is unknown. Owner, admin, or developer role required.
Authorizations
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
1 - 255Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
true, false Path Parameters
Response
The instantiated agent record (id, name, status, rendered prompt and voice configuration) in the standard { data, meta } envelope.