Update Persona
PUThttps://api.confident-ai.com/v2/personas/{personaId}
Renames a persona or rewrites its characteristics, and returns it. Every golden already pointing at this persona picks the new text up on its next simulation, so an edit changes how future conversations are played rather than conversations already simulated. Names are unique within a project; taking another persona's name returns a 409.
curl -X PUT "https://api.confident-ai.com/v2/personas/{personaId}" \
-H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
-H "Content-Type: application/json" \
-d '{
"name": "Frustrated support caller",
"characteristics": "An impatient customer who has already been transferred twice. Types in lowercase, asks short direct questions, and pushes back when given a generic answer."
}'{
"success": true,
"data": {
"id": "<PERSONA-ID>",
"name": "Frustrated support caller",
"characteristics": "An impatient customer who has already been transferred twice. Types in lowercase, asks short direct questions, and pushes back when given a generic answer.",
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-16T09:12:00.000Z"
},
"link": "https://app.confident-ai.com/project/<PROJECT-ID>/personas",
"deprecated": false
}Headers
CONFIDENT_API_KEYstringRequiredThe API key of your Confident AI project.
Path parameters
personaIdstringRequiredThe id of the persona.
Request body
namestringThe name of the persona, unique within the project. Omit it to keep the current name.
characteristicsstringHow this persona behaves in a conversation, as the simulator reads it on every user turn. The text replaces the stored one outright rather than being appended to, so send the whole description. Omit it to keep the current one.
Response
Update Persona succeeded.
successbooleanIndicates if the request was successful.
dataobjectA reusable character for the simulated user in a multi-turn conversation. Confident AI simulates conversations against your LLM app from multi-turn goldens, and a golden that names a persona has its user side played in character: the persona supplies who is talking, while the golden supplies what they want and when the conversation is done. Defining the character once here is what keeps 'a frustrated customer who types in lowercase' from being retyped on every row, and lets you compare runs where only the user changed.
Show 5 propertiesHide 5 properties
idstringThe id of the persona, generated by Confident AI.
namestringThe name of the persona, unique within the project.
characteristicsstringHow this persona behaves in a conversation, as the simulator reads it on every user turn.
createdAtstringThe time the persona was created, as an ISO 8601 datetime.
updatedAtstringThe time the persona was last changed, as an ISO 8601 datetime.
linkstringThis is the URL of the resource on the Confident AI platform.
deprecatedbooleanIndicates if this endpoint is deprecated.