Skip to main content
GET
/
test_framework
/
v1
/
scenarios
/
generate-progress
/
cURL
curl --request GET \
  --url https://api.cekura.ai/test_framework/v1/scenarios/generate-progress/ \
  --header 'X-CEKURA-API-KEY: <api-key>'
import requests

url = "https://api.cekura.ai/test_framework/v1/scenarios/generate-progress/"

headers = {"X-CEKURA-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-CEKURA-API-KEY': '<api-key>'}};

fetch('https://api.cekura.ai/test_framework/v1/scenarios/generate-progress/', 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/generate-progress/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)

func main() {

url := "https://api.cekura.ai/test_framework/v1/scenarios/generate-progress/"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-CEKURA-API-KEY", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.cekura.ai/test_framework/v1/scenarios/generate-progress/")
.header("X-CEKURA-API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-CEKURA-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "total_scenarios": 123,
  "completed_scenarios": 123,
  "failed_scenarios": 123,
  "scenarios_list": [
    {
      "id": 123,
      "name": "<string>",
      "agent": 123,
      "assistant_id": "<string>",
      "personality": 123,
      "personality_name": "<string>",
      "tags": [
        "<string>"
      ],
      "runs": [
        123
      ],
      "metrics": [
        123
      ],
      "metric_names": [
        "<string>"
      ],
      "phone_number": "<string>",
      "phone_number_queue_length": 123,
      "first_message": "<string>",
      "inbound_phone_number": 123,
      "inbound_phone_number_data": {
        "id": 123,
        "number": "<string>",
        "phone_number_id": "<string>"
      },
      "instructions": "<string>",
      "simulation_description": "<string>",
      "information_fields": {},
      "expected_outcome_prompt": "<string>",
      "scenario_language": "<string>",
      "is_simulating": true
    }
  ]
}
{
"field_name": [
"<string>"
]
}

Authorizations

X-CEKURA-API-KEY
string
header
required

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

Query Parameters

progress_id
string
required

UUID progress identifier returned from generate-bg endpoint

Response

total_scenarios
integer

Total number of scenarios

completed_scenarios
integer

Number of completed scenarios

failed_scenarios
integer

Number of failed scenarios

scenarios_list
object[]