Skip to main content
POST
/
personas
/
generate
Generate persona packages
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>"
}
'
{
  "success": true,
  "personaPackages": [
    {
      "simulationName": "<string>",
      "personaName": "<string>",
      "personaDescription": "<string>",
      "mission": "<string>",
      "successCriteria": [
        {
          "type": "<string>",
          "params": {}
        }
      ]
    }
  ],
  "metadata": {
    "requestId": "<string>",
    "processedAt": "<string>",
    "model": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT Bearer Token for authentication

Query Parameters

projectId
string

Project identifier (alternative to projectReference in body)

Body

application/json
flowReferenceId
string
required

Flow reference ID for AI agent and tool discovery

selectedMissionType
object
required

Selected mission type with success criteria

selectedPersonaType
object
required

Selected persona type with characteristics

numberOfSuccessCriteria
integer
required

Number of success criteria to generate per persona package

Required range: x >= 1
requestedPackages
integer
required

Number of persona packages to generate

Required range: x >= 1
projectReference
string

Project reference for context identification (alternative to projectId query parameter)

jobNodeId
string

Optional: Target specific job node for precise tool discovery

Response

Persona packages generated successfully

success
boolean
required

Whether the generation was successful

personaPackages
object[]
required

Array of generated persona packages

metadata
object

Optional metadata about the generation

Last modified on July 2, 2026