Skip to main content
POST
Create Scenario Set

Authorizations

X-API-KEY
string
header
required

Your API key for authentication.

x-org-id
string
header
required

Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.

Body

application/json
name
string
required

Name of the scenario set

Example:

"Flight Cancellation Tests"

description
string | null

Description of the scenario set

Example:

"Collection of test scenarios for flight cancellation workflows"

Response

Successful Response

A scenario set that groups simulation scenarios together

_id
string
required
account_id
string
required

Account ID that owns this scenario set

name
string
required

Name of the scenario set

history
HistoryModel · object
required
description
string | null

Description of the scenario set

simulation_scenario_count
integer
default:0

Number of simulation scenarios in this set