Generate or create a scenario - Future AGI Documentation

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": "test-scene-1", "agent_definition_id": "87a193df-12a6-46e1-860d-d18ddb4a00cf" } '

{ "message": "Graph scenario creation started", "scenario": { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "description": "<string>", "source": "<string>", "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

The name of the scenario.

Maximum string length: 255

agent_definition_id

string<uuid>

required

The UUID of the agent definition to associate with this scenario. Required when generate_graph is true.

description

string

An optional description for the scenario.

kind

enum<string>

default:dataset

The kind of scenario to create.

Available options:

dataset,

script,

graph

dataset_id

string<uuid>

The UUID of the source dataset. Required if kind is 'dataset'.

script_url

string<uri>

URL to the script. Required if kind is 'script'.

no_of_rows

integer

default:20

Number of rows to generate for a 'graph' kind scenario.

add_persona_automatically

boolean

default:false

If true, automatically adds personas to the scenario.

graph

object | null

The graph structure for a 'graph' kind scenario. Required if 'generate_graph' is false.

generate_graph

boolean

default:false

If true, generates a graph for the scenario. agent_definition_id is required.

personas

string<uuid>[]

List of persona IDs to use in the scenario.

Response

Scenario creation has been accepted and is processing in the background.

message

string

Example:

"Graph scenario creation started"

scenario

object

Show child attributes

status

string

Example:

"processing"