v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Personas

Bulk generate separated personas and missions

Generate separated persona and mission information for all provided persona types and mission types. Returns personas and missions in separated structures for independent management.

Key Feature: This endpoint generates ALL combinations of provided persona types and mission types, returning them in a structured format where:

  • Personas are keyed by persona type name
  • Missions are keyed by mission type name
post/personas/generate-bulk

Query parameters

projectIdstring

Project identifier (alternative to projectReference in body)

Request body

projectReferencestring

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

flowReferenceIdstring required

Flow reference ID for AI agent and tool discovery

numberOfSuccessCriteriainteger required

Number of success criteria to generate per mission

requestedPackagesinteger required

Number of packages to generate per type combination

Response

Bulk personas and missions generated successfully

successboolean required

Whether the generation was successful

personasobject required

Personas organized by persona type name as keys

missionsobject required

Missions organized by mission type name as keys

Example response

{
  "personas": {
    "Customer Support Agent": [
      {
        "simulationName": "Customer Issue Resolution",
        "personaName": "Sarah",
        "personaDescription": "Experienced support agent..."
      }
    ]
  },
  "missions": {
    "Technical Support": [
      {
        "mission": "Resolve customer technical issue",
        "successCriteria": [
          {
            "type": "goal",
            "params": {
              "description": "Issue resolved"
            }
          }
        ]
      }
    ]
  }
}