Create Persona

POSThttps://api.confident-ai.com/v2/personas

Creates a persona in your Confident AI project and returns its id. A persona is the character the simulated user plays in a multi-turn conversation, so defining one here is what lets many goldens share the same user instead of restating the same description on every row. Names are unique within a project; reusing one returns a 409.

POST/v2/personas

curl -X POST "https://api.confident-ai.com/v2/personas" \
  -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."
}'

200

{
  "success": true,
  "data": {
    "id": "<PERSONA-ID>"
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/personas",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request body

namestringRequired
The name of the persona, unique within the project. It is the label the persona is picked by wherever a golden is given one, so make it recognisable on its own — 'Frustrated support caller' rather than 'Persona 2'.
characteristicsstringRequired
How this persona behaves in a conversation: tone, temperament, patience, how much they volunteer, how they phrase things. The simulator reads it as the standing instruction for the user side of every turn, so describe a person rather than a task — what the conversation is about and when it is finished come from the golden's scenario and expected outcome, not from here.

Response

Create Persona succeeded.

successboolean
Indicates if the request was successful.
dataobject
A reference to a persona by its id.
Show 1 propertyHide 1 property
- idstring
  The id of the persona, generated by Confident AI.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI