curl --request GET \
--url https://api.cekura.ai/test_framework/v1/scenarios/generate-progress/ \
--header 'X-CEKURA-API-KEY: <api-key>'{
"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
}
]
}Get Generate Evaluator Progress
Get progress of scenarios being generated.
curl --request GET \
--url https://api.cekura.ai/test_framework/v1/scenarios/generate-progress/ \
--header 'X-CEKURA-API-KEY: <api-key>'{
"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
}
]
}Authorizations
API Key Authentication. It should be included in the header of each request.
Query Parameters
UUID progress identifier returned from generate-bg endpoint
Response
Total number of scenarios
Number of completed scenarios
Number of failed scenarios
Show child attributes
Show child attributes
Unique identifier for the scenario
Name of the scenario
ID of the AI agent this scenario belongs to
Alternative to agent ID - the assistant ID to use for this scenario
ID of the personality used in this scenario
Name of the personality used in this scenario
Tags associated with this scenario.
List of IDs for the last run of this scenario
List of metric IDs to associate with this scenario
List of metric names associated with this scenario
Phone number used for outbound calls in this scenario
Number of runs in queue for this phone number
First message to be sent in the scenario
ID of the phone number used for inbound calls
Details of the phone number used for inbound calls
Instructions for the AI agent in this scenario
Description of the simulation if this scenario was created by simulation
Additional information fields for the scenario
Expected outcome prompt for the scenario
Language of the scenario
Whether this scenario was created by simulation