Skip to main content
POST
voice.call.speech.start

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
ref
string
required

The ref returned by voice.call.start-configured or a row of voice.calls.list.

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

Text spoken to the person, up to 1500 characters; may contain personal data.

Required string length: 1 - 1500
language
string
default:en-US

Speech language and region, such as en-US.

Pattern: ^[a-z]{2}-[A-Z]{2}$
style
integer
default:0

Voice style within the selected language, 0 to 20; default 0.

Required range: 0 <= x <= 20
premium
boolean
default:false

Explicitly request a premium voice; default false.

loop
integer
default:1

Play count, 1 to 10; default 1.

Required range: 1 <= x <= 10
level
number
default:0

Volume adjustment, -1 to 1 in steps of 0.1; default 0.

Required range: -1 <= x <= 1Must be a multiple of 0.1

Response

The result

confirmed
boolean
required

The operation was accepted.