Generate persona packages - Cognigy Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

API Reference: Generate Persona Packages

POST /personas/generate

Request Body

{
  "flowReferenceId": "<string>",
  "selectedMissionType": {
    "name": "<string>",
    "description": "<string>",
    "successCriteria": [
      {
        "name": "<string>",
        "description": "<string>"
      }
    ]
  },
  "selectedPersonaType": {
    "name": "<string>",
    "description": "<string>"
  },
  "numberOfSuccessCriteria": 2,
  "requestedPackages": 2,
  "projectReference": "<string>",
  "jobNodeId": "<string>"
}

Example cURL Request

curl --request POST \
  --url https://api-trial.cognigy.ai/testing/personas/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "flowReferenceId": "<string>",
    "selectedMissionType": {
      "name": "<string>",
      "description": "<string>",
      "successCriteria": [
        {
          "name": "<string>",
          "description": "<string>"
        }
      ]
    },
    "selectedPersonaType": {
      "name": "<string>",
      "description": "<string>"
    },
    "numberOfSuccessCriteria": 2,
    "requestedPackages": 2,
    "projectReference": "<string>",
    "jobNodeId": "<string>"
  }'

Response

200

{
  "success": true,
  "personaPackages": [
    {
      "simulationName": "<string>",
      "personaName": "<string>",
      "personaDescription": "<string>",
      "mission": "<string>",
      "successCriteria": [
        {
          "type": "<string>",
          "params": {}
        }
      ]
    }
  ],
  "metadata": {
    "requestId": "<string>",
    "processedAt": "<string>",
    "model": "<string>"
  }
}

Authorization

JWT Bearer Token for authentication