Coverage

Overview

This API endpoint allows you to determine which words are included in the Rime dictionary out of the box.

We can add new words to our dictionary as needed within around 24 hours. Or you can immediately generate a custom pronunciation, which uses the Rime phonetic alphabet.

If a word is not in our dictionary, our TTS model will still attempt a pronunciation, which is often suitable if the spelling follows typical linguistic patterns.

In addition to the API, you can also check coverage in the Rime dashboard.

Example

A request takes only the string text, for example:

curl -X POST https://beta.rime.ai/oov \
     -H 'Authorization: Bearer <authorization>' \
     -d '{"text": "This is just a testt. This, is, also, a, testtt"}';

The response will include an array with any strings not covered by the current Rime dictionary:

["testt","testtt"]

Variable Parameters

text

string

required

A string one or more words you’d like to check for coverage in our dictionary. Words can be separated by spaces, commas, or newlines.

cURL

curl --request POST \
  --url https://beta.rime.ai/oov \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "text": "<string>"
}'