Get Simulate Scenarios Progress

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<uuid>

required

Progress ID returned from create_scenarios endpoint

Response

agent_id

integer

ID of the agent associated with the scenario creation

completed_scenarios

integer

Number of scenarios successfully created

failed_scenarios

integer

Number of scenarios that failed to create

total_scenarios

integer

Total number of scenarios being processed

scenarios_list

object[]

List of created scenario objects (only included when processing is complete)

Show child attributes

scenarios_list.id

integer

scenarios_list.name

string

Name of the scenario

Maximum string length: 80

scenarios_list.agent

integer

Agent ID Example: 2142

scenarios_list.personality

integer

Personality ID Example: 123

scenarios_list.personality_name

string

Name of the personality used in this scenario Example: "Normal Male"

scenarios_list.tags

any

Tags associated with the scenario Example: ["tag1", "tag2"]

scenarios_list.tool_ids

any

List of tool IDs to associate with this scenario Example: ["TOOL_DTMF", "TOOL_END_CALL"]

scenarios_list.runs

string

List of IDs for the last run of this scenario Example: [123, 456]

scenarios_list.metric_names

string

List of metric names associated with this scenario Example: ["Metric 1", "Metric 2"]

scenarios_list.phone_number

string

Phone number used for outbound calls in this scenario Example: "+1234567890"

scenarios_list.outbound_phone_number_data

object

Phone number used for outbound calls in this scenario Example: "+1234567890"

Show child attributes

scenarios_list.outbound_phone_number_data.id

integer

scenarios_list.outbound_phone_number_data.number

string

Maximum string length: 15

scenarios_list.outbound_phone_number_data.phone_number_id

string

Maximum string length: 255

scenarios_list.first_message

string

First message to be sent to the Main Agent

Maximum string length: 1000

scenarios_list.inbound_phone_number

integer | null

scenarios_list.inbound_phone_number_data

object

Phone number used for inbound calls in this scenario Example: "+1234567890"

Show child attributes

scenarios_list.inbound_phone_number_data.id

integer

scenarios_list.inbound_phone_number_data.number

string

Maximum string length: 15

scenarios_list.inbound_phone_number_data.phone_number_id

string

Maximum string length: 255

scenarios_list.instructions

string

Scenario Instructions

scenarios_list.simulation_description

string

Simulation Description

scenarios_list.information_fields

any

Information fields associated with the scenario Example: {"user_name": "John Doe", "user_email": "[email protected]", "order_id": "1234567890"}

scenarios_list.expected_outcome_prompt

string

Expected Outcome Prompt Example: "The user should be able to complete the order"

scenarios_list.scenario_language

enum<string>

Language of the scenario

af - Afrikaans
ar - Arabic
bg - Bulgarian
zh - Chinese Simplified
cs - Czech
da - Danish
nl - Dutch
en - English
fi - Finnish
fr - French
de - German
el - Greek
hi - Hindi
he - Hebrew
hu - Hungarian
id - Indonesian
it - Italian
ja - Japanese
ko - Korean
ms - Malay
multi - Multilingual
no - Norwegian
pl - Polish
pt - Portuguese
ro - Romanian
ru - Russian
sk - Slovak
es - Spanish
sv - Swedish
th - Thai
tr - Turkish
ta - Tamil
uk - Ukrainian
vi - Vietnamese

Available options:

af,

ar,

bg,

zh,

cs,

da,

nl,

en,

fi,

fr,

de,

el,

hi,

he,

hu,

id,

it,

ja,

ko,

ms,

multi,

no,

pl,

pt,

ro,

ru,

sk,

es,

sv,

th,

tr,

ta,

uk,

vi

scenarios_list.scenario_type

enum<string>

default:instruction

Type of scenario (instruction, real_world_smart, or real_world_fixed)

instruction - Instruction
real_world_smart - Real World Smart
real_world_fixed - Real World Fixed

Available options:

instruction,

real_world_smart,

real_world_fixed

scenarios_list.test_profile

integer | null

scenarios_list.test_profile_data

object

Details of the test profile associated with this scenario Example:

{
    "id": "<integer>",
    "agent_id": "<integer>",
    "name": "<string>",
    "information": {
        "user_name": "<string>",
        "user_email": "<string>",
        "order_id": "<string>",
    },
}

Show child attributes

scenarios_list.test_profile_data.id

integer

scenarios_list.test_profile_data.agent

integer

scenarios_list.test_profile_data.name

string

Maximum string length: 255

scenarios_list.test_profile_data.information

object

Information fields for the test profile Example:

{
    "user_name": "John Doe",
    "user_email": "[email protected]",
}

Show child attributes

scenarios_list.test_profile_data.information.{key}

string

errors

object[]

List of errors encountered during scenario creation

Show child attributes

errors.{key}

any

API Reference

Authorizations

Query Parameters

Response