Skip to main content
POST
Create scenario

Body

application/json
name
string
required

Folder name, unique among its siblings. Creating a folder that already exists returns the existing one.

Required string length: 1 - 100
parentScenarioShortId
string

Nest the new folder inside this one. Omit to create it at the root.

Pattern: ^scenario(-.+_.+|_.+)$
projectShortId
string

Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.

Pattern: ^proj(-.+_.+|_.+)$

Response

200 - application/json

The request has succeeded.

success
boolean
required
scenario
object
required