Skip to main content
POST
Preview rule audio

Authorizations

X-Api-Key
string
header
required

Body

application/json
type
enum<string>

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

Available options:
substitute,
say_as_word,
say_as_letter_sequence,
ipa_transcription,
pinyin_transcription,
jyutping_transcription
key
string

The exact text to match in content when previewing this rule

value
string | null

Replacement text or phonetic transcription (depending on rule type)

project
object | null
content
object | null
language
object | null
preview_voice
object | null

Response

200

successful