Regenerate a specific field of a persona package - Cognigy Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

Regenerate a Specific Field of a Persona Package

POST /personas/regenerate-field

Try it

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
}'

Example Payload in Python

import requests

url = "https://api-trial.cognigy.ai/testing/personas/regenerate-field"

payload = {
    "simulationName": "<string>",
    "personaName": "<string>",
    "personaDescription": "<string>",
    "mission": "<string>",
    "successCriteria": [
        {
            "type": "<string>",
            "params": {}
        }
    ],
    "projectReference": "<string>",
    "successCriteriaIndex": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Example Payload in JavaScript

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    simulationName: '<string>',
    personaName: '<string>',
    personaDescription: '<string>',
    mission: '<string>',
    successCriteria: [{type: '<string>', params: {}}],
    projectReference: '<string>',
    successCriteriaIndex: 123
  })
};

fetch('https://api-trial.cognigy.ai/testing/personas/regenerate-field', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HTTP Response

Successful Response:

{
  "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
  }
}

Error Response:

{
  "error": "<string>",
  "code": "<string>",
  "traceId": "<string>"
}

Authorizations

• Authorization: JWT Bearer Token for authentication

Query Parameters

• projectId: (string, required) Project identifier.

Body

The body must be in application/json format:

• fieldToRegenerate (enum, required): Field name to regenerate (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.
• successCriteriaIndex (integer): Optional index of specific success criterion to regenerate.