Skip to main content
GET
List user pronunciation rules

Authorizations

X-Api-Key
string
header
required

Authenticate using X-Api-Key header

Query Parameters

model_id
string
required

Used only to resolve the provider; rules belong to the authenticated user.

voice_id
string
required

Used only to resolve the provider; rules belong to the authenticated user.

language
string

Used only to resolve the provider; rules belong to the authenticated user.

intervention_group_id
string

Select a group owned by the authenticated user. For GET, PATCH, and DELETE, omission selects default. For POST, query or body may select the group; both must match if supplied, and omission of both selects default. PATCH and DELETE verify that the rule belongs to this group. Opaque group ID owned by the authenticated user; default is the built-in group. Use the ID returned by group creation.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9_-]+$
Example:

"default"

match_type
enum<string>
Available options:
literal,
regex
action
enum<string>
Available options:
replace,
phoneme,
spellout
lang
string

Rule language filter; aliases normalize to en, fr, zh, zh-Hans, zh-Hant, or und.

status
enum<string>
Available options:
draft,
active,
inactive
q
string
Maximum string length: 1024
limit
integer
default:50
Required range: 1 <= x <= 500
offset
integer
default:0
Required range: x >= 0

Response

Success

total
integer
required
items
object[]
required