curl --request POST \
--url https://app.egma.ai/v1/personas \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Caller in a hurry",
"identityName": "Morgan Chen",
"personality": "Answers briefly, asks for the earliest appointment, and stays polite when asking the agent to get to the point.",
"language": "en-US"
}
'{
"id": "<string>",
"projectId": "<string>",
"name": "<string>",
"description": "<string>",
"version": 2,
"versionId": "<string>",
"identityName": "<string>",
"personality": "<string>",
"language": "<string>",
"parameterContract": [
{
"key": "<string>",
"label": "<string>",
"valueType": "integer",
"defaultValue": 123,
"unit": "<string>",
"minimum": 123,
"maximum": 123
}
],
"settings": {
"id": "<string>",
"models": {
"llm": {
"provider": "<string>",
"model": "<string>"
},
"stt": {
"provider": "<string>",
"model": "<string>"
},
"tts": {
"provider": "<string>",
"model": "<string>",
"voiceId": "<string>",
"speed": 123
}
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"owner": "egma",
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}Create a persona
Create a project-owned persona with its first behavior version and complete model settings. Omit models to use the declared defaults. Add its ID or unambiguous name to a test to use it.
curl --request POST \
--url https://app.egma.ai/v1/personas \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Caller in a hurry",
"identityName": "Morgan Chen",
"personality": "Answers briefly, asks for the earliest appointment, and stays polite when asking the agent to get to the point.",
"language": "en-US"
}
'{
"id": "<string>",
"projectId": "<string>",
"name": "<string>",
"description": "<string>",
"version": 2,
"versionId": "<string>",
"identityName": "<string>",
"personality": "<string>",
"language": "<string>",
"parameterContract": [
{
"key": "<string>",
"label": "<string>",
"valueType": "integer",
"defaultValue": 123,
"unit": "<string>",
"minimum": 123,
"maximum": 123
}
],
"settings": {
"id": "<string>",
"models": {
"llm": {
"provider": "<string>",
"model": "<string>"
},
"stt": {
"provider": "<string>",
"model": "<string>"
},
"tts": {
"provider": "<string>",
"model": "<string>",
"voiceId": "<string>",
"speed": 123
}
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"owner": "egma",
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}Authorizations
An Egma API key.
Body
Your team's label in the persona library. The caller does not speak this label.
The human name the caller gives the agent, separate from the library name.
How the caller behaves and speaks. Put the situation and goal in the test scenario.
The caller's language, such as en-US.
1The complete language, speech recognition, and speech synthesis selections. Read /v1/persona-form for available choices and recommendations.
Show child attributes
Show child attributes
Response
The new persona.
11x >= 11The human name the caller gives the agent, separate from the library name.
How the caller behaves and speaks. Put the situation and goal in the test scenario.
The caller's language, such as en-US.
Show child attributes
Show child attributes
This project's saved model and voice settings. Null before first use. Settings changes do not create a behavior version.
Show child attributes
Show child attributes
egma, organization