Skip to main content
GET
/
test_framework
/
v1
/
scenarios
List evaluators (scenarios)
curl --request GET \
  --url https://api.cekura.ai/test_framework/v1/scenarios/ \
  --header 'X-CEKURA-API-KEY: <api-key>'
{
  "count": 123,
  "results": [
    {
      "name": "<string>",
      "instructions": "<string>",
      "agent": 123,
      "id": 123,
      "personality": 123,
      "personality_name": "<string>",
      "agent_name": "<string>",
      "phone_number": "<string>",
      "expected_outcome_prompt": "<string>",
      "scenario_type": "instruction",
      "tags": "<unknown>",
      "inbound_phone_number": 123,
      "inbound_phone_number_data": "<string>",
      "metrics": "<string>",
      "metric_names": "<string>",
      "first_message": "Hello",
      "tool_ids": "<unknown>",
      "test_profile": 123,
      "test_profile_data": {
        "name": "<string>",
        "id": 123,
        "project": 123,
        "agent": 123,
        "agent_name": "<string>",
        "information": "<unknown>",
        "created_by": 123,
        "last_updated_by": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "dynamic_variable_values": "<unknown>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by": 123,
      "last_updated_by": 123,
      "folder_path": "<string>"
    }
  ],
  "next": "https://api.cekura.ai/example/v1/example-external/?page=4",
  "previous": "https://api.cekura.ai/example/v1/example-external/?page=3"
}

Authorizations

​
X-CEKURA-API-KEY
string
header
required

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

Query Parameters

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
agent_id
integer

Filter evaluators by agent ID Example: 2142

​
project_id
integer

Filter evaluators by project ID Example: 1

​
assistant_id
string

Filter evaluators by assistant ID Example: asst_1234567890

Minimum string length: 1
​
tags
string

Comma-separated list of tags to filter evaluators by Example: tag1,tag2,tag3

Minimum string length: 1
​
tag_filter_type
enum<string>
default:or

Filter operation type for tags

  • and - and
  • or - or
  • not - not
Available options:
and,
or,
not
Minimum string length: 1
​
folder_path
string

Filter evaluators by folder path. Use empty string to get evaluators without a folder. Example: Sales.Inbound

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"https://api.cekura.ai/example/v1/example-external/?page=4"

​
previous
string<uri> | null
Example:

"https://api.cekura.ai/example/v1/example-external/?page=3"