Skip to main content
POST
Create a new scenario

Authorizations

Authorization
string
header
required

API key from waterr.ai/settings?tab=api-keys. Send as Authorization: Bearer wai_<your_key>.

Body

application/json
name
string
required

Name of the scenario

type
enum<string>
required
Available options:
interview,
roleplay,
upskill,
brainstorm
persona_id
string
required

ID of the associated persona

description
string

Description of the scenario

prompt
string

Prompt for the scenario

user_prompt
string

Original user prompt entered on Create page

welcome_message
string

Optional first message shown when a participant enters.

data_model_id
string

ID of the associated data model (optional)

goals
string[]

Array of goal IDs to attach to the scenario.

Response

Scenario created successfully

id
string
name
string
description
string
prompt
string
type
string
persona_id
string
org_id
string