Glossary

Manage project glossary terms (from → to replacements) applied during transcription and via POST /v1/transcriptions/…/glossary/apply. Authenticate with a project API key (glossary:* permissions) or a user session with X-Workspace-Id and X-Project-Id. Workspace API keys cannot access these routes.

List glossary entriesGET/v1/glossarychevron_right
Create a glossary entryPOST/v1/glossarychevron_right
Update a glossary entryPATCH/v1/glossary/{entryId}chevron_right
Delete a glossary entryDELETE/v1/glossary/{entryId}chevron_right

The Glossary entry object

entryIdstring: Stable entry identifier.
fromstring: Source phrase (case-insensitive match).
tostring: Replacement text.
createdAttimestamp: Creation time.
updatedAttimestamp: Last update time.

{
  "entryId": "gls_01HX2K9V3JEK4WYZN6F0XQ2W8M",
  "from": "dead lift",
  "to": "deadlift",
  "createdBy": "usr_01HX...",
  "updatedBy": "usr_01HX...",
  "createdByUsername": "alice",
  "updatedByUsername": "alice",
  "createdAt": "2026-05-18T12:34:56Z",
  "updatedAt": "2026-05-18T12:34:56Z"
}

List glossary entries

GET/v1/glossary

Lists all glossary entries for the active project.

Requires permission

glossary:list

curl "https://perchat-media-api-csa4e2e0gedvgyfc.westus-01.azurewebsites.net/v1/glossary" \
  -H "Authorization: Bearer sk_prj_..."

{
  "data": [ {
  "entryId": "gls_01HX2K9V3JEK4WYZN6F0XQ2W8M",
  "from": "dead lift",
  "to": "deadlift",
  "createdBy": "usr_01HX...",
  "updatedBy": "usr_01HX...",
  "createdByUsername": "alice",
  "updatedByUsername": "alice",
  "createdAt": "2026-05-18T12:34:56Z",
  "updatedAt": "2026-05-18T12:34:56Z"
} ],
  "metadata": {
    "requestId": "req_01HX...",
    "responseTime": 42,
    "timestamp": "2026-05-18T12:34:56Z",
    "version": "v1"
  }
}

Create a glossary entry

POST/v1/glossary

Adds a new from → to rule.

Requires permission

glossary:create

Parameters

fromstring: Source phrase.
tostring: Replacement text.

curl -X POST "https://perchat-media-api-csa4e2e0gedvgyfc.westus-01.azurewebsites.net/v1/glossary" \
  -H "Authorization: Bearer sk_prj_..." \
  -H "Content-Type: application/json" \
-d '{
  "from": "dead lift",
  "to": "deadlift"
}'

{
  "data": {
  "entryId": "gls_01HX2K9V3JEK4WYZN6F0XQ2W8M",
  "from": "dead lift",
  "to": "deadlift",
  "createdBy": "usr_01HX...",
  "updatedBy": "usr_01HX...",
  "createdByUsername": "alice",
  "updatedByUsername": "alice",
  "createdAt": "2026-05-18T12:34:56Z",
  "updatedAt": "2026-05-18T12:34:56Z"
},
  "metadata": {
    "requestId": "req_01HX...",
    "responseTime": 42,
    "timestamp": "2026-05-18T12:34:56Z",
    "version": "v1"
  }
}

Update a glossary entry

PATCH/v1/glossary/{entryId}

Updates the from and/or to text.

Requires permission

glossary:update

curl -X PATCH "https://perchat-media-api-csa4e2e0gedvgyfc.westus-01.azurewebsites.net/v1/glossary/gls_01HX2K9V3JEK4WYZN6F0XQ2W8M" \
  -H "Authorization: Bearer sk_prj_..." \
  -H "Content-Type: application/json" \
-d '{
  "to": "dead-lift"
}'

{
  "data": {
  "entryId": "gls_01HX2K9V3JEK4WYZN6F0XQ2W8M",
  "from": "dead lift",
  "to": "deadlift",
  "createdBy": "usr_01HX...",
  "updatedBy": "usr_01HX...",
  "createdByUsername": "alice",
  "updatedByUsername": "alice",
  "createdAt": "2026-05-18T12:34:56Z",
  "updatedAt": "2026-05-18T12:34:56Z"
},
  "metadata": {
    "requestId": "req_01HX...",
    "responseTime": 42,
    "timestamp": "2026-05-18T12:34:56Z",
    "version": "v1"
  }
}

Delete a glossary entry

DELETE/v1/glossary/{entryId}

Permanently removes a glossary entry.

Requires permission

glossary:delete

curl -X DELETE "https://perchat-media-api-csa4e2e0gedvgyfc.westus-01.azurewebsites.net/v1/glossary/gls_01HX2K9V3JEK4WYZN6F0XQ2W8M" \
  -H "Authorization: Bearer sk_prj_..."

{
  "data": { "deleted": true },
  "metadata": {
    "requestId": "req_01HX...",
    "responseTime": 42,
    "timestamp": "2026-05-18T12:34:56Z",
    "version": "v1"
  }
}