GET
/
test_framework
/
v1
/
scenarios
/
cURL
curl --request GET \
  --url https://api.cekura.ai/test_framework/v1/scenarios/ \
  --header 'X-CEKURA-API-KEY: <api-key>'
{
  "count": 123,
  "next": "https://api.cekura.ai/example/v1/example-external/?page=4",
  "previous": "https://api.cekura.ai/example/v1/example-external/?page=3",
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "personality": 123,
      "personality_name": "<string>",
      "phone_number": "<string>",
      "expected_outcome_prompt": "<string>",
      "instructions": "<string>",
      "scenario_language": "ar",
      "tags": "<any>",
      "agent": 123,
      "inbound_phone_number": 123,
      "inbound_phone_number_data": {
        "id": 123,
        "number": "<string>",
        "phone_number_id": "<string>",
        "common": "<string>"
      },
      "metrics": [
        123
      ],
      "metric_names": "<string>",
      "first_message": "Hello",
      "tool_ids": "<any>",
      "test_profile": 123,
      "test_profile_data": {
        "id": 123,
        "agent": 123,
        "name": "<string>",
        "information": {}
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

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

assistant_id
string

Filter evaluators by assistant ID

Minimum length: 1
tags
string

Comma-separated list of tags to filter evaluators by

Minimum length: 1

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"