Use a persona
curl --request POST \
--url https://app.egma.ai/v1/personas/{personaId}/use \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"projectId": "<string>"
}
'{
"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": {
"mode": "separate",
"llm": {
"provider": "<string>",
"model": "<string>"
},
"stt": {
"provider": "<string>",
"model": "<string>"
},
"tts": {
"provider": "<string>",
"model": "<string>",
"voiceId": "<string>"
}
},
"controls": {
"language": "<string>",
"backgroundSoundId": "none",
"interruptionLevel": "none"
},
"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": {}
}Personas
Use a persona
Use the persona in this project with its declared defaults. Repeated use keeps the saved settings unchanged.
POST
/
v1
/
personas
/
{personaId}
/
use
Use a persona
curl --request POST \
--url https://app.egma.ai/v1/personas/{personaId}/use \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"projectId": "<string>"
}
'{
"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": {
"mode": "separate",
"llm": {
"provider": "<string>",
"model": "<string>"
},
"stt": {
"provider": "<string>",
"model": "<string>"
},
"tts": {
"provider": "<string>",
"model": "<string>",
"voiceId": "<string>"
}
},
"controls": {
"language": "<string>",
"backgroundSoundId": "none",
"interruptionLevel": "none"
},
"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
bearerAuthsessionCookie
An Egma API key.
Path Parameters
Minimum string length:
1Body
application/json
Minimum string length:
1Response
The persona with its saved project settings.
Minimum string length:
1Minimum string length:
1Required range:
x >= 1Minimum string length:
1The 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.
Historical core language. New persona versions use controls.language and return null here.
Show child attributes
Show child attributes
This project's saved model and voice settings. Null before first use. Clone the persona to change these settings.
Show child attributes
Show child attributes
Available options:
egma, organization