Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rime.ai/llms.txt

Use this file to discover all available pages before exploring further.

Custom pronunciation is supported on Mist v1 and v2 only. Coda, Arcana, and Mist v3 do not yet support phonemizeBetweenBrackets.
Rime uses its own phonetic alphabet, inspired by the International Phonetic Alphabet (IPA), to let you specify exactly how a word should sound. You provide a phonetic string inside curly brackets and set phonemizeBetweenBrackets: true on the request. For the full request mechanic, see Custom pronunciation. For example, the word custom is represented as {k1Ast0xm}. Even made-up words work — gorbulets becomes {g1orby0ul2Ets}.

Vowels

SymbolUse in an English word
@bat
ahot
Abutt
Wabout
xcomma
Ybite
Ebet
Rbird, foreword
ebait
Ibit
ibeat
oboat
Oboy
Ubook
uboot
Nbutton

Consonants

SymbolUse in an English word
bbuy
CChina
ddie
Dthy
ffight
gguy
hhigh
Jjive
kkite
llie
mmy
nnigh
Gsing
ppie
rrye
ssigh
Sshy
ttie
Tthigh
vvie
wwise
yyacht
zzoo
Zpleasure

Stress

For primary stress, put 1 before the relevant vowel. For example, comma is {k1am0x}. For secondary stress, put 2 in front of the relevant vowel. For example, auctioneer is {2akS0In1ir}. All other vowels should have a 0 in front of them.