Generate Evaluator

cURL

curl --request POST \
  --url https://api.cekura.ai/test_framework/v1/scenarios/generate-bg/ \
  --header 'Content-Type: application/json' \
  --header 'X-CEKURA-API-KEY: <api-key>' \
  --data '
{
  "num_scenarios": 50,
  "agent_id": 123,
  "assistant_id": "<string>",
  "personalities": [
    123
  ],
  "test_profile": 123,
  "scenario_type": "workflow",
  "expected_outcome": "<string>",
  "extra_instructions": "<string>",
  "inbound_phone_number": 123,
  "first_message": "Hello",
  "generate_expected_outcomes": false,
  "tags": [
    "<string>"
  ],
  "tool_ids": [
    "TOOL_DTMF",
    "TOOL_END_CALL",
    "TOOL_END_CALL_ONLY_ON_TRANSFER"
  ],
  "folder_path": "<string>"
}
'

import requests

url = "https://api.cekura.ai/test_framework/v1/scenarios/generate-bg/"

payload = {
    "num_scenarios": 50,
    "agent_id": 123,
    "assistant_id": "<string>",
    "personalities": [123],
    "test_profile": 123,
    "scenario_type": "workflow",
    "expected_outcome": "<string>",
    "extra_instructions": "<string>",
    "inbound_phone_number": 123,
    "first_message": "Hello",
    "generate_expected_outcomes": False,
    "tags": ["<string>"],
    "tool_ids": ["TOOL_DTMF", "TOOL_END_CALL", "TOOL_END_CALL_ONLY_ON_TRANSFER"],
    "folder_path": "<string>"
}
headers = {
    "X-CEKURA-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-CEKURA-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    num_scenarios: 50,
    agent_id: 123,
    assistant_id: '<string>',
    personalities: [123],
    test_profile: 123,
    scenario_type: 'workflow',
    expected_outcome: '<string>',
    extra_instructions: '<string>',
    inbound_phone_number: 123,
    first_message: 'Hello',
    generate_expected_outcomes: false,
    tags: ['<string>'],
    tool_ids: ['TOOL_DTMF', 'TOOL_END_CALL', 'TOOL_END_CALL_ONLY_ON_TRANSFER'],
    folder_path: '<string>'
  })
};

fetch('https://api.cekura.ai/test_framework/v1/scenarios/generate-bg/', 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.cekura.ai/test_framework/v1/scenarios/generate-bg/",
  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([
    'num_scenarios' => 50,
    'agent_id' => 123,
    'assistant_id' => '<string>',
    'personalities' => [
        123
    ],
    'test_profile' => 123,
    'scenario_type' => 'workflow',
    'expected_outcome' => '<string>',
    'extra_instructions' => '<string>',
    'inbound_phone_number' => 123,
    'first_message' => 'Hello',
    'generate_expected_outcomes' => false,
    'tags' => [
        '<string>'
    ],
    'tool_ids' => [
        'TOOL_DTMF',
        'TOOL_END_CALL',
        'TOOL_END_CALL_ONLY_ON_TRANSFER'
    ],
    'folder_path' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-CEKURA-API-KEY: <api-key>"
  ],
]);

$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.cekura.ai/test_framework/v1/scenarios/generate-bg/"

	payload := strings.NewReader("{\n  \"num_scenarios\": 50,\n  \"agent_id\": 123,\n  \"assistant_id\": \"<string>\",\n  \"personalities\": [\n    123\n  ],\n  \"test_profile\": 123,\n  \"scenario_type\": \"workflow\",\n  \"expected_outcome\": \"<string>\",\n  \"extra_instructions\": \"<string>\",\n  \"inbound_phone_number\": 123,\n  \"first_message\": \"Hello\",\n  \"generate_expected_outcomes\": false,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"tool_ids\": [\n    \"TOOL_DTMF\",\n    \"TOOL_END_CALL\",\n    \"TOOL_END_CALL_ONLY_ON_TRANSFER\"\n  ],\n  \"folder_path\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-CEKURA-API-KEY", "<api-key>")
	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.cekura.ai/test_framework/v1/scenarios/generate-bg/")
  .header("X-CEKURA-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"num_scenarios\": 50,\n  \"agent_id\": 123,\n  \"assistant_id\": \"<string>\",\n  \"personalities\": [\n    123\n  ],\n  \"test_profile\": 123,\n  \"scenario_type\": \"workflow\",\n  \"expected_outcome\": \"<string>\",\n  \"extra_instructions\": \"<string>\",\n  \"inbound_phone_number\": 123,\n  \"first_message\": \"Hello\",\n  \"generate_expected_outcomes\": false,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"tool_ids\": [\n    \"TOOL_DTMF\",\n    \"TOOL_END_CALL\",\n    \"TOOL_END_CALL_ONLY_ON_TRANSFER\"\n  ],\n  \"folder_path\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cekura.ai/test_framework/v1/scenarios/generate-bg/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-CEKURA-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"num_scenarios\": 50,\n  \"agent_id\": 123,\n  \"assistant_id\": \"<string>\",\n  \"personalities\": [\n    123\n  ],\n  \"test_profile\": 123,\n  \"scenario_type\": \"workflow\",\n  \"expected_outcome\": \"<string>\",\n  \"extra_instructions\": \"<string>\",\n  \"inbound_phone_number\": 123,\n  \"first_message\": \"Hello\",\n  \"generate_expected_outcomes\": false,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"tool_ids\": [\n    \"TOOL_DTMF\",\n    \"TOOL_END_CALL\",\n    \"TOOL_END_CALL_ONLY_ON_TRANSFER\"\n  ],\n  \"folder_path\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "progress_id": "<string>"
}

{
  "field_name": [
    "<string>"
  ]
}

POST

test_framework

scenarios

generate-bg

cURL

curl --request POST \
  --url https://api.cekura.ai/test_framework/v1/scenarios/generate-bg/ \
  --header 'Content-Type: application/json' \
  --header 'X-CEKURA-API-KEY: <api-key>' \
  --data '
{
  "num_scenarios": 50,
  "agent_id": 123,
  "assistant_id": "<string>",
  "personalities": [
    123
  ],
  "test_profile": 123,
  "scenario_type": "workflow",
  "expected_outcome": "<string>",
  "extra_instructions": "<string>",
  "inbound_phone_number": 123,
  "first_message": "Hello",
  "generate_expected_outcomes": false,
  "tags": [
    "<string>"
  ],
  "tool_ids": [
    "TOOL_DTMF",
    "TOOL_END_CALL",
    "TOOL_END_CALL_ONLY_ON_TRANSFER"
  ],
  "folder_path": "<string>"
}
'

import requests

url = "https://api.cekura.ai/test_framework/v1/scenarios/generate-bg/"

payload = {
    "num_scenarios": 50,
    "agent_id": 123,
    "assistant_id": "<string>",
    "personalities": [123],
    "test_profile": 123,
    "scenario_type": "workflow",
    "expected_outcome": "<string>",
    "extra_instructions": "<string>",
    "inbound_phone_number": 123,
    "first_message": "Hello",
    "generate_expected_outcomes": False,
    "tags": ["<string>"],
    "tool_ids": ["TOOL_DTMF", "TOOL_END_CALL", "TOOL_END_CALL_ONLY_ON_TRANSFER"],
    "folder_path": "<string>"
}
headers = {
    "X-CEKURA-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-CEKURA-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    num_scenarios: 50,
    agent_id: 123,
    assistant_id: '<string>',
    personalities: [123],
    test_profile: 123,
    scenario_type: 'workflow',
    expected_outcome: '<string>',
    extra_instructions: '<string>',
    inbound_phone_number: 123,
    first_message: 'Hello',
    generate_expected_outcomes: false,
    tags: ['<string>'],
    tool_ids: ['TOOL_DTMF', 'TOOL_END_CALL', 'TOOL_END_CALL_ONLY_ON_TRANSFER'],
    folder_path: '<string>'
  })
};

fetch('https://api.cekura.ai/test_framework/v1/scenarios/generate-bg/', 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.cekura.ai/test_framework/v1/scenarios/generate-bg/",
  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([
    'num_scenarios' => 50,
    'agent_id' => 123,
    'assistant_id' => '<string>',
    'personalities' => [
        123
    ],
    'test_profile' => 123,
    'scenario_type' => 'workflow',
    'expected_outcome' => '<string>',
    'extra_instructions' => '<string>',
    'inbound_phone_number' => 123,
    'first_message' => 'Hello',
    'generate_expected_outcomes' => false,
    'tags' => [
        '<string>'
    ],
    'tool_ids' => [
        'TOOL_DTMF',
        'TOOL_END_CALL',
        'TOOL_END_CALL_ONLY_ON_TRANSFER'
    ],
    'folder_path' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-CEKURA-API-KEY: <api-key>"
  ],
]);

