BEbeyondwords
Rules

Get rule

Returns a pronunciation rule from your organization.

get/rules/{id}

Request

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

Response

OK

idinteger

Unique identifier for the rule

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

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)

Changes

No recorded changes to this operation across all 2 revisions of this API.