Skip to main content
POST
Change a Pages site's Page Chat settings

Body

application/json
site
string
required

Pages host slug, site id, or hostname

clearInstructions
boolean

Remove the extra instructions

clearName
boolean

Remove the assistant name

clearRaviAgent
boolean

Stop the text chat from asking a Ravi machine's agent

clearTextModel
boolean

Use the platform default text chat model

console
string

Console base URL

enabled
string

Turn the Page Chat voice agent on (true) or off (false) for this site

execute
boolean

Required with --enabled true, --text true, --reply-policy always and --ravi-agent; every other change applies immediately

instructions
string

Extra instructions for the agent (max 2000 chars)

language
string

Spoken language as a BCP 47 tag, such as pt-BR

name
string

Assistant name the agent uses (max 60 chars)

project
string

Console project id or slug; overrides saved Console scope

raviAgent
string

Agent of a Ravi machine the text chat may ask (installation id from ravi agents directory --json)

replyPolicy
string

When the agent answers in a shared room: mention|always

text
string

Turn the text chat (bar panel and ) on (true) or off (false)

textModel
string

Text chat model, an AI Gateway id such as /

voice
string

Voice: bossa|tempo|marin|quartz|ripple|vesper|willow|stone|gleam|meridian|beacon|delta|cinder

Response

Success — body conforms to the @Returns schema.

changed
enum<string>[]
required
Available options:
enabled,
assistantName,
voice,
language,
instructions
consoleUrl
string
required
featureEnabled
boolean
required
host
string | null
required
projectRef
string
required
settings
object
required
siteId
string | null
required
siteRef
string
required
success
boolean
required
voices
string[]
required