Glossary Terms

Glossary terms represent individual translations or variants within a glossary entry. Each entry can have multiple terms in different languages. On this page, we’ll dive into the different glossary term endpoints you can use to manage glossary terms programmatically. We’ll look at how to create, update, and delete glossary terms.

The glossary term model

A glossary term represents a single translation or variant within a glossary entry. Each entry can have multiple terms in different languages.

Properties

integer

Unique identifier for the glossary term.

integer

The ID of the glossary entry the term belongs to.

string

The term text.

string

The language code for the term (e.g., ‘en’, ‘de’, ‘fr’).

string

An optional description or definition of the term.

string

The type of term. Possible values: preferred (the recommended term to use) or forbidden (a term that should not be used).

string

An optional alternative form of the term.

List glossary terms

GET /v1/glossaries/:glossary_id/entries/:entry_id/terms This endpoint allows you to retrieve all terms for a specific glossary entry.

Optional query parameters

string

Filter terms by language code.

string

Filter terms by type: preferred or forbidden.

integer

Maximum number of terms to return. Default: 50.

integer

Number of terms to skip for pagination. Default: 0.

curl https://api.elanlanguages.ai/v1/glossaries/1/entries/1/terms \
  -H "Authorization: Bearer {token}" \
  -H "X-Org-Id: {orgId}"

Response

{
  "terms": [
    {
      "id": 1,
      "entry_id": 1,
      "term": "API",
      "lang": "en",
      "description": "Application Programming Interface",
      "term_type": "preferred",
      "alternative_term": null
    },
    {
      "id": 2,
      "entry_id": 1,
      "term": "Schnittstelle",
      "lang": "de",
      "description": "Programmierschnittstelle",
      "term_type": "preferred",
      "alternative_term": null
    }
  ],
  "total": 2,
  "limit": 50,
  "offset": 0
}

Create a glossary term

POST /v1/glossaries/:glossary_id/entries/:entry_id/terms This endpoint allows you to add a new term to a glossary entry.

Required attributes

string

required

The term text.

string

required

The language code for the term.

string

required

The type of term: preferred or forbidden.

Optional attributes

string

A description or definition of the term.

string

An alternative form of the term.

curl https://api.elanlanguages.ai/v1/glossaries/1/entries/1/terms \
  -H "Authorization: Bearer {token}" \
  -H "X-Org-Id: {orgId}" \
  -H "Content-Type: application/json" \
  -d '{
    "term": "Interface",
    "lang": "en",
    "description": "An alternative term",
    "term_type": "forbidden",
    "alternative_term": "API"
  }'

Response

{
  "id": 3,
  "entry_id": 1,
  "term": "Interface",
  "lang": "en",
  "description": "An alternative term",
  "term_type": "forbidden",
  "alternative_term": "API"
}

Retrieve a glossary term

GET /v1/glossaries/:glossary_id/entries/:entry_id/terms/:term_id This endpoint allows you to retrieve a specific glossary term by its id.

curl https://api.elanlanguages.ai/v1/glossaries/1/entries/1/terms/1 \
  -H "Authorization: Bearer {token}" \
  -H "X-Org-Id: {orgId}"

Response

{
  "id": 1,
  "entry_id": 1,
  "term": "API",
  "lang": "en",
  "description": "Application Programming Interface",
  "term_type": "preferred",
  "alternative_term": null
}

Update a glossary term

PUT /v1/glossaries/:glossary_id/entries/:entry_id/terms/:term_id This endpoint allows you to update a glossary term. All attributes are optional - only include the fields you want to update.

Optional attributes

string

The term text.

string

The language code for the term.

string

A description or definition of the term.

string

The type of term: preferred or forbidden.

string

An alternative form of the term.

curl -X PUT https://api.elanlanguages.ai/v1/glossaries/1/entries/1/terms/1 \
  -H "Authorization: Bearer {token}" \
  -H "X-Org-Id: {orgId}" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Updated description for API"
  }'

Response

{
  "id": 1,
  "entry_id": 1,
  "term": "API",
  "lang": "en",
  "description": "Updated description for API",
  "term_type": "preferred",
  "alternative_term": null
}

Delete a glossary term

DELETE /v1/glossaries/:glossary_id/entries/:entry_id/terms/:term_id This endpoint allows you to delete a glossary term.

curl -X DELETE https://api.elanlanguages.ai/v1/glossaries/1/entries/1/terms/1 \
  -H "Authorization: Bearer {token}" \
  -H "X-Org-Id: {orgId}"

Guides

Jobs & Translation

Resources

Webhooks

Account

The glossary term model

Properties

List glossary terms

Optional query parameters

Create a glossary term

Required attributes

Optional attributes

Retrieve a glossary term

Update a glossary term

Optional attributes

Delete a glossary term

​The glossary term model

​Properties

​List glossary terms

​Optional query parameters

​Create a glossary term

​Required attributes

​Optional attributes

​Retrieve a glossary term

​Update a glossary term

​Optional attributes

​Delete a glossary term

The glossary term model

Properties

List glossary terms

Optional query parameters

Create a glossary term

Required attributes

Optional attributes

Retrieve a glossary term

Update a glossary term

Optional attributes

Delete a glossary term