BEbeyondwords
Rules

Preview rule audio

Changed on

Generates preview audio for a pronunciation rule without saving it.

post/rules/preview

Request

  • Base URL
    https://api.beyondwords.io/v1
  • URL
    https://api.beyondwords.io/v1/rules/preview
  • Auth
    API key in header X-Api-Key

Request body

type'substitute' | 'say_as_word' | 'say_as_letter_sequence' | 'ipa_transcription' | 'pinyin_transcription' | 'jyutping_transcription'

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

keystring

The exact text to match in content when previewing this rule

valuestring nullable

Replacement text or phonetic transcription (depending on rule type)

Response

successful

Changes