$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.cekura.ai/test_framework/v1/scenarios/generate-bg/"

	payload := strings.NewReader("{\n  \"num_scenarios\": 50,\n  \"agent_id\": 123,\n  \"assistant_id\": \"<string>\",\n  \"personalities\": [\n    123\n  ],\n  \"test_profile\": 123,\n  \"scenario_type\": \"workflow\",\n  \"expected_outcome\": \"<string>\",\n  \"extra_instructions\": \"<string>\",\n  \"inbound_phone_number\": 123,\n  \"first_message\": \"Hello\",\n  \"generate_expected_outcomes\": false,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"tool_ids\": [\n    \"TOOL_DTMF\",\n    \"TOOL_END_CALL\",\n    \"TOOL_END_CALL_ONLY_ON_TRANSFER\"\n  ],\n  \"folder_path\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-CEKURA-API-KEY", "<api-key>")
	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.cekura.ai/test_framework/v1/scenarios/generate-bg/")
  .header("X-CEKURA-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"num_scenarios\": 50,\n  \"agent_id\": 123,\n  \"assistant_id\": \"<string>\",\n  \"personalities\": [\n    123\n  ],\n  \"test_profile\": 123,\n  \"scenario_type\": \"workflow\",\n  \"expected_outcome\": \"<string>\",\n  \"extra_instructions\": \"<string>\",\n  \"inbound_phone_number\": 123,\n  \"first_message\": \"Hello\",\n  \"generate_expected_outcomes\": false,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"tool_ids\": [\n    \"TOOL_DTMF\",\n    \"TOOL_END_CALL\",\n    \"TOOL_END_CALL_ONLY_ON_TRANSFER\"\n  ],\n  \"folder_path\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cekura.ai/test_framework/v1/scenarios/generate-bg/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-CEKURA-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"num_scenarios\": 50,\n  \"agent_id\": 123,\n  \"assistant_id\": \"<string>\",\n  \"personalities\": [\n    123\n  ],\n  \"test_profile\": 123,\n  \"scenario_type\": \"workflow\",\n  \"expected_outcome\": \"<string>\",\n  \"extra_instructions\": \"<string>\",\n  \"inbound_phone_number\": 123,\n  \"first_message\": \"Hello\",\n  \"generate_expected_outcomes\": false,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"tool_ids\": [\n    \"TOOL_DTMF\",\n    \"TOOL_END_CALL\",\n    \"TOOL_END_CALL_ONLY_ON_TRANSFER\"\n  ],\n  \"folder_path\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "progress_id": "<string>"
}

{
  "field_name": [
    "<string>"
  ]
}

Authorizations

X-CEKURA-API-KEY

string

header

required

API Key Authentication. It should be included in the header of each request.

Body

num_scenarios

integer

required

Number of evaluators to generate (1-100)

Required range: 1 <= x <= 100

agent_id

integer

ID of the agent to generate evaluator for

assistant_id

string

Alternative to agent_id - the assistant ID to generate evaluators for

personalities

integer[]

List of personality IDs to use for generated evaluators

test_profile

integer

ID of the test profile to assign to generated evaluators

scenario_type

enum<string>

default:workflow

Type of scenarios to generate: workflow (standard scenarios), red_teaming_voice (red teaming with voice-suitable prompts only), or red_teaming_text (red teaming with all prompts)

workflow - workflow
red_teaming_voice - red_teaming_voice
red_teaming_text - red_teaming_text

Available options:

workflow,

red_teaming_voice,

red_teaming_text

attack_type

enum<string> | null

Attack category for red teaming scenarios. Required when scenario_type is red_teaming_voice or red_teaming_text. Categories: system_prompt_leak (attempts to extract the system prompt), data_leak (attempts to extract sensitive data), harmful_content (attempts to generate harmful output), biased_output (attempts to generate biased responses), unauthorized_actions (attempts to trigger unauthorized tool calls or actions), off_task (attempts to derail the conversation away from the agent's purpose)

`` -
system_prompt_leak - system_prompt_leak
data_leak - data_leak
harmful_content - harmful_content
biased_output - biased_output
unauthorized_actions - unauthorized_actions
off_task - off_task

Available options:

system_prompt_leak,

data_leak,

harmful_content,

biased_output,

unauthorized_actions,

off_task,

null

expected_outcome

string | null

Custom expected outcome for the scenario. If not provided, a default is generated based on the attack type.

extra_instructions

string

Additional instructions to guide evaluator generation

inbound_phone_number

integer | null

Phone number ID to use for inbound evaluator

first_message

string

default:Hello

Initial message to start the conversation

Maximum string length: 1000

generate_expected_outcomes

boolean

default:false

If true, expected outcomes will be generated for each evaluator

Response

progress_id

string

Rename Folder Get Generate Evaluator Progress

⌘I