List Personas

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

Lists the personas in your Confident AI project one page at a time, newest first. Each persona is returned with just its id and name — enough to pick one for a multi-turn golden; retrieve it by id to read the characteristics the simulator plays it with.

GET/v2/personas

curl -X GET "https://api.confident-ai.com/v2/personas" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "personas": [
      {
        "id": "<PERSONA-ID>",
        "name": "Frustrated support caller"
      }
    ],
    "totalPersonas": 4,
    "page": 1,
    "pageSize": 25
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/personas",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

pageintegerdefault: 1
The page to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of results per page, at most 100. Defaults to 25.

Response

List Personas succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of personas, with the total across all pages.
Show 4 propertiesHide 4 properties
- personaslist of objects
  The personas for the current page, newest first.
  Show 2 propertiesHide 2 properties
  - idstring
    The id of the persona, generated by Confident AI.
  - namestring
    The name of the persona.
- totalPersonasinteger
  The total number of personas in this project.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of personas per page.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI