Skip to main content
POST
voice.assistant.create-configured

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
name
string
required

Your unique name for this configuration, up to 40 letters, digits, underscores or hyphens.

Required string length: 1 - 40
Pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$
prompt
string
required

Speaking instructions; may contain personal data.

Required string length: 1 - 10000
voiceRef
string

The ref returned by audio.voices.list; selection is not available yet.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
knowledgeBaseRef
string

The ref returned by voice.knowledge-bases.list; use a ready, paid base belonging to you.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
behavior
object

Optional typed speaking graph; connections and external tools need separate support.

greeting
string
default:""

First spoken sentence; empty clears it.

Maximum string length: 1000
language
enum<string>
default:en

Speech recognition language.

Available options:
en,
es,
fr,
de,
it,
pt,
hi,
ja,
zh
voice
enum<string>
default:default

Speaking voice; availability varies by source.

Available options:
default,
female-1,
female-2,
female-3,
male-1,
male-2,
male-3
maxDurationSeconds
integer
default:120

Maximum call length, 10 to 600 seconds.

Required range: 10 <= x <= 600
interruptionSensitivity
number

Fraction from 0 to 1; larger values permit easier interruption. Not a word count.

Required range: 0 <= x <= 1
interruptibility
integer

Interruption level: 0 blocks, 1 difficult, 2 balanced, 3 easy, 4 every utterance. Not a word count.

Required range: 0 <= x <= 4
activate
boolean
default:false

Publish this configuration for use when true; saving alone leaves a draft.

Response

The result

name
string
required

Your unique name for this configuration, up to 40 letters, digits, underscores or hyphens.

Required string length: 1 - 40
Pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$
active
boolean
required

Whether the current saved revision is published for use.

configuration
object
required

Current saved speaking configuration; prompts may contain personal data.

revision
integer

Saved configuration revision.

Required range: 0 <= x <= 9007199254740991