Run Evaluator Text

Run evaluators in text / SMS / chat mode

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

import requests

url = "https://api.cekura.ai/test_framework/v1/scenarios/run_scenarios_text/"

payload = {
    "agent_id": 123,
    "assistant_id": "<string>",
    "name": "<string>",
    "scenarios": [123],
    "tags": ["<string>"],
    "folder_path": "<string>",
    "project_id": 123,
    "frequency": 1,
    "websocket_url": "<string>",
    "websocket_headers": {},
    "personality_ids": [123],
    "test_profile_ids": [123],
    "agent_number": "<string>",
    "outbound_phone_number": "<string>",
    "concurrency_limit": 2,
    "mock_tool_names": ["<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({
    agent_id: 123,
    assistant_id: '<string>',
    name: '<string>',
    scenarios: [123],
    tags: ['<string>'],
    folder_path: '<string>',
    project_id: 123,
    frequency: 1,
    websocket_url: '<string>',
    websocket_headers: {},
    personality_ids: [123],
    test_profile_ids: [123],
    agent_number: '<string>',
    outbound_phone_number: '<string>',
    concurrency_limit: 2,
    mock_tool_names: ['<string>']
  })
};

fetch('https://api.cekura.ai/test_framework/v1/scenarios/run_scenarios_text/', 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/run_scenarios_text/",
  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([
    'agent_id' => 123,
    'assistant_id' => '<string>',
    'name' => '<string>',
    'scenarios' => [
        123
    ],
    'tags' => [
        '<string>'
    ],
    'folder_path' => '<string>',
    'project_id' => 123,
    'frequency' => 1,
    'websocket_url' => '<string>',
    'websocket_headers' => [
        
    ],
    'personality_ids' => [
        123
    ],
    'test_profile_ids' => [
        123
    ],
    'agent_number' => '<string>',
    'outbound_phone_number' => '<string>',
    'concurrency_limit' => 2,
    'mock_tool_names' => [
        '<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/run_scenarios_text/"

	payload := strings.NewReader("{\n  \"agent_id\": 123,\n  \"assistant_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"scenarios\": [\n    123\n  ],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"folder_path\": \"<string>\",\n  \"project_id\": 123,\n  \"frequency\": 1,\n  \"websocket_url\": \"<string>\",\n  \"websocket_headers\": {},\n  \"personality_ids\": [\n    123\n  ],\n  \"test_profile_ids\": [\n    123\n  ],\n  \"agent_number\": \"<string>\",\n  \"outbound_phone_number\": \"<string>\",\n  \"concurrency_limit\": 2,\n  \"mock_tool_names\": [\n    \"<string>\"\n  ]\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/run_scenarios_text/")
  .header("X-CEKURA-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": 123,\n  \"assistant_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"scenarios\": [\n    123\n  ],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"folder_path\": \"<string>\",\n  \"project_id\": 123,\n  \"frequency\": 1,\n  \"websocket_url\": \"<string>\",\n  \"websocket_headers\": {},\n  \"personality_ids\": [\n    123\n  ],\n  \"test_profile_ids\": [\n    123\n  ],\n  \"agent_number\": \"<string>\",\n  \"outbound_phone_number\": \"<string>\",\n  \"concurrency_limit\": 2,\n  \"mock_tool_names\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"agent_id\": 123,\n  \"assistant_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"scenarios\": [\n    123\n  ],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"folder_path\": \"<string>\",\n  \"project_id\": 123,\n  \"frequency\": 1,\n  \"websocket_url\": \"<string>\",\n  \"websocket_headers\": {},\n  \"personality_ids\": [\n    123\n  ],\n  \"test_profile_ids\": [\n    123\n  ],\n  \"agent_number\": \"<string>\",\n  \"outbound_phone_number\": \"<string>\",\n  \"concurrency_limit\": 2,\n  \"mock_tool_names\": [\n    \"<string>\"\n  ]\n}"

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

{
  "id": 123,
  "agent": 123,
  "run_as_text": false,
  "runs": [
    {
      "id": 123,
      "scenario": 123,
      "number": "+11234567890",
      "inbound_number": "+11234567890",
      "scenario_name": "<string>",
      "test_profile_data": {},
      "outbound_dial_window_opens_at": "2023-11-07T05:31:56Z",
      "outbound_dial_window_seconds": 123,
      "outbound_dial_window_closes_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2025-02-25T21:00:01.990052Z"
}

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

POST

test_framework

scenarios

run_scenarios_text

Run evaluators in text / SMS / chat mode

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

import requests

url = "https://api.cekura.ai/test_framework/v1/scenarios/run_scenarios_text/"

payload = {
    "agent_id": 123,
    "assistant_id": "<string>",
    "name": "<string>",
    "scenarios": [123],
    "tags": ["<string>"],
    "folder_path": "<string>",
    "project_id": 123,
    "frequency": 1,
    "websocket_url": "<string>",
    "websocket_headers": {},
    "personality_ids": [123],
    "test_profile_ids": [123],
    "agent_number": "<string>",
    "outbound_phone_number": "<string>",
    "concurrency_limit": 2,
    "mock_tool_names": ["<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({
    agent_id: 123,
    assistant_id: '<string>',
    name: '<string>',
    scenarios: [123],
    tags: ['<string>'],
    folder_path: '<string>',
    project_id: 123,
    frequency: 1,
    websocket_url: '<string>',
    websocket_headers: {},
    personality_ids: [123],
    test_profile_ids: [123],
    agent_number: '<string>',
    outbound_phone_number: '<string>',
    concurrency_limit: 2,
    mock_tool_names: ['<string>']
  })
};

fetch('https://api.cekura.ai/test_framework/v1/scenarios/run_scenarios_text/', 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/run_scenarios_text/",
  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([
    'agent_id' => 123,
    'assistant_id' => '<string>',
    'name' => '<string>',
    'scenarios' => [
        123
    ],
    'tags' => [
        '<string>'
    ],
    'folder_path' => '<string>',
    'project_id' => 123,
    'frequency' => 1,
    'websocket_url' => '<string>',
    'websocket_headers' => [
        
    ],
    'personality_ids' => [
        123
    ],
    'test_profile_ids' => [
        123
    ],
    'agent_number' => '<string>',
    'outbound_phone_number' => '<string>',
    'concurrency_limit' => 2,
    'mock_tool_names' => [
        '<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/run_scenarios_text/"

	payload := strings.NewReader("{\n  \"agent_id\": 123,\n  \"assistant_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"scenarios\": [\n    123\n  ],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"folder_path\": \"<string>\",\n  \"project_id\": 123,\n  \"frequency\": 1,\n  \"websocket_url\": \"<string>\",\n  \"websocket_headers\": {},\n  \"personality_ids\": [\n    123\n  ],\n  \"test_profile_ids\": [\n    123\n  ],\n  \"agent_number\": \"<string>\",\n  \"outbound_phone_number\": \"<string>\",\n  \"concurrency_limit\": 2,\n  \"mock_tool_names\": [\n    \"<string>\"\n  ]\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/run_scenarios_text/")
  .header("X-CEKURA-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": 123,\n  \"assistant_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"scenarios\": [\n    123\n  ],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"folder_path\": \"<string>\",\n  \"project_id\": 123,\n  \"frequency\": 1,\n  \"websocket_url\": \"<string>\",\n  \"websocket_headers\": {},\n  \"personality_ids\": [\n    123\n  ],\n  \"test_profile_ids\": [\n    123\n  ],\n  \"agent_number\": \"<string>\",\n  \"outbound_phone_number\": \"<string>\",\n  \"concurrency_limit\": 2,\n  \"mock_tool_names\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"agent_id\": 123,\n  \"assistant_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"scenarios\": [\n    123\n  ],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"folder_path\": \"<string>\",\n  \"project_id\": 123,\n  \"frequency\": 1,\n  \"websocket_url\": \"<string>\",\n  \"websocket_headers\": {},\n  \"personality_ids\": [\n    123\n  ],\n  \"test_profile_ids\": [\n    123\n  ],\n  \"agent_number\": \"<string>\",\n  \"outbound_phone_number\": \"<string>\",\n  \"concurrency_limit\": 2,\n  \"mock_tool_names\": [\n    \"<string>\"\n  ]\n}"

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

{
  "id": 123,
  "agent": 123,
  "run_as_text": false,
  "runs": [
    {
      "id": 123,
      "scenario": 123,
      "number": "+11234567890",
      "inbound_number": "+11234567890",
      "scenario_name": "<string>",
      "test_profile_data": {},
      "outbound_dial_window_opens_at": "2023-11-07T05:31:56Z",
      "outbound_dial_window_seconds": 123,
      "outbound_dial_window_closes_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2025-02-25T21:00:01.990052Z"
}

{
  "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

Schema for the run_scenarios_text endpoint, which runs scenarios in text mode (SMS, chat, or agent-hosted websocket).

agent_id

integer

ID of the agent to run evaluators for

assistant_id

string

write-only

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

name

string

Label text for result

scenarios

integer[]

List of evaluator IDs to run. Either scenarios, tags, or folder_path must be provided. Example: [11, 22, 33]

To run evaluators by tag or folder, use the tags or folder_path fields instead.

Response

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": "+11234567890",
  "scenario_name": "Customer Support Call (Agent Inbound = True)",
  "test_profile_data": null,
  "outbound_dial_window_opens_at": null,
  "outbound_dial_window_seconds": null,
  "outbound_dial_window_closes_at": null
}

{
  "id": 275,
  "status": "pending",
  "scenario": 2,
  "number": "+11234567890",
  "inbound_number": null,
  "scenario_name": "Outbound Sales Call (Agent Inbound = False)",
  "test_profile_data": null,
  "outbound_dial_window_opens_at": "2026-06-24T10:47:30Z",
  "outbound_dial_window_seconds": 300,
  "outbound_dial_window_closes_at": "2026-06-24T10:52:30Z"
}

created_at

string<date-time>

Example:

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

Run Evaluator Voice Run Evaluator Email

⌘I