Coverage

Coverage endpoint: check which input words are not yet in Rime’s pronunciation dictionary.

cURL

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

import requests

url = "https://users.rime.ai/oov"

payload = {
    "text": "<string>"
}
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer <authorization>",
    "Content-Type": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer <authorization>',
    'Content-Type': 'application/json'
  },
  body: '{"text":"<string>"}'
};

fetch('https://users.rime.ai/oov', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://users.rime.ai/oov",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n  \"text\": \"<string>\"\n}",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://users.rime.ai/oov"

  payload := strings.NewReader("{\n  \"text\": \"<string>\"\n}")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer <authorization>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://users.rime.ai/oov")
  .header("Accept", "application/json")
  .header("Authorization", "Bearer <authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"text\": \"<string>\"\n}")
  .asString();

200 — words not in dictionary

["testt", "testtt"]

[]

All requests require authentication with a bearer token in the Authorization header: Authorization: Bearer YOUR_API_KEY. See API authentication for how to create a key.

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 in about a week — reach out to your account manager via Slack or email, or contact [e-mail], if you need faster turnaround or have an SLA. Or you can immediately generate a custom pronunciation, which uses the Rime phonetic alphabet — write it by hand, or create one from a recording with the Phonemize API.

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.

Example

A request takes only the string text, for example:

curl -X POST https://users.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://users.rime.ai/oov \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --fail \
  --data '{
  "text": "<string>"
}'

import requests

url = "https://users.rime.ai/oov"

payload = {
    "text": "<string>"
}
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer <authorization>",
    "Content-Type": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer <authorization>',
    'Content-Type': 'application/json'
  },
  body: '{"text":"<string>"}'
};

fetch('https://users.rime.ai/oov', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://users.rime.ai/oov",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n  \"text\": \"<string>\"\n}",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://users.rime.ai/oov"

  payload := strings.NewReader("{\n  \"text\": \"<string>\"\n}")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer <authorization>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://users.rime.ai/oov")
  .header("Accept", "application/json")
  .header("Authorization", "Bearer <authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"text\": \"<string>\"\n}")
  .asString();

200 — words not in dictionary

["testt", "testtt"]

[]