Skip to main content
POST
/
simulate
/
scenarios
/
create
/
Create scenario
curl --request POST \
  --url https://api.futureagi.com/simulate/scenarios/create/ \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Secret-Key: <api-key>' \
  --data '{
  "name": "Customer Support Test",
  "agent_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "message": "Dataset scenario creation started",
  "scenario": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "source": "<string>",
    "scenario_type": "DATASET",
    "organization": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dataset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dataset_rows": 123,
    "status": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "status": "processing"
}

Authorizations

​
X-Api-Key
string
header
required

API Key for authentication. Click here to access API Key

​
X-Secret-Key
string
header
required

Secret Key for authentication. Click here to access Secret Key

Body

application/json
​
name
string
required

Scenario name

Example:

"Customer Support Test"

​
agent_definition_id
string<uuid>
required

ID of the agent definition

​
description
string

Optional scenario description

​
kind
enum<string>
default:dataset

Type of scenario to create

Available options:
dataset,
script,
graph
​
dataset_id
string<uuid>

Required for dataset kind - ID of dataset to copy

​
script_url
string<url>

Required for script kind - URL of the script

​
no_of_rows
integer
default:20

Number of rows to generate

​
generate_graph
boolean
default:false

For graph kind - whether to auto-generate graph

​
graph
object

For graph kind - provide graph data directly

​
personas
string<uuid>[]

List of persona IDs to use

Response

Scenario creation started

​
message
string
Example:

"Dataset scenario creation started"

​
scenario
object
​
status
string
Example:

"processing"