Spoken Terms are available on all plans that include the DeepL Voice API. The number of collections you can create depends on your plan.
Collect domain-specific terms
Review your calls for domain- and company-specific words you want transcribed with complete accuracy. Collect them in a term list: the terms, written exactly as you want them to appear in your transcripts (terms are case-sensitive). In the next step, you’ll send this list to the DeepL API.Create a collection
Term lists are stored in a Spoken Terms collection, which can hold one term list for each language. Create a collection withPOST /v3/spoken-terms:
Example request
Example response
spoken_terms_id; every voice session that should use these terms passes it.
Start a voice session with your terms
Include thespoken_terms_id when you create a voice session. The terms for the session’s source language are then recognized correctly in the transcription:
Example request
glossary_id in the same session. Spoken Terms control how speech is recognized, and glossaries control how it’s translated.
Spoken Terms are available for all DeepL Voice languages. To check a language programmatically, call GET /v3/languages?resource=voice and look for the spoken_terms feature key on the source language.
Add terms as your vocabulary grows
To add terms without resending the existing ones,PATCH the collection; entries you pass for a language are merged into its existing term list:
Example request
Example response
Replace a language’s terms
To rebuild a language’s term list from scratch, for example from an updated product catalog,PUT the term list with the new entries. Unlike PATCH, which adds to the existing list, PUT replaces the list entirely (or creates it, if the language is new to the collection):
Example request
Example response