Create Scenario
Creates a new scenario from a dataset, script, or conversation graph.
https://api.futureagi.com/simulate/scenarios/create/ Authentication
Request body
Name for the scenario. Max 255 characters.
Optional description of the scenario.
Scenario type: "dataset" (default), "script", or "graph".
UUID of the agent definition to test. Required when generateGraph is true or sourceType is "agent_definition".
UUID of a specific agent version. Defaults to the latest version.
UUID of the source dataset. Required when kind is "dataset".
URL of the script file. Required when kind is "script".
Number of test case rows to generate. Range: 10—100. Default: 20.
Automatically assign diverse personas to generated test cases. Default: false.
Conversation graph defining the simulated flow. Required when kind is "graph" and generateGraph is false.
Auto-generate a conversation graph from the agent definition. Requires agentDefinitionId. Default: false.
List of persona UUIDs to include in the scenario.
Source for AI-powered generation: "agent_definition" (default) or "prompt". "prompt" requires promptTemplateId and promptVersionId.
UUID of the prompt template. Required when sourceType is "prompt".
UUID of the prompt version. Required when sourceType is "prompt". Must belong to promptTemplateId.
Custom column definitions (max 10). Each column: name (string, max 50 chars, unique), dataType (text, boolean, integer, float, json, array, image, images, datetime, audio, document, others, persona), description (string, max 200 chars).
Additional instruction to steer AI scenario generation.
Response
202 Acceptedid and name. "processing", then "completed". Errors
Missing or invalid fields such as blank name, missing datasetId/scriptUrl, or invalid custom columns.
Invalid or missing API credentials.
Unexpected server error.