Skip to main content

Retrieve user-created glossaries

Retrieve a list of user-created glossaries, optionally paginated and sorted by creation date.

Details:

  • Supports pagination with a token for subsequent requests.
  • If token is provided, sort and page_size are not allowed.
  • If sort and/or page_size are specified, a fresh pagination page will be started without using token.
Query Parameters
sort Sort

Sort order: asc | desc

Sort order: asc | desc

Example: desc

page_size Page Size

Number of items per page [1;50]

Number of items per page [1;50]

Example: 10

token Token

Pagination token. Note: sort and page_size parameters are not allowed with the pagination token parameter.

Pagination token. Note: sort and page_size parameters are not allowed with the pagination token parameter.

Responses
200

Successful Response

Schema OPTIONAL
ok Ok OPTIONAL

Indicates if the request was successful or not.

data object
items object[]

The list of items in the page

glossary_id uuid4

Glossary ID

user_id User Id

User ID

name Name

Glossary name

is_enabled Is Enabled

Glossary status

glossary_type GlossaryType

Possible values: [asr_hot, asr, translation]

source_lang LangCode

Possible values: [en, en-gb, en-us, fr, de, tr, ar, it, ru, uk, es, es-mx, pt, pt-br, zh, ja, yue, ko, sv, pl, id, nl, fi, hu, el, cs, sk, da, bg, ro, en-gpt, en-zh, en-parler, en-palabra-llm, en-zns, fr-zns, en-f5, he, hi]

Supported languages in ISO-639-1 format

target_lang LangCode

Possible values: [en, en-gb, en-us, fr, de, tr, ar, it, ru, uk, es, es-mx, pt, pt-br, zh, ja, yue, ko, sv, pl, id, nl, fi, hu, el, cs, sk, da, bg, ro, en-gpt, en-zh, en-parler, en-palabra-llm, en-zns, fr-zns, en-f5, he, hi]

Supported languages in ISO-639-1 format

utc_created_at date-time

Glossary created time in UTC

utc_updated_at date-time

Glossary created time in UTC

page_size Page Size

The number of max items count in the page

count Count

The number of items in the page

next Next OPTIONAL

The next page token

default

Default Response

Schema OPTIONAL
ok Ok OPTIONAL

Indicates if the request was successful or not.

errors object[]

List of errors

type uri

Possible values: 1 ≤ length ≤ 2083

A string containing a URI reference that identifies the problem type.

status Status

Possible values: 399 < value < 600

A number indicating the HTTP status code.

title Title

Possible values: 5 ≤ length

A string containing a short, human-readable summary of the problem type.

detail Detail

Possible values: 5 ≤ length

A string containing a human-readable explanation specific to this occurrence of the problem.

instance Instance

Possible values: 1 ≤ length

A string containing a URI reference that identifies the specific occurrence of the problem.

error_code Error Code

A Number that indicates the error type that occurred.