Run Evaluator Voice

POST /test_framework/v1/scenarios/run_scenarios

cURL

cURL

curl --request POST \
  --url https://api.cekura.ai/test_framework/v1/scenarios/run_scenarios/ \
  --header 'Content-Type: application/json' \
  --header 'X-CEKURA-API-KEY: <api-key>' \
  --data '
{
  "agent_id": 123,
  "assistant_id": "<string>",
  "scenarios": [
    123
  ],
  "tags": [
    "<string>"
  ],
  "frequency": 1,
  "name": "<string>",
  "outbound_phone_number": "<string>",
  "personality_ids": [
    123
  ],
  "test_profile_ids": [
    123
  ],
  "mode": "same_number",
  "agent_number": "<string>",
  "project_id": 123
}
'

201

InboundScenario

{
  "id": 167,
  "agent": 1,
  "status": "pending",
  "success_rate": 0,
  "run_as_text": false,
  "runs": [
    {
      "id": 274,
      "scenario": 1,
      "number": null,
      "inbound_number": "[phone]"
    },
    {
      "id": 273,
      "scenario": 2,
      "number": null,
      "inbound_number": "[phone]"
    }
  ],
  "created_at": "2025-02-25T21:00:01.990052Z"
}

Authorizations

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

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

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

agent_id · integer

ID of the agent to run evaluators for

assistant_id · string

Alternative to agent ID - the assistant ID to use for this scenario Example: "asst_1234567890"

scenarios · integer[]

List of evaluator IDs to run. Either evaluators, tags, or folder_path must be provided. Can also accept: an integer (first N evaluators), "all" (all evaluators), or a folder path string (e.g. "Sales.Inbound") to select evaluators by folder. When using a folder path string, project_id is required. Example: [11, 22, 33]

tags · string[]

List of tags to filter evaluators to run. Either evaluators or tags must be provided. Example: ["tag1", "tag2", "tag3"]

frequency · integer · default: 1

The number of times each evaluator will run Example: 1

name · string

Label text for result

outbound_phone_number · string

Override the phone number to use for outbound calls. Example: "[phone]"

personality_ids · integer[] | null

List of personality IDs to override for this run. If not provided, uses the scenario's default personality. Example: [123, 456, 789]

test_profile_ids · integer[] | null

List of test profile IDs to override for this run. If not provided, uses the scenario's default test profile. Example: [123, 456, 789]

mode · enum<string> · default: same_number

Using same or different phone numbers for each evaluation

• same_number - same_number
• different_numbers - different_numbers

Available options: same_number, different_numbers

agent_number · string

Override the phone number from which the agent under test receives the call during outbound runs. This allows overriding the default agent contact number for testing purposes. Example: "[phone]"

project_id · integer

Project ID. Required when using a folder path string in the scenarios field. Example: 1376

Response

201

application/json

id · integer

ID of the result

agent · integer

ID of the agent

status · enum<string>

Status of the result

Available options: pending, running, completed, failed

run_as_text · boolean

Whether the scenario ran as text or not

Example:

false

runs · object[]

Show child attributes

Examples:

{
  "id": 274,
  "status": "pending",
  "scenario": 1,
  "number": null,
  "inbound_number": "[phone]",
  "scenario_name": "Customer Support Call (Agent Inbound = True)",
  "test_profile_data": null
}

{
  "id": 275,
  "status": "pending",
  "scenario": 2,
  "number": "[phone]",
  "inbound_number": null,
  "scenario_name": "Outbound Sales Call (Agent Inbound = False)",
  "test_profile_data": null
}

created_at · string<date-time>

Example:

"2025-02-25T21:00:01.990052Z"