Interface: CreateScenarioRequest
@kortexya/reasoninglayer / CreateScenarioRequest
Interface: CreateScenarioRequest
Section titled “Interface: CreateScenarioRequest”Defined in: src/types/scenarios.ts:95
Request body for scenario creation (generate + materialize).
Properties
Section titled “Properties”agentName?
Section titled “agentName?”
optionalagentName?:string|null
Defined in: src/types/scenarios.ts:97
Optional custom agent name.
answers?
Section titled “answers?”
optionalanswers?:object|null
Defined in: src/types/scenarios.ts:99
Answers to clarification questions (2nd call in multi-turn flow).
createAgent?
Section titled “createAgent?”
optionalcreateAgent?:boolean
Defined in: src/types/scenarios.ts:101
Whether to create a cognitive agent from the scenario.
enableCurriculum?
Section titled “enableCurriculum?”
optionalenableCurriculum?:boolean
Defined in: src/types/scenarios.ts:103
Whether to generate curriculum stages.
enableGrounding?
Section titled “enableGrounding?”
optionalenableGrounding?:boolean
Defined in: src/types/scenarios.ts:105
Whether to apply concept grounding after materialization.
prefixes?
Section titled “prefixes?”
optionalprefixes?:Record<string,string>
Defined in: src/types/scenarios.ts:113
Prefix bindings (prefix → namespace IRI, '' = the default prefix) the
generated scenario’s CURIE names use. Same contract as
BulkCreateSortsRequest.prefixes: bound on the tenant with the
scenario’s sorts, and released again when the scenario is refused. The keys
go out verbatim.
prompt
Section titled “prompt”prompt:
string
Defined in: src/types/scenarios.ts:115
Natural language task description (e.g., “organize a conference”).
runInitialCycle?
Section titled “runInitialCycle?”
optionalrunInitialCycle?:boolean
Defined in: src/types/scenarios.ts:117
Whether to run an initial cognitive cycle after materialization. Requires create_agent to be true.
sessionId?
Section titled “sessionId?”
optionalsessionId?:string|null
Defined in: src/types/scenarios.ts:119
Session ID for multi-turn clarification continuity.