curl --request POST \
--url http://localhost:3000/api/v1/pages/chat/set \
--header 'Content-Type: application/json' \
--data '
{
"site": "<string>",
"clearInstructions": true,
"clearName": true,
"clearRaviAgent": true,
"clearTextModel": true,
"console": "<string>",
"enabled": "<string>",
"execute": true,
"instructions": "<string>",
"language": "<string>",
"name": "<string>",
"project": "<string>",
"raviAgent": "<string>",
"replyPolicy": "<string>",
"text": "<string>",
"textModel": "<string>",
"voice": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/pages/chat/set"
payload = {
"site": "<string>",
"clearInstructions": True,
"clearName": True,
"clearRaviAgent": True,
"clearTextModel": True,
"console": "<string>",
"enabled": "<string>",
"execute": True,
"instructions": "<string>",
"language": "<string>",
"name": "<string>",
"project": "<string>",
"raviAgent": "<string>",
"replyPolicy": "<string>",
"text": "<string>",
"textModel": "<string>",
"voice": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
site: '<string>',
clearInstructions: true,
clearName: true,
clearRaviAgent: true,
clearTextModel: true,
console: '<string>',
enabled: '<string>',
execute: true,
instructions: '<string>',
language: '<string>',
name: '<string>',
project: '<string>',
raviAgent: '<string>',
replyPolicy: '<string>',
text: '<string>',
textModel: '<string>',
voice: '<string>'
})
};
fetch('http://localhost:3000/api/v1/pages/chat/set', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/pages/chat/set",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'site' => '<string>',
'clearInstructions' => true,
'clearName' => true,
'clearRaviAgent' => true,
'clearTextModel' => true,
'console' => '<string>',
'enabled' => '<string>',
'execute' => true,
'instructions' => '<string>',
'language' => '<string>',
'name' => '<string>',
'project' => '<string>',
'raviAgent' => '<string>',
'replyPolicy' => '<string>',
'text' => '<string>',
'textModel' => '<string>',
'voice' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:3000/api/v1/pages/chat/set"
payload := strings.NewReader("{\n \"site\": \"<string>\",\n \"clearInstructions\": true,\n \"clearName\": true,\n \"clearRaviAgent\": true,\n \"clearTextModel\": true,\n \"console\": \"<string>\",\n \"enabled\": \"<string>\",\n \"execute\": true,\n \"instructions\": \"<string>\",\n \"language\": \"<string>\",\n \"name\": \"<string>\",\n \"project\": \"<string>\",\n \"raviAgent\": \"<string>\",\n \"replyPolicy\": \"<string>\",\n \"text\": \"<string>\",\n \"textModel\": \"<string>\",\n \"voice\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("http://localhost:3000/api/v1/pages/chat/set")
.header("Content-Type", "application/json")
.body("{\n \"site\": \"<string>\",\n \"clearInstructions\": true,\n \"clearName\": true,\n \"clearRaviAgent\": true,\n \"clearTextModel\": true,\n \"console\": \"<string>\",\n \"enabled\": \"<string>\",\n \"execute\": true,\n \"instructions\": \"<string>\",\n \"language\": \"<string>\",\n \"name\": \"<string>\",\n \"project\": \"<string>\",\n \"raviAgent\": \"<string>\",\n \"replyPolicy\": \"<string>\",\n \"text\": \"<string>\",\n \"textModel\": \"<string>\",\n \"voice\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/pages/chat/set")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"site\": \"<string>\",\n \"clearInstructions\": true,\n \"clearName\": true,\n \"clearRaviAgent\": true,\n \"clearTextModel\": true,\n \"console\": \"<string>\",\n \"enabled\": \"<string>\",\n \"execute\": true,\n \"instructions\": \"<string>\",\n \"language\": \"<string>\",\n \"name\": \"<string>\",\n \"project\": \"<string>\",\n \"raviAgent\": \"<string>\",\n \"replyPolicy\": \"<string>\",\n \"text\": \"<string>\",\n \"textModel\": \"<string>\",\n \"voice\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changed": [
"enabled"
],
"consoleUrl": "<string>",
"featureEnabled": true,
"host": "<string>",
"projectRef": "<string>",
"settings": {
"assistantName": "<string>",
"enabled": true,
"instructions": "<string>",
"language": "<string>",
"voice": "<string>"
},
"siteId": "<string>",
"siteRef": "<string>",
"success": true,
"voices": [
"<string>"
]
}Change a Pages site's Page Chat settings
curl --request POST \
--url http://localhost:3000/api/v1/pages/chat/set \
--header 'Content-Type: application/json' \
--data '
{
"site": "<string>",
"clearInstructions": true,
"clearName": true,
"clearRaviAgent": true,
"clearTextModel": true,
"console": "<string>",
"enabled": "<string>",
"execute": true,
"instructions": "<string>",
"language": "<string>",
"name": "<string>",
"project": "<string>",
"raviAgent": "<string>",
"replyPolicy": "<string>",
"text": "<string>",
"textModel": "<string>",
"voice": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/pages/chat/set"
payload = {
"site": "<string>",
"clearInstructions": True,
"clearName": True,
"clearRaviAgent": True,
"clearTextModel": True,
"console": "<string>",
"enabled": "<string>",
"execute": True,
"instructions": "<string>",
"language": "<string>",
"name": "<string>",
"project": "<string>",
"raviAgent": "<string>",
"replyPolicy": "<string>",
"text": "<string>",
"textModel": "<string>",
"voice": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
site: '<string>',
clearInstructions: true,
clearName: true,
clearRaviAgent: true,
clearTextModel: true,
console: '<string>',
enabled: '<string>',
execute: true,
instructions: '<string>',
language: '<string>',
name: '<string>',
project: '<string>',
raviAgent: '<string>',
replyPolicy: '<string>',
text: '<string>',
textModel: '<string>',
voice: '<string>'
})
};
fetch('http://localhost:3000/api/v1/pages/chat/set', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/pages/chat/set",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'site' => '<string>',
'clearInstructions' => true,
'clearName' => true,
'clearRaviAgent' => true,
'clearTextModel' => true,
'console' => '<string>',
'enabled' => '<string>',
'execute' => true,
'instructions' => '<string>',
'language' => '<string>',
'name' => '<string>',
'project' => '<string>',
'raviAgent' => '<string>',
'replyPolicy' => '<string>',
'text' => '<string>',
'textModel' => '<string>',
'voice' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:3000/api/v1/pages/chat/set"
payload := strings.NewReader("{\n \"site\": \"<string>\",\n \"clearInstructions\": true,\n \"clearName\": true,\n \"clearRaviAgent\": true,\n \"clearTextModel\": true,\n \"console\": \"<string>\",\n \"enabled\": \"<string>\",\n \"execute\": true,\n \"instructions\": \"<string>\",\n \"language\": \"<string>\",\n \"name\": \"<string>\",\n \"project\": \"<string>\",\n \"raviAgent\": \"<string>\",\n \"replyPolicy\": \"<string>\",\n \"text\": \"<string>\",\n \"textModel\": \"<string>\",\n \"voice\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("http://localhost:3000/api/v1/pages/chat/set")
.header("Content-Type", "application/json")
.body("{\n \"site\": \"<string>\",\n \"clearInstructions\": true,\n \"clearName\": true,\n \"clearRaviAgent\": true,\n \"clearTextModel\": true,\n \"console\": \"<string>\",\n \"enabled\": \"<string>\",\n \"execute\": true,\n \"instructions\": \"<string>\",\n \"language\": \"<string>\",\n \"name\": \"<string>\",\n \"project\": \"<string>\",\n \"raviAgent\": \"<string>\",\n \"replyPolicy\": \"<string>\",\n \"text\": \"<string>\",\n \"textModel\": \"<string>\",\n \"voice\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/pages/chat/set")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"site\": \"<string>\",\n \"clearInstructions\": true,\n \"clearName\": true,\n \"clearRaviAgent\": true,\n \"clearTextModel\": true,\n \"console\": \"<string>\",\n \"enabled\": \"<string>\",\n \"execute\": true,\n \"instructions\": \"<string>\",\n \"language\": \"<string>\",\n \"name\": \"<string>\",\n \"project\": \"<string>\",\n \"raviAgent\": \"<string>\",\n \"replyPolicy\": \"<string>\",\n \"text\": \"<string>\",\n \"textModel\": \"<string>\",\n \"voice\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changed": [
"enabled"
],
"consoleUrl": "<string>",
"featureEnabled": true,
"host": "<string>",
"projectRef": "<string>",
"settings": {
"assistantName": "<string>",
"enabled": true,
"instructions": "<string>",
"language": "<string>",
"voice": "<string>"
},
"siteId": "<string>",
"siteRef": "<string>",
"success": true,
"voices": [
"<string>"
]
}Body
Pages host slug, site id, or hostname
Remove the extra instructions
Remove the assistant name
Stop the text chat from asking a Ravi machine's agent
Use the platform default text chat model
Console base URL
Turn the Page Chat voice agent on (true) or off (false) for this site
Required with --enabled true, --text true, --reply-policy always and --ravi-agent; every other change applies immediately
Extra instructions for the agent (max 2000 chars)
Spoken language as a BCP 47 tag, such as pt-BR
Assistant name the agent uses (max 60 chars)
Console project id or slug; overrides saved Console scope
Agent of a Ravi machine the text chat may ask (installation id from ravi agents directory --json)
When the agent answers in a shared room: mention|always
Turn the text chat (bar panel and ) on (true) or off (false)
Text chat model, an AI Gateway id such as /
Voice: bossa|tempo|marin|quartz|ripple|vesper|willow|stone|gleam|meridian|beacon|delta|cinder
Response
Success — body conforms to the @Returns schema.
enabled, assistantName, voice, language, instructions Show child attributes
Show child attributes