Public APIGlossary
Create a glossary item
POST
Creates a new glossary item inside a glossaries-type group. The
referenced group_id must belong to your organization and have
type: glossaries.
bearerAuthheader
AuthorizationBearer <token>API key in the Authorization: Bearer <key> header.
Keys are created in the Hallolara dashboard (Settings → API Keys).
application/json- body
group_id*stringMatch
^[a-f0-9]{24}$name*stringWhitespace is trimmed; the trimmed name must be at least 1 character.
Length
1 <= length <= 200abbreviation?stringLength
length <= 100Default
""description?stringLength
length <= 5000Default
""aliases?array<>Spoken forms of the term as the speech recognizer tends to write them (for example Michel for Mitel). Each entry is trimmed; an empty or whitespace-only entry is rejected with 400. Duplicates are dropped case-insensitively, keeping the first spelling.
Items
items <= 20Default
[]active?booleanDefault
trueCreated.
application/json- response
data?curl -X POST 'https://api.hallolara.ai/api/v1/glossary' \ -H 'Content-Type: application/json' \ -d '{ "group_id": "65a1234567890abcdef01234", "name": "Application Programming Interface", "abbreviation": "API", "aliases": [ "A P I" ]}'Example Response
{ "data": { "id": "string", "group_id": "string", "group_name": "string", "abbreviation": "string", "name": "string", "description": "string", "aliases": [ "string" ], "active": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }}