Skip to main content
POST
/
personas
/
regenerate-field
Regenerate a specific field of a persona package
curl --request POST \
  --url https://api-trial.cognigy.ai/testing/personas/regenerate-field \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "simulationName": "<string>",
  "personaName": "<string>",
  "personaDescription": "<string>",
  "mission": "<string>",
  "successCriteria": [
    {
      "type": "<string>",
      "params": {}
    }
  ],
  "projectReference": "<string>",
  "successCriteriaIndex": 123
}
'
{
  "success": true,
  "personaPackage": {
    "simulationName": "<string>",
    "personaName": "<string>",
    "personaDescription": "<string>",
    "mission": "<string>",
    "successCriteria": [
      {
        "type": "<string>",
        "params": {}
      }
    ]
  },
  "metadata": {
    "requestId": "<string>",
    "processedAt": "<string>",
    "model": "<string>",
    "regeneratedField": "<string>",
    "regeneratedIndex": 123
  }
}

Authorizations

Authorization
string
header
required

JWT Bearer Token for authentication

Query Parameters

projectId
string
required

Project identifier

Body

application/json
fieldToRegenerate
enum<string>
required

Field name to regenerate

Available options:
simulationName,
personaName,
personaDescription,
mission,
successCriteria
simulationName
string
required

Current scenario name

personaName
string
required

Current persona name

personaDescription
string
required

Current persona description

mission
string
required

Current mission

successCriteria
object[]
required

Current success criteria array

projectReference
string

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

successCriteriaIndex
integer

Optional: Index of specific success criterion to regenerate (only when fieldToRegenerate is 'successCriteria')

Response

Persona field regenerated successfully

success
boolean
required

Whether the regeneration was successful

personaPackage
object
required

Complete persona package with the regenerated field

metadata
object

Optional metadata about the regeneration

Last modified on July 2, 2026