Skip to main content
POST
Create a new meeting

Authorizations

Authorization
string
header
required

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

Body

application/json
person_name
string
required

Name of the participant joining the session. The agent greets and addresses them by it, and it labels the call in transcripts, analyses and memory. If you don't know who will join yet, send "Guest".

scenario_id
string
required

UUID of the scenario to use. The scenario must exist or the request is rejected with 404.

email
string

The participant's email. Fills {{USER_EMAIL}} / {userEmail} in the prompt and welcome message.

Maximum string length: 254
meeting_title
string

Title for this call in meeting lists and analyses. Defaults to the scenario name.

Maximum string length: 200
meeting_duration_minutes
integer

Length of this call. Anyone can shorten it; only your own workspace can run its scenarios past their saved length. Your plan's call cap still applies.

Required range: 1 <= x <= 240
voice_id
string

Optional override for the persona's voice.

meeting_type
enum<string>

Defaults to "regular".

Available options:
regular,
instant
note_context
string

Session-specific context injected into the AI prompt without modifying the scenario.

system_prompt
string

Replaces the scenario's prompt for this call only; the saved scenario is not changed. Persona, voice, knowledge base, tools and other settings still apply, and note_context is still added on top. Plain text or POML. Your own workspace's scenarios only (403 otherwise).

Maximum string length: 65536
welcome_message
string

The agent's first line for this call. Your own workspace's scenarios only.

Maximum string length: 2000
language
string

The call's language; the voice follows it. Your own workspace's scenarios only.

Example:

"Hindi"

bot_persona
string

The name the agent goes by in this call. Your own workspace's scenarios only.

Maximum string length: 80
controls
object

Overrides the scenario's meeting settings for this call. Only the keys you send change; unknown keys are rejected. A capability your plan doesn't include is switched off. Your own workspace's scenarios only.

custom_agent
object

Bring-your-own-agent endpoint for this call. Your own workspace's scenarios only.

end_user_id
string

For end-user sessions; pairs the meeting with an existing end_user membership.

user_memory_tag
string

The memory container this call reads at start and adds to at end, when the scenario has memory on. Defaults to the participant's own identity.

Maximum string length: 128

Response

Meeting created successfully