Skip to content

Clone an agent, or instantiate one from a template

POST
/voice/agents/clone

Copy an agent’s whole configuration under a new name.

Persona, identity and knowledge attachments come across. This is one call where POST /voice/agents plus a dozen field copies would be several, and it is how a template becomes a working agent.

NOT a link: the copy is independent, so later edits to the source do not reach it.

source_agent_id is resolved WITHIN the caller’s org, so a template id from another tenant simply is not found.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
entity_type
Any of:
string
new_agent_id
Any of:
string
new_agent_name
required

Name for the copy.

string
overrides
Any of:
object
key
additional properties
any
role
Any of:
string
source_agent_id
required

Agent or template to copy.

string

Responses

201

Successful Response

object
data
required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string