Skip to main content
POST
/
scenario-studio
Create Scenario Studio session
curl --request POST \
  --url https://api.exec.com/rest/v1/scenario-studio \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_email": "[email protected]",
  "prompt": "Create a discovery call scenario for enterprise software sales with a skeptical IT director",
  "context_ids": [
    "a1b2c3d4e5f6"
  ],
  "request_id": "meeting-123-scenario"
}
'
{
  "id": "x9y8z7w6v5u4",
  "url": "https://acme-corp.app.exec.com/chat/x9y8z7w6v5u4",
  "is_new": true
}

Authorizations

​
Authorization
string
header
required

API key created in Settings > API.

Format: exec_live_ followed by 40 alphanumeric characters.

Body

application/json
​
user_email
string<email>
required

Email of the user to create the session for (must be a member of your workspace)

​
prompt
string
required

Meeting context or scenario request that will be sent to the AI agent

​
context_ids
string[]

Optional list of WorkspaceContext IDs to include as background context

​
request_id
string

Optional client-provided ID for deduplication. If provided and a session with this ID already exists, returns the existing session.

Response

Session created successfully

​
id
string

Session identifier (12-character hex string)

​
url
string<uri>

URL for the user to complete scenario creation

​
is_new
boolean

True if a new session was created, false if an existing session was returned via request_id