Phonemize

curl --request POST \
  --url https://optimize.rime.ai/phonemize \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: audio/wav' \
  --fail \
  --data-binary @speech.wav

import requests

url = "https://optimize.rime.ai/phonemize"

headers = {
    "Authorization": "Bearer <authorization>",
    "Content-Type": "audio/wav"
}

with open("speech.wav", "rb") as f:
    response = requests.request("POST", url, data=f, headers=headers)

print(response.text)

import { readFile } from 'node:fs/promises';

const audio = await readFile('speech.wav');

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <authorization>',
    'Content-Type': 'audio/wav'
  },
  body: audio
};

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

{
  "audioId": "9b2d8ad2-0618-4e96-b255-98b2f7488061",
  "phonemeString": "h0El1o !",
  "authed": 1
}

curl --request POST \
  --url https://optimize.rime.ai/phonemize \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: audio/wav' \
  --fail \
  --data-binary @speech.wav

import requests

url = "https://optimize.rime.ai/phonemize"

headers = {
    "Authorization": "Bearer <authorization>",
    "Content-Type": "audio/wav"
}

with open("speech.wav", "rb") as f:
    response = requests.request("POST", url, data=f, headers=headers)

print(response.text)

import { readFile } from 'node:fs/promises';

const audio = await readFile('speech.wav');

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <authorization>',
    'Content-Type': 'audio/wav'
  },
  body: audio
};

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

{
  "audioId": "9b2d8ad2-0618-4e96-b255-98b2f7488061",
  "phonemeString": "h0El1o !",
  "authed": 1
}

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 API endpoint converts a short audio recording of a word into a phonetic string in the Rime phonetic alphabet. Use it when you know how a word should sound but don’t want to write the phonetic string by hand: record the word (or synthesize it), post the audio, and paste the returned string into a TTS request inside curly brackets with phonemizeBetweenBrackets: true. See Custom pronunciation.

Custom pronunciation strings are supported on Mist v1, Mist v2, and English Mist v3. Coda and non-English Mist v3 accept phonemizeBetweenBrackets and ignore it. For an overview of all the ways to control pronunciation, see Pronunciation control.

Request

Unlike Rime’s other endpoints, the request body is the raw audio bytes, not JSON or multipart form data. Set the Content-Type header to match the audio format. WAV (audio/wav) and MP3 (audio/mpeg) are supported.

Example

Generate or record audio of the word, for example with the Rime CLI:

rime tts -m coda -l en -s astra "hello" -o speech.wav

Then post it to the endpoint:

curl -X POST https://optimize.rime.ai/phonemize \
     -H "Authorization: Bearer $(rime key)" \
     -H "Content-Type: audio/wav" \
     --data-binary @speech.wav

The response includes the phonetic string:

{
  "audioId": "9b2d8ad2-0618-4e96-b255-98b2f7488061",
  "phonemeString": "h0El1o !",
  "authed": 1
}

Response fields

audioId: identifier of the uploaded audio clip.
phonemeString: the phonetic transcription in the Rime phonetic alphabet. The string may end with a punctuation token (e.g. ! or ?); strip it before using the string inside {}.
authed: always 1.

curl --request POST \
  --url https://optimize.rime.ai/phonemize \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: audio/wav' \
  --fail \
  --data-binary @speech.wav

import requests

url = "https://optimize.rime.ai/phonemize"

headers = {
    "Authorization": "Bearer <authorization>",
    "Content-Type": "audio/wav"
}

with open("speech.wav", "rb") as f:
    response = requests.request("POST", url, data=f, headers=headers)

print(response.text)

import { readFile } from 'node:fs/promises';

const audio = await readFile('speech.wav');

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <authorization>',
    'Content-Type': 'audio/wav'
  },
  body: audio
};

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

{
  "audioId": "9b2d8ad2-0618-4e96-b255-98b2f7488061",
  "phonemeString": "h0El1o !",
  "authed": 1
}

Overview

Coda API reference

Mist v3 API reference

Mist v2 API reference

API Metadata

Other APIs

Overview

Request

Example

Response fields

​Overview

​Request

​Example

​Response fields

Overview

Request

Example

Response fields