GlossaryGlossary

Get a glossary term

Retrieve a single glossary term by its id

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

glossary_term_idstringRequired
The id of the glossary term

Response

OK
idstringRead-only
The unique identifier for the glossary term
external_idstringformat: "^[\w +,\-.@#_$%&']+$"1-100 characters
Your own identifier for the term, unique within the AI Agent
translation_modeenum

custom tells the AI Agent to answer using the matching ai_agent_terms wording whenever it detects one of the user_terms. default only surfaces the term’s definition to the agent (and, with voice_detection_enabled, biases speech recognition) without changing its wording.

user_termslist of objects or null

The wordings a customer might use, per language. null when none are configured.

ai_agent_termslist of objects or null

The wordings the AI Agent should use, per language. Only meaningful in custom mode; null when none are configured.

voice_detection_enabledboolean
Whether the term is passed to the voice agent to improve how reliably it is recognized in speech. Requires a voice platform on the AI Agent.
definitionstring or null1-1000 characters

A business definition of the term, shown to the AI Agent when the term is detected. null when unset.

voice_pronunciationslist of objects or null

Phonetic respellings applied to the AI Agent’s outgoing speech on voice calls, or null when none are configured

availability_rulesobject or null
The structured rule that gates when this term applies, with variables referenced by id, or null when no rule is attached

Errors

401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error