Text Normalization

Return the grammar normalizer’s output for an input string.

cURL

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

200

{
  "normalized": "one two three four, one, two, three, four, one, eight hundred, four four four, four one four one"
}

The Rime API authenticates every request with a bearer token in the Authorization header: Authorization: Bearer YOUR_API_KEY. See API authentication for how to create a key.

Overview

This endpoint returns the grammar normalizer’s output for an input string. Use it to preview how numbers, phone numbers, dates, and other non-standard words will be spoken, or to debug an unexpected pronunciation. The output matches Coda’s normalization. Mist v3 can group spell() sequences differently.

Defaults to English. Pass the lang field for other languages. The full list is in Languages. For details on what’s normalized natively, known gaps, and how to pre-normalize problematic patterns, see Text normalization.

Example

Send the string as text, and optionally a lang code:

curl -X POST https://optimize.rime.ai/textnorm \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"text":"1234 1,2,3,4 1-800-444-4141 "}'

The response includes the normalized string:

{"normalized":"one two three four, one, two, three, four, one, eight hundred, four four four, four one four one"}

Check each non-standard word in the output. Here 1234 is read digit by digit, and the phone number keeps its grouping, with 800 read as “eight hundred”. If a reading is wrong for your context, pre-normalize that text before you send it. Text normalization explains how.

To normalize text in a non-English language, pass a language code:

curl -X POST https://optimize.rime.ai/textnorm \
     -H "Authorization: Bearer $(rime key)" \
     -H "Content-Type: application/json" \
     -d '{"text":"Tengo 2 perros","lang":"es"}'

Variable parameters

text · string · required

The string you’d like to normalize, up to 10,000 characters. Numbers, phone numbers, and other non-standard words will be expanded into their spoken form.

lang · string

Language code (for example, en, es, fr, de, and additional languages) selecting the normalization rules. Defaults to English when omitted. language is accepted as an alias. If you send both, lang is used.

cURL

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

200

{
  "normalized": "one two three four, one, two, three, four, one, eight hundred, four four four, four one four one"
}