Skip to main content
POST
Clone a persona

Authorizations

Authorization
string
header
required

An Egma API key.

Path Parameters

personaId
string
required
Minimum string length: 1

Body

application/json

Optional complete overrides for the new clone. Omitted values are copied from the source. Models and controls must be sent together.

projectId
string
Minimum string length: 1
name
string

Your team's label in the persona library. The caller does not speak this label.

description
string
identityName
string

The human name the caller gives the agent, separate from the library name.

personality
string

How the caller behaves and speaks. Put the situation and goal in the test scenario.

models
object

The complete language, speech recognition, and speech synthesis selections. Read /v1/persona-form for available choices and recommendations.

controls
object

Response

The new custom persona.

id
string
required
Minimum string length: 1
projectId
string | null
required
Minimum string length: 1
name
string
required
description
string | null
required
version
integer
required
Required range: x >= 1
versionId
string
required
Minimum string length: 1
identityName
string
required

The human name the caller gives the agent, separate from the library name.

personality
string
required

How the caller behaves and speaks. Put the situation and goal in the test scenario.

language
string | null
required

Historical core language. New persona versions use controls.language and return null here.

parameterContract
object[]
required
settings
object | null
required

This project's saved model and voice settings. Null before first use. Clone the persona to change these settings.

owner
enum<string>
required
Available options:
egma,
organization
archivedAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required