Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Personas

Get persona options (mission types and persona types)

Smart endpoint that handles multiple scenarios for getting persona options:

  • Legacy: Provide only flowId to analyze the entire flow
  • AI Agent Specific: Provide flowId + aiagentReferenceId to analyze a specific AI agent
  • Job Node Specific: Provide flowId + aiagentReferenceId + jobNodeId to analyze a specific job node
post/personas/options

Query parameters

projectIdstring required

Project identifier

Request body

flowIdstring required

Flow identifier (required for all scenarios)

aiagentReferenceIdstring

AI Agent reference ID (optional - for AI agent specific analysis)

jobNodeIdstring

Job Node ID (optional - requires aiagentReferenceId, for job node specific analysis)

Response

Persona options retrieved successfully

simulationNamestring required

Suggested name for the scenario based on the flow/agent context