v1

latestOpenAPI 3.0.12026-07-2210997354.2 KB

Rules

List rules

Lists pronunciation rules in your organization.

get/rules

Query parameters

pagination[limit]integer

'limit' sets the number of results to return in each page.

pagination[offset]integer

'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result.

order[by]'type' | 'key' | 'value' | 'created'

This is used to order rules by type or key or value

order[dir]'asc' | 'desc'

This is used to order analytics in the ascending or descending order

filter[type]string

filter by rule type

filter[preview_status]string

filter by rule preview status

filter[key]string

filter by rule key

filter[scopes]object

filter items by scopes

filter[languages][]string[]

filter by languages

filter[voices][]integer[]

filter by voices

Response

idinteger

Unique identifier for the rule

The rule type. Possible values are substitute, say_as_word, say_as_letter_sequence, ipa_transcription, pinyin_transcription, jyutping_transcription. Please note that not all voices support all rules

preview_status'processing' | 'processed' | 'error'

Status of preview generation for this rule

keystring

The exact text to match in content when applying this rule

valuestring nullable

Replacement text or phonetic transcription (depending on rule type)

magic_ipa_usedboolean

When true, the Magic IPA feature was used to generate the transcription

createdstring

Time at which the object was created (ISO 8601)

updatedstring

Time at which the object was updated (ISO 8601)