Skip to main content
POST
audio.pronunciation-dictionary.update

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 audio.pronunciation-dictionary.create, clone or audio.pronunciation-dictionaries.list.

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

Replacement name.

Required string length: 1 - 200
addTerms
object[]

Up to 1,000 substitutions.

Maximum array length: 1000
removeTerms
string[]

Keys to remove.

Maximum array length: 1000
Required string length: 1 - 100

Response

The result

name
string
required

Dictionary name.

size
integer
required

Number of terms stored.

Required range: 0 <= x <= 9007199254740991
terms
object[]

Substitutions, when the source includes them.

createdAt
string

Creation time, ISO 8601 UTC.

updatedAt
string

Last change, ISO 8601 UTC.