Fetch Scenarios V2 JSON Schema
Fetch the JSON Schema for test-suite spec files
Authorizations
OAuth access token issued by Cekura for connected apps.
Query Parameters
Spec version to fetch. Defaults to the current version.
Response
Personality ID
Example: 123
Name of the scenario
80Agent ID
Example: 2142
Name of the personality used in this scenario
Example: "Normal Male"
Name of the agent associated with this scenario
Example: "Customer Support Agent"
Tags associated with the scenario
Example: ["tag1", "tag2"]
List of tool IDs to associate with this scenario
Example: ["TOOL_DTMF", "TOOL_END_CALL"]
List of metric names associated with this scenario
Example: ["Metric 1", "Metric 2"]
Phone number ID - Used for both inbound and outbound calls
Example: 123
Phone number used for outbound calls in this scenario
Example: "+1234567890"
First message to be sent to the Main Agent
(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
(Deprecated) Phone number used for inbound calls in this scenario. Use outbound_phone_number_data instead.
After CEK-6517, both phone_number and inbound_phone_number fields are synced, so outbound_phone_number_data contains the unified phone number for both inbound and outbound calls.
Example: {"id": 123, "number": "+1234567890", "phone_number_id": "abc123"}
Scenario Instructions
Simulation Description
Information fields associated with the scenario
Example: {"user_name": "John Doe", "user_email": "john.doe@example.com", "order_id": "1234567890"}
Expected Outcome Prompt
Example: "The user should be able to complete the order"
Language of the scenario
af- Afrikaansar- Arabicbn- Bengalibg- Bulgarianzh- Chinese Simplifiedcs- Czechda- Danishnl- Dutchen- Englishet- Estonianfi- Finnishfr- Frenchde- Germanel- Greekgu- Gujaratihi- Hindihe- Hebrewhu- Hungarianid- Indonesianit- Italianja- Japanesekn- Kannadako- Koreanms- Malayml- Malayalammr- Marathimulti- Multilingualno- Norwegianpl- Polishpa- Punjabipt- Portuguesero- Romanianru- Russiansk- Slovakes- Spanishsv- Swedishth- Thaitr- Turkishtl- Tagalogta- Tamilte- Teluguuk- Ukrainianvi- Vietnamese
af, ar, bn, bg, zh, cs, da, nl, en, et, fi, fr, de, el, gu, hi, he, hu, id, it, ja, kn, ko, ms, ml, mr, multi, no, pl, pa, pt, ro, ru, sk, es, sv, th, tr, tl, ta, te, uk, vi Type of scenario (instruction, real_world_smart, or real_world_fixed)
instruction- Instructionreal_world_smart- Real World Smartreal_world_fixed- Real World Fixedconditional_actions- Conditional Actions
instruction, real_world_smart, real_world_fixed, conditional_actions Type of predefined suite (e.g., infrastructure)
undefined- Undefinedinfrastructure- Infrastructure
undefined, infrastructure Whether this is a predefined scenario (template)
Details of the test profile associated with this scenario. information uses the
sectioned shape: main_agent_variables are sent to the agent under test as
dynamic variables at call time; testing_agent_variables are persona/context
used by Cekura's simulated caller. Legacy flat dicts (no section keys) still
work — at call time they are delivered to both sides for backward compatibility.
Example:
REMOVED FROM API. Reads return the historical value for legacy rows (null for new rows). Writes are no longer accepted — supplying a non-null value yields a 400 error. Put dynamic-variable values in test_profile_data.information.main_agent_variables instead: create the test profile via POST /test-profiles/ and attach it via the test_profile field on the scenario.
Expected mock tool calls for this evaluator. Each entry has shape {tool_id, tool_name, new_entry: {input, output}}. Auto-generated during scenario generation when the agent has mock tools attached; can also be set or edited manually.
Dot-separated path of the folder to assign this evaluator to (e.g. "Sales.Inbound"). Folders must be created before use — they are not auto-created. Use scenarios_create_folder_create to create each level before assigning evaluators. Example: to use "Sales.Inbound", first create "Sales", then create "Inbound" inside it.
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)