Skip to main content
Manage the organisation glossary. The glossary is the organisation’s own terms (service names, acronyms, internal jargon) and what they mean. AI features use it so they understand those terms wherever they appear. Anyone with an API key can read the glossary. Creating, updating, reordering and deleting entries requires the glossary_entries_manage role. The manage_settings role also grants that access.

The glossary entry object

A glossary entry is one term an organisation has coined — an acronym, a service name, or a piece of internal jargon — and the description of what it means.

AI features use the glossary, in rank order, so they understand those terms. Lower ranks come first. Deleting an entry archives it, which frees the term so it can be coined again as a new entry.

created_at
string<date-time>
required

When the entry was created

Example:

"2021-08-17T13:28:57.801578Z"

description
string
required

What the term means

Maximum string length: 2000
Example:

"Payment service provider that handles card authorisations"

id
string
required

Unique identifier for this glossary entry

Example:

"01G0J1EXE7AXZ2C93K61WBPYEH"

item
string
required

The term, e.g. an acronym or service name

Maximum string length: 128
Example:

"PSP"

rank
integer<int64>
required

The entry's position in the glossary

Example:

1

updated_at
string<date-time>
required

When the entry was last updated

Example:

"2021-08-17T13:28:57.801578Z"