Skip to main content

Create a new glossary

Create a new glossary.

Glossary type value can be either translation, asr or asr_hot.

Notes:

  • In case of 'translation' source and target languages must be different.
  • In case of 'asr' they must be the same.
  • In case of 'asr-hot' only source language value matters.
Request Body REQUIRED
data object REQUIRED
name Name REQUIRED

Possible values: 3 ≤ length ≤ 64, Value must match regular expression ^[\w\-. ]+$

Name of the glossary

is_enabled Is Enabled REQUIRED

Status of the glossary

glossary_type GlossaryType REQUIRED

Possible values: [asr_hot, asr, translation]

source_lang SourceLang REQUIRED

Possible values: [ar, auto, ba, be, bg, bn, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, fi, fr, ga, gl, he, hi, hr, hu, ia, id, it, ja, ko, lt, lv, mn, mr, ms, mt, no, nl, pl, pt, ro, ru, sk, sl, sv, sw, ta, th, tr, ug, uk, ur, vi, yue, zh]

target_lang TargetLang REQUIRED

Possible values: [ar, ar-ae, ar-sa, az, be, bg, bs, ca, cs, cy, da, de, el, en, en-au, en-ca, en-gb, en-us, es, es-mx, et, fi, fil, fr, fr-ca, gl, he, hi, hr, hu, id, is, it, ja, kk, ko, lt, lv, mk, ms, nl, no, pl, pt, pt-br, ro, ru, sk, sl, sr, sv, sw, ta, th, tr, uk, ur, vi, zh, zh-hans, zh-hant]

Responses
200

Successful Response

Schema OPTIONAL
ok Ok OPTIONAL

Indicates if the request was successful or not.

data object
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 SourceLang

Possible values: [ar, auto, ba, be, bg, bn, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, fi, fr, ga, gl, he, hi, hr, hu, ia, id, it, ja, ko, lt, lv, mn, mr, ms, mt, no, nl, pl, pt, ro, ru, sk, sl, sv, sw, ta, th, tr, ug, uk, ur, vi, yue, zh]

target_lang TargetLang

Possible values: [ar, ar-ae, ar-sa, az, be, bg, bs, ca, cs, cy, da, de, el, en, en-au, en-ca, en-gb, en-us, es, es-mx, et, fi, fil, fr, fr-ca, gl, he, hi, hr, hu, id, is, it, ja, kk, ko, lt, lv, mk, ms, nl, no, pl, pt, pt-br, ro, ru, sk, sl, sr, sv, sw, ta, th, tr, uk, ur, vi, zh, zh-hans, zh-hant]

utc_created_at date-time

Glossary created time in UTC

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.