Skip to main content
POST
Create a glossary
Entries are JSON; CSV/TSV files must be converted first. When to use: to enforce terminology in translations (attach it to projects). Side effects: None beyond the new glossary. Cost: Free. Idempotency: Idempotency-Key accepted (SDKs send one); retries within 24 h replay the glossary as it is now, and answer 404 glossary_not_found if it was deleted since. Plan: glossary. Required scopes: glossaries:write Errors: feature_not_in_plan (403), glossary_language_pair_not_supported (422), glossary_entries_invalid (422)

Authorizations

Authorization
string
header
required

API key from Settings -> API keys, sent as Authorization: Bearer <key> (SDK environment variable RASK_API_KEY). Bound to one workspace and one acting user. Operations list the scopes they need (OpenAPI 3.1 scopes on a bearer scheme).

Scopes

glossaries:write

Headers

Idempotency-Key
string

Optional. A unique key per logical request (SDKs send a bare UUIDv4; an RFC 9651 quoted string is accepted and unquoted); reuse it unchanged on retries to replay the first response.

Required string length: 1 - 255
Pattern: ^[\x20-\x7E]+$

Body

application/json

Body of createGlossary (<= 10 MiB).

name
string
required

Glossary name.

Required string length: 1 - 255
source_language
string
required

Source language. A regional code is accepted and stored without its region (en-us as en).

Maximum string length: 32
target_language
string
required

Target language. A regional code is accepted and stored without its region (es-es as es).

Maximum string length: 32
entries
object
required

Source term -> target term. No tabs, newlines or edge whitespace; <= 1024 bytes per side; the whole body <= 10 MiB. CSV/TSV import is not offered: convert to JSON.

Response

Created: Glossary.

A glossary for one language pair.

object
enum<string>
required

Always glossary.

Available options:
glossary
id
string
required

Glossary id.

name
string
required

Glossary name.

source_language
string
required

Source language, without a region (en).

target_language
string
required

Target language, without a region (es).

version
integer<int32>
required

Version; every update increments it.

entry_count
integer<int32>
required

Number of entries.

entries
object | null
required

Source term -> target term. Returned by get, create and update; null in lists.

created_at
string<date-time>
required

Creation time.

created_by
object
required

A user reference.