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
Bulk generate separated personas and missions
curl --request POST \
--url https://api-trial.cognigy.ai/testing/personas/generate-bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"flowReferenceId": "<string>",
"allMissionTypes": [
{
"name": "<string>",
"description": "<string>",
"successCriteria": [
{
"name": "<string>",
"description": "<string>"
}
]
}
],
"allPersonaTypes": [
{
"name": "<string>",
"description": "<string>"
}
],
"numberOfSuccessCriteria": 2,
"requestedPackages": 2,
"projectReference": "<string>"
}
'import requests
url = "https://api-trial.cognigy.ai/testing/personas/generate-bulk"
payload = {
"flowReferenceId": "<string>",
"allMissionTypes": [
{
"name": "<string>",
"description": "<string>",
"successCriteria": [
{
"name": "<string>",
"description": "<string>"
}
]
}
],
"allPersonaTypes": [
{
"name": "<string>",
"description": "<string>"
}
],
"numberOfSuccessCriteria": 2,
"requestedPackages": 2,
"projectReference": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
flowReferenceId: '<string>',
allMissionTypes: [
{
name: '<string>',
description: '<string>',
successCriteria: [{name: '<string>', description: '<string>'}]
}
],
allPersonaTypes: [{name: '<string>', description: '<string>'}],
numberOfSuccessCriteria: 2,
requestedPackages: 2,
projectReference: '<string>'
})
};
fetch('https://api-trial.cognigy.ai/testing/personas/generate-bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-trial.cognigy.ai/testing/personas/generate-bulk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'flowReferenceId' => '<string>',
'allMissionTypes' => [
[
'name' => '<string>',
'description' => '<string>',
'successCriteria' => [
[
'name' => '<string>',
'description' => '<string>'
]
]
]
],
'allPersonaTypes' => [
[
'name' => '<string>',
'description' => '<string>'
]
],
'numberOfSuccessCriteria' => 2,
'requestedPackages' => 2,
'projectReference' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-trial.cognigy.ai/testing/personas/generate-bulk"
payload := strings.NewReader("{\n \"flowReferenceId\": \"<string>\",\n \"allMissionTypes\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"successCriteria\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n ],\n \"allPersonaTypes\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"numberOfSuccessCriteria\": 2,\n \"requestedPackages\": 2,\n \"projectReference\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-trial.cognigy.ai/testing/personas/generate-bulk")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"flowReferenceId\": \"<string>\",\n \"allMissionTypes\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"successCriteria\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n ],\n \"allPersonaTypes\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"numberOfSuccessCriteria\": 2,\n \"requestedPackages\": 2,\n \"projectReference\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/testing/personas/generate-bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"flowReferenceId\": \"<string>\",\n \"allMissionTypes\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"successCriteria\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n ],\n \"allPersonaTypes\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"numberOfSuccessCriteria\": 2,\n \"requestedPackages\": 2,\n \"projectReference\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"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"
}
}
]
}
]
},
"metadata": {
"requestId": "<string>",
"processedAt": "<string>",
"model": "<string>",
"personaTypesCount": 123,
"missionTypesCount": 123
}
}{
"error": "<string>",
"field": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}Authorizations
bearerAuthapiKeyAuth
Body
application/json
Response
Bulk personas and missions generated successfully
⌘I
Bulk generate separated personas and missions
curl --request POST \
--url https://api-trial.cognigy.ai/testing/personas/generate-bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"flowReferenceId": "<string>",
"allMissionTypes": [
{
"name": "<string>",
"description": "<string>",
"successCriteria": [
{
"name": "<string>",
"description": "<string>"
}
]
}
],
"allPersonaTypes": [
{
"name": "<string>",
"description": "<string>"
}
],
"numberOfSuccessCriteria": 2,
"requestedPackages": 2,
"projectReference": "<string>"
}
'import requests
url = "https://api-trial.cognigy.ai/testing/personas/generate-bulk"
payload = {
"flowReferenceId": "<string>",
"allMissionTypes": [
{
"name": "<string>",
"description": "<string>",
"successCriteria": [
{
"name": "<string>",
"description": "<string>"
}
]
}
],
"allPersonaTypes": [
{
"name": "<string>",
"description": "<string>"
}
],
"numberOfSuccessCriteria": 2,
"requestedPackages": 2,
"projectReference": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
flowReferenceId: '<string>',
allMissionTypes: [
{
name: '<string>',
description: '<string>',
successCriteria: [{name: '<string>', description: '<string>'}]
}
],
allPersonaTypes: [{name: '<string>', description: '<string>'}],
numberOfSuccessCriteria: 2,
requestedPackages: 2,
projectReference: '<string>'
})
};
fetch('https://api-trial.cognigy.ai/testing/personas/generate-bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-trial.cognigy.ai/testing/personas/generate-bulk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'flowReferenceId' => '<string>',
'allMissionTypes' => [
[
'name' => '<string>',
'description' => '<string>',
'successCriteria' => [
[
'name' => '<string>',
'description' => '<string>'
]
]
]
],
'allPersonaTypes' => [
[
'name' => '<string>',
'description' => '<string>'
]
],
'numberOfSuccessCriteria' => 2,
'requestedPackages' => 2,
'projectReference' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-trial.cognigy.ai/testing/personas/generate-bulk"
payload := strings.NewReader("{\n \"flowReferenceId\": \"<string>\",\n \"allMissionTypes\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"successCriteria\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n ],\n \"allPersonaTypes\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"numberOfSuccessCriteria\": 2,\n \"requestedPackages\": 2,\n \"projectReference\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-trial.cognigy.ai/testing/personas/generate-bulk")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"flowReferenceId\": \"<string>\",\n \"allMissionTypes\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"successCriteria\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n ],\n \"allPersonaTypes\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"numberOfSuccessCriteria\": 2,\n \"requestedPackages\": 2,\n \"projectReference\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/testing/personas/generate-bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"flowReferenceId\": \"<string>\",\n \"allMissionTypes\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"successCriteria\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n ],\n \"allPersonaTypes\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"numberOfSuccessCriteria\": 2,\n \"requestedPackages\": 2,\n \"projectReference\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"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"
}
}
]
}
]
},
"metadata": {
"requestId": "<string>",
"processedAt": "<string>",
"model": "<string>",
"personaTypesCount": 123,
"missionTypesCount": 123
}
}{
"error": "<string>",
"field": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}