Create Evaluator

cURL

curl --request POST \
  --url https://api.cekura.ai/test_framework/v1/scenarios/ \
  --header 'Content-Type: application/json' \
  --header 'X-CEKURA-API-KEY: <api-key>' \
  --data '{
  "agent": 123,
  "assistant_id": "<string>",
  "name": "<string>",
  "personality": 123,
  "instructions": "<string>",
  "expected_outcome_prompt": "<string>",
  "metrics": {},
  "tags": [
    "<string>"
  ],
  "tool_ids": [
    "<string>"
  ],
  "test_profile": 123,
  "inbound_phone_number": 123
}'

{
  "id": 123,
  "name": "<string>",
  "agent": 123,
  "personality": 123,
  "personality_name": "<string>",
  "tags": [
    "<string>"
  ],
  "tool_ids": "<any>",
  "runs": [
    123
  ],
  "metrics": [
    123
  ],
  "metric_names": [
    "<string>"
  ],
  "phone_number": "<string>",
  "first_message": "<string>",
  "inbound_phone_number": 123,
  "inbound_phone_number_data": {
    "id": 123,
    "number": "<string>",
    "phone_number_id": "<string>",
    "common": "<string>"
  },
  "instructions": "<string>",
  "simulation_description": "<string>",
  "information_fields": {},
  "expected_outcome_prompt": "<string>",
  "scenario_language": "ar",
  "test_profile": 123,
  "test_profile_data": {
    "id": 123,
    "agent": 123,
    "name": "<string>",
    "information": {}
  }
}

POST

test_framework

scenarios

cURL

curl --request POST \
  --url https://api.cekura.ai/test_framework/v1/scenarios/ \
  --header 'Content-Type: application/json' \
  --header 'X-CEKURA-API-KEY: <api-key>' \
  --data '{
  "agent": 123,
  "assistant_id": "<string>",
  "name": "<string>",
  "personality": 123,
  "instructions": "<string>",
  "expected_outcome_prompt": "<string>",
  "metrics": {},
  "tags": [
    "<string>"
  ],
  "tool_ids": [
    "<string>"
  ],
  "test_profile": 123,
  "inbound_phone_number": 123
}'

{
  "id": 123,
  "name": "<string>",
  "agent": 123,
  "personality": 123,
  "personality_name": "<string>",
  "tags": [
    "<string>"
  ],
  "tool_ids": "<any>",
  "runs": [
    123
  ],
  "metrics": [
    123
  ],
  "metric_names": [
    "<string>"
  ],
  "phone_number": "<string>",
  "first_message": "<string>",
  "inbound_phone_number": 123,
  "inbound_phone_number_data": {
    "id": 123,
    "number": "<string>",
    "phone_number_id": "<string>",
    "common": "<string>"
  },
  "instructions": "<string>",
  "simulation_description": "<string>",
  "information_fields": {},
  "expected_outcome_prompt": "<string>",
  "scenario_language": "ar",
  "test_profile": 123,
  "test_profile_data": {
    "id": 123,
    "agent": 123,
    "name": "<string>",
    "information": {}
  }
}

Authorizations

X-CEKURA-API-KEY

string

header

required

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

Body

personality

integer

required

The personality of the evaluator

agent

integer

ID of the AI agent this scenario belongs to

assistant_id

string

Alternative to agent ID - the assistant ID to use for this scenario

name

string

Maximum length: 80

instructions

string

expected_outcome_prompt

string

metrics

object

List of metric IDs to associate with this evaluator

Show child attributes

Response

integer

required

inbound_phone_number_data

object

required

Details of the phone number used for inbound calls

Show child attributes

test_profile_data

object

required

Details of the test profile associated with this scenario

Show child attributes

name

string

Name of the evaluator

agent

integer

ID of the AI agent this scenario belongs to

personality

integer

ID of the personality

personality_name

string

Name of the personality

API Reference

Authorizations

Body

Response