Create Scenario

Creates a new scenario from a dataset, script, or conversation graph.

POST https://api.futureagi.com/simulate/scenarios/create/

Authentication

X-Api-Key API Key Required

Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the Dashboard under Settings.

X-Secret-Key Secret Key Required

Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the Dashboard.

Request body

name string Required

Name for the scenario. Max 255 characters.

description string Optional

Optional description of the scenario.

kind string Optional

Scenario type: "dataset" (default), "script", or "graph".

agentDefinitionId string Optional

UUID of the agent definition to test. Required when generateGraph is true or sourceType is "agent_definition".

agentDefinitionVersionId string Optional

UUID of a specific agent version. Defaults to the latest version.

datasetId string Optional

UUID of the source dataset. Required when kind is "dataset".

scriptUrl string Optional

URL of the script file. Required when kind is "script".

noOfRows integer Optional

Number of test case rows to generate. Range: 10—100. Default: 20.

addPersonaAutomatically boolean Optional

Automatically assign diverse personas to generated test cases. Default: false.

graph object Optional

Conversation graph defining the simulated flow. Required when kind is "graph" and generateGraph is false.

generateGraph boolean Optional

Auto-generate a conversation graph from the agent definition. Requires agentDefinitionId. Default: false.

personas array of string Optional

List of persona UUIDs to include in the scenario.

sourceType string Optional

Source for AI-powered generation: "agent_definition" (default) or "prompt". "prompt" requires promptTemplateId and promptVersionId.

promptTemplateId string Optional

UUID of the prompt template. Required when sourceType is "prompt".

promptVersionId string Optional

UUID of the prompt version. Required when sourceType is "prompt". Must belong to promptTemplateId.

customColumns array of object Optional

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).

customInstruction string Optional

Additional instruction to steer AI scenario generation.

Response

202 Accepted
message string
Confirmation that scenario creation has been queued.
scenario object
Created scenario with id and name.
status string
Processing status. Initially "processing", then "completed".

Errors

400 Bad Request Optional

Missing or invalid fields such as blank name, missing datasetId/scriptUrl, or invalid custom columns.

401 Unauthorized Optional

Invalid or missing API credentials.

500 Internal Server Error Optional

Unexpected server error.

GET /
Authentication
REQUEST
 
RESPONSE