Skip to main content
POST
/
test_framework
/
v1
/
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 '{
  "agent_id": 123,
  "assistant_id": "<string>",
  "personalities": [
    123
  ],
  "num_scenarios": 50,
  "test_profile": 123,
  "scenario_type": "happy",
  "extra_instructions": "<string>",
  "inbound_phone_number": 123,
  "first_message": "Hello",
  "generate_expected_outcomes": false,
  "tags": [
    "<string>"
  ],
  "tool_ids": [
    "<string>"
  ]
}'
{
  "progress_id": "<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> | null

Type of scenarios to generate: happy path, sad path, toxicity, bias, jailbreak, or hallucination

  • happy - happy
  • sad - sad
  • toxicity - toxicity
  • bias - bias
  • jailbreak - jailbreak
  • hallucination - hallucination
Available options:
happy,
sad,
toxicity,
bias,
jailbreak,
hallucination
​
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 length: 1000
​
generate_expected_outcomes
boolean
default:false

If true, expected outcomes will be generated for each evaluator

​
tags
string[]

List of tags to apply to all generated scenarios

​
tool_ids
string[]

List of tool IDs to use for generated evaluators

Response

​
progress_id
string
⌘I