Skip to main content
POST
Create a scenario

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required
Required string length: 1 - 255
intent
string
required
Required string length: 1 - 500
journey
string
default:""
Maximum string length: 20000
source
enum<string>
default:manual
Available options:
manual,
drafted
source_brief
string | null
Maximum string length: 2000
source_agent_id
string<uuid> | null
source_persona_id
string<uuid> | null
tags
string[]
agent_ids
string<uuid>[]

Response

Successful Response

id
string<uuid>
required
organization_id
string<uuid>
required
name
string
required
intent
string
required
journey
string
required
source
enum<string>
required
Available options:
manual,
drafted
tags
string[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
source_brief
string | null
source_agent_id
string<uuid> | null
source_agent_name
string | null
source_persona_id
string<uuid> | null
source_persona_name
string | null
agents
ScenarioAgentRef · object[]
created_by
string | null