Create Glossary
Create a new glossary for translation.
Endpoint
POST /api/v4/glossaries
TypeScript Type
type CreateGlossaryRequest = {
name: string;
description?: string;
source_language: string;
target_language: string;
entries_csv: string;
};
Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Glossary name |
description | string | No | Optional description |
source_language | string | Yes | Source language code |
target_language | string | Yes | Target language code |
entries_csv | string | Yes | CSV entries (source_term,target_term) |
Response Type
type GlossaryResponse = {
data: Glossary;
};
type Glossary = {
id: number;
name: string;
description: string | null;
source_language: string;
target_language: string;
entry_count: number;
is_active: boolean;
deepl_glossary_id: string | null;
google_glossary_id: string | null;
organization_id: number;
created_at: string;
last_modified: string;
entries?: GlossaryEntry[];
};
Notes
- Glossaries are used for translation between language pairs
- The
entries_csvfield contains term mappings in CSV format - Language pairs must be supported by the translation service (DeepL or Google)
- Use the
/api/v4/glossaries/supported-languagesendpoint to get valid language pairs