curl --request PATCH \
--url https://app.egma.ai/v1/personas/{personaId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"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": {}
}Update a persona
Change project model settings or the current custom behavior. Behavior edits require expectedVersionId and create a version when changed. Model settings and display labels create no version. Egma-owned behavior is read-only; its project settings are editable.
curl --request PATCH \
--url https://app.egma.ai/v1/personas/{personaId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"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.
Path Parameters
1Body
1Your 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.
The complete language, speech recognition, and speech synthesis selections. Read /v1/persona-form for available choices and recommendations.
Show child attributes
Show child attributes
The current versionId from Get a persona. Required when editing identityName, personality, or language. A stale value returns 409 version_conflict.
1Response
The updated 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