Update a scenario
curl --request PUT \
--url https://api.waterr.ai/v1/scenarios/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"prompt": "<string>",
"user_prompt": "<string>",
"welcome_message": "<string>",
"persona_id": "<string>",
"data_model_id": "<string>",
"goals": [
"<string>"
],
"webhook_url": "<string>",
"redirect_url": "<string>",
"language": "<string>",
"maxDuration": 123,
"max_participants": 123,
"allow_screen_share": true,
"allow_participant_video": true,
"allow_participant_audio": true,
"allow_recording": true,
"allow_transcription": true,
"allow_chat": true,
"allow_live_vision": true,
"allow_web_search": true,
"use_gpt_vision": true,
"deep_think": true,
"auto_analysis": true,
"waiting_room_enabled": true,
"auto_admit": true,
"end_call_enabled": true,
"prejoin_camera_on": true,
"eager_bot_join": true,
"consent_required": true,
"consent_message": "<string>",
"use_own_keys": true,
"controls": {}
}
'import requests
url = "https://api.waterr.ai/v1/scenarios/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"prompt": "<string>",
"user_prompt": "<string>",
"welcome_message": "<string>",
"persona_id": "<string>",
"data_model_id": "<string>",
"goals": ["<string>"],
"webhook_url": "<string>",
"redirect_url": "<string>",
"language": "<string>",
"maxDuration": 123,
"max_participants": 123,
"allow_screen_share": True,
"allow_participant_video": True,
"allow_participant_audio": True,
"allow_recording": True,
"allow_transcription": True,
"allow_chat": True,
"allow_live_vision": True,
"allow_web_search": True,
"use_gpt_vision": True,
"deep_think": True,
"auto_analysis": True,
"waiting_room_enabled": True,
"auto_admit": True,
"end_call_enabled": True,
"prejoin_camera_on": True,
"eager_bot_join": True,
"consent_required": True,
"consent_message": "<string>",
"use_own_keys": True,
"controls": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
prompt: '<string>',
user_prompt: '<string>',
welcome_message: '<string>',
persona_id: '<string>',
data_model_id: '<string>',
goals: ['<string>'],
webhook_url: '<string>',
redirect_url: '<string>',
language: '<string>',
maxDuration: 123,
max_participants: 123,
allow_screen_share: true,
allow_participant_video: true,
allow_participant_audio: true,
allow_recording: true,
allow_transcription: true,
allow_chat: true,
allow_live_vision: true,
allow_web_search: true,
use_gpt_vision: true,
deep_think: true,
auto_analysis: true,
waiting_room_enabled: true,
auto_admit: true,
end_call_enabled: true,
prejoin_camera_on: true,
eager_bot_join: true,
consent_required: true,
consent_message: '<string>',
use_own_keys: true,
controls: {}
})
};
fetch('https://api.waterr.ai/v1/scenarios/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.waterr.ai/v1/scenarios/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'prompt' => '<string>',
'user_prompt' => '<string>',
'welcome_message' => '<string>',
'persona_id' => '<string>',
'data_model_id' => '<string>',
'goals' => [
'<string>'
],
'webhook_url' => '<string>',
'redirect_url' => '<string>',
'language' => '<string>',
'maxDuration' => 123,
'max_participants' => 123,
'allow_screen_share' => true,
'allow_participant_video' => true,
'allow_participant_audio' => true,
'allow_recording' => true,
'allow_transcription' => true,
'allow_chat' => true,
'allow_live_vision' => true,
'allow_web_search' => true,
'use_gpt_vision' => true,
'deep_think' => true,
'auto_analysis' => true,
'waiting_room_enabled' => true,
'auto_admit' => true,
'end_call_enabled' => true,
'prejoin_camera_on' => true,
'eager_bot_join' => true,
'consent_required' => true,
'consent_message' => '<string>',
'use_own_keys' => true,
'controls' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.waterr.ai/v1/scenarios/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"user_prompt\": \"<string>\",\n \"welcome_message\": \"<string>\",\n \"persona_id\": \"<string>\",\n \"data_model_id\": \"<string>\",\n \"goals\": [\n \"<string>\"\n ],\n \"webhook_url\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"language\": \"<string>\",\n \"maxDuration\": 123,\n \"max_participants\": 123,\n \"allow_screen_share\": true,\n \"allow_participant_video\": true,\n \"allow_participant_audio\": true,\n \"allow_recording\": true,\n \"allow_transcription\": true,\n \"allow_chat\": true,\n \"allow_live_vision\": true,\n \"allow_web_search\": true,\n \"use_gpt_vision\": true,\n \"deep_think\": true,\n \"auto_analysis\": true,\n \"waiting_room_enabled\": true,\n \"auto_admit\": true,\n \"end_call_enabled\": true,\n \"prejoin_camera_on\": true,\n \"eager_bot_join\": true,\n \"consent_required\": true,\n \"consent_message\": \"<string>\",\n \"use_own_keys\": true,\n \"controls\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.waterr.ai/v1/scenarios/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"user_prompt\": \"<string>\",\n \"welcome_message\": \"<string>\",\n \"persona_id\": \"<string>\",\n \"data_model_id\": \"<string>\",\n \"goals\": [\n \"<string>\"\n ],\n \"webhook_url\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"language\": \"<string>\",\n \"maxDuration\": 123,\n \"max_participants\": 123,\n \"allow_screen_share\": true,\n \"allow_participant_video\": true,\n \"allow_participant_audio\": true,\n \"allow_recording\": true,\n \"allow_transcription\": true,\n \"allow_chat\": true,\n \"allow_live_vision\": true,\n \"allow_web_search\": true,\n \"use_gpt_vision\": true,\n \"deep_think\": true,\n \"auto_analysis\": true,\n \"waiting_room_enabled\": true,\n \"auto_admit\": true,\n \"end_call_enabled\": true,\n \"prejoin_camera_on\": true,\n \"eager_bot_join\": true,\n \"consent_required\": true,\n \"consent_message\": \"<string>\",\n \"use_own_keys\": true,\n \"controls\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.waterr.ai/v1/scenarios/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"user_prompt\": \"<string>\",\n \"welcome_message\": \"<string>\",\n \"persona_id\": \"<string>\",\n \"data_model_id\": \"<string>\",\n \"goals\": [\n \"<string>\"\n ],\n \"webhook_url\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"language\": \"<string>\",\n \"maxDuration\": 123,\n \"max_participants\": 123,\n \"allow_screen_share\": true,\n \"allow_participant_video\": true,\n \"allow_participant_audio\": true,\n \"allow_recording\": true,\n \"allow_transcription\": true,\n \"allow_chat\": true,\n \"allow_live_vision\": true,\n \"allow_web_search\": true,\n \"use_gpt_vision\": true,\n \"deep_think\": true,\n \"auto_analysis\": true,\n \"waiting_room_enabled\": true,\n \"auto_admit\": true,\n \"end_call_enabled\": true,\n \"prejoin_camera_on\": true,\n \"eager_bot_join\": true,\n \"consent_required\": true,\n \"consent_message\": \"<string>\",\n \"use_own_keys\": true,\n \"controls\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"prompt": "<string>",
"user_prompt": "<string>",
"persona_id": "<string>",
"org_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Scenarios
Update a scenario
PUT
/
scenarios
/
{id}
Update a scenario
curl --request PUT \
--url https://api.waterr.ai/v1/scenarios/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"prompt": "<string>",
"user_prompt": "<string>",
"welcome_message": "<string>",
"persona_id": "<string>",
"data_model_id": "<string>",
"goals": [
"<string>"
],
"webhook_url": "<string>",
"redirect_url": "<string>",
"language": "<string>",
"maxDuration": 123,
"max_participants": 123,
"allow_screen_share": true,
"allow_participant_video": true,
"allow_participant_audio": true,
"allow_recording": true,
"allow_transcription": true,
"allow_chat": true,
"allow_live_vision": true,
"allow_web_search": true,
"use_gpt_vision": true,
"deep_think": true,
"auto_analysis": true,
"waiting_room_enabled": true,
"auto_admit": true,
"end_call_enabled": true,
"prejoin_camera_on": true,
"eager_bot_join": true,
"consent_required": true,
"consent_message": "<string>",
"use_own_keys": true,
"controls": {}
}
'import requests
url = "https://api.waterr.ai/v1/scenarios/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"prompt": "<string>",
"user_prompt": "<string>",
"welcome_message": "<string>",
"persona_id": "<string>",
"data_model_id": "<string>",
"goals": ["<string>"],
"webhook_url": "<string>",
"redirect_url": "<string>",
"language": "<string>",
"maxDuration": 123,
"max_participants": 123,
"allow_screen_share": True,
"allow_participant_video": True,
"allow_participant_audio": True,
"allow_recording": True,
"allow_transcription": True,
"allow_chat": True,
"allow_live_vision": True,
"allow_web_search": True,
"use_gpt_vision": True,
"deep_think": True,
"auto_analysis": True,
"waiting_room_enabled": True,
"auto_admit": True,
"end_call_enabled": True,
"prejoin_camera_on": True,
"eager_bot_join": True,
"consent_required": True,
"consent_message": "<string>",
"use_own_keys": True,
"controls": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
prompt: '<string>',
user_prompt: '<string>',
welcome_message: '<string>',
persona_id: '<string>',
data_model_id: '<string>',
goals: ['<string>'],
webhook_url: '<string>',
redirect_url: '<string>',
language: '<string>',
maxDuration: 123,
max_participants: 123,
allow_screen_share: true,
allow_participant_video: true,
allow_participant_audio: true,
allow_recording: true,
allow_transcription: true,
allow_chat: true,
allow_live_vision: true,
allow_web_search: true,
use_gpt_vision: true,
deep_think: true,
auto_analysis: true,
waiting_room_enabled: true,
auto_admit: true,
end_call_enabled: true,
prejoin_camera_on: true,
eager_bot_join: true,
consent_required: true,
consent_message: '<string>',
use_own_keys: true,
controls: {}
})
};
fetch('https://api.waterr.ai/v1/scenarios/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.waterr.ai/v1/scenarios/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'prompt' => '<string>',
'user_prompt' => '<string>',
'welcome_message' => '<string>',
'persona_id' => '<string>',
'data_model_id' => '<string>',
'goals' => [
'<string>'
],
'webhook_url' => '<string>',
'redirect_url' => '<string>',
'language' => '<string>',
'maxDuration' => 123,
'max_participants' => 123,
'allow_screen_share' => true,
'allow_participant_video' => true,
'allow_participant_audio' => true,
'allow_recording' => true,
'allow_transcription' => true,
'allow_chat' => true,
'allow_live_vision' => true,
'allow_web_search' => true,
'use_gpt_vision' => true,
'deep_think' => true,
'auto_analysis' => true,
'waiting_room_enabled' => true,
'auto_admit' => true,
'end_call_enabled' => true,
'prejoin_camera_on' => true,
'eager_bot_join' => true,
'consent_required' => true,
'consent_message' => '<string>',
'use_own_keys' => true,
'controls' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.waterr.ai/v1/scenarios/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"user_prompt\": \"<string>\",\n \"welcome_message\": \"<string>\",\n \"persona_id\": \"<string>\",\n \"data_model_id\": \"<string>\",\n \"goals\": [\n \"<string>\"\n ],\n \"webhook_url\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"language\": \"<string>\",\n \"maxDuration\": 123,\n \"max_participants\": 123,\n \"allow_screen_share\": true,\n \"allow_participant_video\": true,\n \"allow_participant_audio\": true,\n \"allow_recording\": true,\n \"allow_transcription\": true,\n \"allow_chat\": true,\n \"allow_live_vision\": true,\n \"allow_web_search\": true,\n \"use_gpt_vision\": true,\n \"deep_think\": true,\n \"auto_analysis\": true,\n \"waiting_room_enabled\": true,\n \"auto_admit\": true,\n \"end_call_enabled\": true,\n \"prejoin_camera_on\": true,\n \"eager_bot_join\": true,\n \"consent_required\": true,\n \"consent_message\": \"<string>\",\n \"use_own_keys\": true,\n \"controls\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.waterr.ai/v1/scenarios/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"user_prompt\": \"<string>\",\n \"welcome_message\": \"<string>\",\n \"persona_id\": \"<string>\",\n \"data_model_id\": \"<string>\",\n \"goals\": [\n \"<string>\"\n ],\n \"webhook_url\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"language\": \"<string>\",\n \"maxDuration\": 123,\n \"max_participants\": 123,\n \"allow_screen_share\": true,\n \"allow_participant_video\": true,\n \"allow_participant_audio\": true,\n \"allow_recording\": true,\n \"allow_transcription\": true,\n \"allow_chat\": true,\n \"allow_live_vision\": true,\n \"allow_web_search\": true,\n \"use_gpt_vision\": true,\n \"deep_think\": true,\n \"auto_analysis\": true,\n \"waiting_room_enabled\": true,\n \"auto_admit\": true,\n \"end_call_enabled\": true,\n \"prejoin_camera_on\": true,\n \"eager_bot_join\": true,\n \"consent_required\": true,\n \"consent_message\": \"<string>\",\n \"use_own_keys\": true,\n \"controls\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.waterr.ai/v1/scenarios/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"user_prompt\": \"<string>\",\n \"welcome_message\": \"<string>\",\n \"persona_id\": \"<string>\",\n \"data_model_id\": \"<string>\",\n \"goals\": [\n \"<string>\"\n ],\n \"webhook_url\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"language\": \"<string>\",\n \"maxDuration\": 123,\n \"max_participants\": 123,\n \"allow_screen_share\": true,\n \"allow_participant_video\": true,\n \"allow_participant_audio\": true,\n \"allow_recording\": true,\n \"allow_transcription\": true,\n \"allow_chat\": true,\n \"allow_live_vision\": true,\n \"allow_web_search\": true,\n \"use_gpt_vision\": true,\n \"deep_think\": true,\n \"auto_analysis\": true,\n \"waiting_room_enabled\": true,\n \"auto_admit\": true,\n \"end_call_enabled\": true,\n \"prejoin_camera_on\": true,\n \"eager_bot_join\": true,\n \"consent_required\": true,\n \"consent_message\": \"<string>\",\n \"use_own_keys\": true,\n \"controls\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"prompt": "<string>",
"user_prompt": "<string>",
"persona_id": "<string>",
"org_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Authorizations
API key from waterr.ai/settings?tab=api-keys. Send as Authorization: Bearer wai_<your_key>.
Path Parameters
Body
application/json
Maximum string length:
100Original user prompt entered on Create page
Available options:
interview, roleplay, upskill, brainstorm ID of the associated data model (optional)
Available options:
public, restricted BCP-47 language tag biasing STT/TTS for the session.
Maximum session duration in minutes.
Free-form per-scenario control overrides (camera, mic, share, etc.).
⌘I

