Get Evaluator

GET /test_framework/v1/scenarios/{id}

cURL

cURL

curl --request GET \
  --url https://api.cekura.ai/test_framework/v1/scenarios/{id}/ \
  --header 'X-CEKURA-API-KEY: <api-key>'

200

{
  "id": 123,
  "name": "<string>",
  "agent": 123,
  "project": 123,
  "personality": 123,
  "personality_name": "<string>",
  "tags": [
    "<string>"
  ],
  "tool_ids": "<unknown>",
  "runs": [
    123
  ],
  "metrics": [
    123
  ],
  "metric_names": [
    "<string>"
  ],
  "phone_number": "<string>",
  "outbound_phone_number_data": {
    "id": 123,
    "number": "<string>",
    "phone_number_id": "<string>"
  },
  "first_message": "<string>",
  "inbound_phone_number": 123,
  "inbound_phone_number_data": {
    "id": 123,
    "number": "<string>",
    "phone_number_id": "<string>"
  },
  "instructions": "<string>",
  "simulation_description": "<string>",
  "information_fields": {},
  "expected_outcome_prompt": "<string>",
  "scenario_language": "af",
  "scenario_type": "instruction",
  "suite_type": "undefined",
  "is_predefined": true,
  "test_profile": 123,
  "test_profile_data": {
    "id": 123,
    "project": 123,
    "agent": 123,
    "name": "<string>",
    "information": {}
  },
  "dynamic_variable_values": "<unknown>",
  "folder_path": "<string>",
  "max_duration": 123
}

Authorizations

X-CEKURA-API-KEY · string · header · required

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

Path Parameters

id · integer · required

A unique integer value identifying this scenario.

Response

200

application/json

id · integer

name · string

Name of the evaluator

agent · integer

Agent ID Example: 2142

project · integer | null

personality · integer

ID of the personality

personality_name · string

Name of the personality

tags · string[]

List of tags of the evaluators Example: ["tag1", "tag2", "tag3"]

tool_ids · any

List of tool IDs to associate with this scenario Example: ["TOOL_DTMF", "TOOL_END_CALL"]

runs · integer[]

List of run IDs Example: [123, 456, 789]

metrics · integer[]

List of metric IDs Example: [123, 456, 789]

metric_names · string[]

List of metric names Example: ["Metric 1", "Metric 2", "Metric 3"]

phone_number · string

Phone number eg: [phone]

outbound_phone_number_data · object

Phone number used for outbound calls in this scenario Example: "[phone]"

Show child attributes

first_message · string

First message of the evaluator

inbound_phone_number · integer | null

inbound_phone_number_data · object

(Deprecated) Phone number used for inbound calls in this scenario. Use outbound_phone_number_data instead. After CEK-6517, both phone_number and inbound_phone_number fields are synced, so outbound_phone_number_data contains the unified phone number for both inbound and outbound calls. Example: {"id": 123, "number": "[phone]", "phone_number_id": "abc123"}

Show child attributes

instructions · string

Instructions of the evaluator

simulation_description · string

Simulation Description

information_fields · object

Information fields of the evaluator Example:

{
    "user_name": "John Doe",
    "user_email": "[e-mail]",
}

Show child attributes

expected_outcome_prompt · string

Expected outcome prompt of the evaluator Example: "The user should be able to complete the order"

scenario_language · enum<string>

Language of the scenario

• af - Afrikaans
• ar - Arabic
• bn - Bengali
• bg - Bulgarian
• zh - Chinese Simplified
• cs - Czech
• da - Danish
• nl - Dutch
• en - English
• et - Estonian
• fi - Finnish
• fr - French
• de - German
• el - Greek
• gu - Gujarati
• hi - Hindi
• he - Hebrew
• hu - Hungarian
• id - Indonesian
• it - Italian
• ja - Japanese
• kn - Kannada
• ko - Korean
• ms - Malay
• ml - Malayalam
• mr - Marathi
• multi - Multilingual
• no - Norwegian
• pl - Polish
• pa - Punjabi
• pt - Portuguese
• ro - Romanian
• ru - Russian
• sk - Slovak
• es - Spanish
• sv - Swedish
• th - Thai
• tr - Turkish
• ta - Tamil
• te - Telugu
• uk - Ukrainian
• vi - Vietnamese

Available options: af, ar, bn, bg, zh, cs, da, nl, en, et, fi, fr, de, el, gu, hi, he, hu, id, it, ja, kn, ko, ms, ml, mr, multi, no, pl, pa, pt, ro, ru, sk, es, sv, th, tr, ta, te, uk, vi

scenario_type · enum<string> · default: instruction

Type of scenario (instruction, real_world_smart, or real_world_fixed)

• instruction - Instruction
• real_world_smart - Real World Smart
• real_world_fixed - Real World Fixed
• conditional_actions - Conditional Actions

Available options: instruction, real_world_smart, real_world_fixed, conditional_actions

suite_type · enum<string>

Type of predefined suite (e.g., infrastructure)

• undefined - Undefined
• infrastructure - Infrastructure

Available options: undefined, infrastructure

is_predefined · boolean

Whether this is a predefined scenario (template)

test_profile · integer | null

test_profile_data · object

Details of the test profile associated with this scenario Example:

{
    "id": "<integer>",
    "agent_id": "<integer>",
    "name": "<string>",
    "information": {
        "user_name": "<string>",
        "user_email": "<string>",
        "order_id": "<string>",
    },
}

Show child attributes

dynamic_variable_values · any | null

Generated values for the agent's dynamic variables for this scenario. Keys are variable names; values are the generated values.

folder_path · string · null · null

Path of the folder this scenario belongs to

max_duration · integer | null

Max call duration in seconds for this scenario. If not provided or set to null, the scenario will use the project's max_call_duration setting. Valid range: 10-3600 seconds (10 seconds to 60 minutes) Example: 600 (10 minutes)