Praecise Platform
Menu

Rivier/ Reference/ voice

A real-time voice session your platform configures with no agent

post/voice/platform/sessions

A real-time voice session your platform configures with no agent: converse on your own instruction, interpret between two languages, or only transcribe; a live route, a catalogue voice, tools answered in the browser or posted signed to your server, your own metadata. Answers a single-use token bound to that configuration and one page origin, valid one minute; the same idempotency key answers the same session until it starts.

Before you call

Credential
Authorization: Bearer $KEY
Scope
voice:write
Graphql
Mutation.voicePlatformSessionStart
Sdk
voice.platformSession.start
Cli
voice platform session start
Events
voice.session.usage, voice.session.ended

Request bodyapplication/json, required

  • kindstringrequired
    One of: converse, translate, transcribe.
  • routestring
    A live route: live or live-thinking Default: live.
  • instructionstring
    What the voice is and does (converse); added guidance (translate, transcribe) Default: . At most 8000 characters.
  • voicestring
    A voice id from GET /voice/catalogue Default: Kore.
  • languagestring
    The language spoken (converse, transcribe) Pattern: ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})?$.
  • languageslist of values
    The two languages an interpreter goes between (translate)
  • wordslist of string
    Names and terms to say and write as given Default: [].
  • textOutboolean
    Send the words heard and said to the browser as text Default: true.
  • keepWordsboolean
    Keep the words after the session (never the sound); erasable by session or metadata Default: false.
  • toolslist of object
    Default: [].
    • namestringrequired
      Pattern: ^[a-zA-Z_][a-zA-Z0-9_]{0,63}$.
    • descriptionstringrequired
      At most 1000 characters.
    • parametersobject
      Default: {"type":"object","properties":{}}.
    • answeredBystringrequired
      browser: the page answers inside the session; server: Rivier posts it, signed, to url One of: browser, server.
    • urlstring (uri)
      At most 500 characters.
    • timeoutMsinteger
      Default: 5000. At least 500. At most 10000.
  • maxMinutesinteger
    Default: 15. At least 1. At most 60.
  • originstringrequired
    The page's origin the browser connects from At most 200 characters.
  • metadataobject
    Default: {}.
  • idempotencyKeystringrequired
    At most 200 characters.

Responses

  • 201application/json
    Success
    • 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

    This page as Markdown