A single-use token for a browser to talk to an agent in real time on a chat site

post/voice/live/sessions

A single-use token for a browser to talk to an agent in real time on a chat site: bound to the agent, the site and the page's origin, valid for one minute.

Before you call

Credential: Authorization: Bearer $KEY
Scope: voice:write
Graphql: Mutation.voiceLiveStart
Sdk: voice.live.start
Cli: voice live start

Request bodyapplication/json, required

agentIdstring (uuid)required
siteIdstringrequired
At most 120 characters.
originstringrequired
At most 200 characters.
languagestring
At most 20 characters.
maxMinutesinteger
At least 1. At most 60.

Responses

201application/json
Success
- tokenstringrequired
- urlstringrequired
- expiresAtstringrequired
- maxMinutesnumberrequired
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/voice/live/sessions' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "agentId": "string",
  "siteId": "string",
  "origin": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown