> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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




## OpenAPI

````yaml https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json post /personas/options
openapi: 3.0.0
info:
  title: SIMULATOR OPENAPI REST-ful-API Reference
  version: 2025.20.0
  description: >

    ### Introduction

    This is the [OpenAPI 3.0](https://swagger.io/specification/) documentation

    of the
    [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)-ful
    SIMULATOR OPENAPI API.


    ### Cross-Origin Resource Sharing

    This API features Cross-Origin Resource Sharing (CORS) implemented in

    compliance with [W3C spec](https://www.w3.org/TR/cors/), which allows

    cross-domain communication from the browser. All responses have a wildcard

    same-origin header which makes the API completely accessible.


    ### Authentication

    SIMULATOR OPENAPI offers following forms of authentication:

    - Bearer Token (JWT)

    - API Key


    ### Error Handling

    This API uses HTTP status codes equal or above 400 to indicate errors. Error

    details are generated in compliance with [RFC 7807 - "Problem Details for
    HTTP APIs"](https://tools.ietf.org/html/rfc7807).


    Every error response contains a traceId, which should be provided to the
    SIMULATOR OPENAPI Technical Support when reporting an error.
  contact:
    name: Cognigy Technical Support
    url: https://www.cognigy.com
    email: support@cognigy.com
  license:
    name: Cognigy Proprietary License
servers:
  - url: https://api-trial.cognigy.ai/testing
    description: Cognigy Service Testing API
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Simulations
    description: >-
      Simulation management operations - Create, read, update, and delete
      simulations
externalDocs:
  description: SIMULATOR OPENAPI Documentation
  url: https://docs.cognigy.com/docs/service-testing/
paths:
  /personas/options:
    post:
      tags:
        - Personas
      summary: Get persona options (mission types and persona types)
      description: >
        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
      operationId: getPersonaOptions
      parameters:
        - name: projectId
          in: query
          required: true
          schema:
            type: string
          description: Project identifier
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                flowId:
                  type: string
                  description: Flow identifier (required for all scenarios)
                aiagentReferenceId:
                  type: string
                  description: >-
                    AI Agent reference ID (optional - for AI agent specific
                    analysis)
                jobNodeId:
                  type: string
                  description: >-
                    Job Node ID (optional - requires aiagentReferenceId, for job
                    node specific analysis)
              required:
                - flowId
      responses:
        '200':
          description: Persona options retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  simulationName:
                    type: string
                    description: >-
                      Suggested name for the scenario based on the flow/agent
                      context
                  missionTypes:
                    type: array
                    description: Available mission types with success criteria
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          description: Name of the mission type
                        description:
                          type: string
                          description: Description of the mission
                        successCriteria:
                          type: array
                          description: Success criteria for this mission
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                description: Name of the success criterion
                              description:
                                type: string
                                description: Description of the success criterion
                            required:
                              - name
                              - description
                      required:
                        - name
                        - description
                        - successCriteria
                  personaTypes:
                    type: array
                    description: Available persona types with behavioral characteristics
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          description: Name of the persona type
                        description:
                          type: string
                          description: >-
                            Description and behavioral characteristics of the
                            persona
                      required:
                        - name
                        - description
                required:
                  - simulationName
                  - missionTypes
                  - personaTypes
        '400':
          description: Bad Request - Invalid input parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Validation error message
                  field:
                    type: string
                    description: Field that failed validation
                  code:
                    type: string
                    description: Validation error code
                  traceId:
                    type: string
                    description: Trace ID for debugging
                required:
                  - error
                  - field
        '401':
          description: Unauthorized - Invalid or missing authentication
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Unauthorized error message
                  code:
                    type: string
                    description: Unauthorized error code
                  traceId:
                    type: string
                    description: Trace ID for debugging
                required:
                  - error
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Forbidden error message
                  code:
                    type: string
                    description: Forbidden error code
                  traceId:
                    type: string
                    description: Trace ID for debugging
                required:
                  - error
        '500':
          description: Internal Server Error - Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message
                  code:
                    type: string
                    description: Error code
                  traceId:
                    type: string
                    description: Trace ID for debugging
                required:
                  - error
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT Bearer Token for authentication
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key for authentication

````