CEcekura
test_framework

Get scenario instructions progress

Changed on

Get scenario instructions progress

get/test_framework/v2/scenarios/instructions-progress/

Request

  • Base URL
    https://api.cekura.ai
  • URL
    https://api.cekura.ai/test_framework/v2/scenarios/instructions-progress/
  • Auth
    • API key in header X-CEKURA-API-KEY
    • or HTTP bearer
    • or HTTP bearer

Query parameters

agent_idinteger

Tenant scope. Supply one of agent_id, project_id, assistant_id when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant.

project_idinteger

Tenant scope. Supply one of agent_id, project_id, assistant_id when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant.

assistant_idstring

Tenant scope. Supply one of agent_id, project_id, assistant_id when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant.

Response

idinteger
namestring

Name of the scenario

agentinteger

Agent ID Example: 2142

projectinteger nullable
assistant_idstring

Alternative to agent ID - the assistant ID to use for this scenario Example: "asst_1234567890"

personalityinteger required

Personality ID Example: 123

personality_namestring

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

agent_namestring

Name of the agent associated with this scenario Example: "Customer Support Agent"

tagsunknown
tool_idsunknown
metricsunknown
metric_namesstring

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

phone_numberinteger nullable

Phone number ID - Used for both inbound and outbound calls Example: 123

first_messagestring

First message to be sent to the Main Agent

inbound_phone_numberinteger nullable

(Deprecated) Use phone_number instead. This field is maintained for backward compatibility only. When phone_number is set, this field will be automatically synced. Example: 123

instructionsstring

Scenario Instructions

conditional_actionsunknown
condition_audioobject

Pre-recorded clips available to this scenario's conditional actions, keyed by clip id. Read-only: upload, replace and delete clips, and correct a transcript, through condition-audio/. Reference a clip from any number of verbatim steps by pasting its tag; steps lists where it is used (e.g. conditions[1].then[0]).

Example:

{
  "greeting": {"tag": "<audio id=\"greeting\"/>", "filename": "greeting.wav",
               "status": "ready", "duration": 2.4, "transcript": "Hi, is this the clinic?",
               "steps": ["first_message", "conditions[1]"]}
}
simulation_descriptionstring
information_fieldsunknown
expected_outcome_promptstring

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

scenario_language'af' | 'ar' | 'bn' | 'bg' | 'zh' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'gu' | 'hi' | 'he' | 'hu' | 'id' | 'it' | 'ja' | 'kn' | 'kk' | 'ko' | 'ms' | 'ml' | 'mr' | 'multi' | 'no' | 'pl' | 'pa' | 'pt' | 'ro' | 'ru' | 'sk' | 'es' | 'sv' | 'th' | 'tr' | 'tl' | 'ta' | 'te' | 'uk' | 'uz' | 'vi'

Language of the scenario

  • af - Afrikaans
  • ar - Arabic
  • bn - Bengali
  • bg - Bulgarian
  • zh - Chinese Simplified
  • cs - Czech
  • da - Danish
  • nl - Dutch
  • en - English
  • et - Estonian
  • fi - Finnish
  • fr - French
  • de - German
  • el - Greek
  • gu - Gujarati
  • hi - Hindi
  • he - Hebrew
  • hu - Hungarian
  • id - Indonesian
  • it - Italian
  • ja - Japanese
  • kn - Kannada
  • kk - Kazakh
  • ko - Korean
  • ms - Malay
  • ml - Malayalam
  • mr - Marathi
  • multi - Multilingual
  • no - Norwegian
  • pl - Polish
  • pa - Punjabi
  • pt - Portuguese
  • ro - Romanian
  • ru - Russian
  • sk - Slovak
  • es - Spanish
  • sv - Swedish
  • th - Thai
  • tr - Turkish
  • tl - Tagalog
  • ta - Tamil
  • te - Telugu
  • uk - Ukrainian
  • uz - Uzbek
  • vi - Vietnamese
scenario_type'instruction' | 'conditional_actions'

Type of scenario. Defaults to instruction. Must be sent as conditional_actions when the request includes the conditional_actions field.

  • instruction - Instruction
  • conditional_actions - Conditional Actions
suite_type'undefined' | 'infrastructure'

Type of predefined suite (e.g., infrastructure)

  • undefined - Undefined
  • infrastructure - Infrastructure
is_predefinedboolean

Whether this is a predefined scenario (template)

test_profileinteger nullable
dynamic_variable_valuesunknown
generated_mock_tool_entriesunknown
folder_pathstring nullable

Path of an existing folder to assign this evaluator to, e.g. "Sales" or "Sales.Inbound". Create it first with the create-folder endpoint.

max_durationinteger nullable

Max call duration in seconds for this scenario. If not provided or set to null, the scenario will use the project's max_call_duration setting. Valid range: 10-3600 seconds (10 seconds to 60 minutes) Example: 600 (10 minutes)

Changes