Create Glossary
deepl.create_glossary
ActionAI & modelsconnection required
Calls the DeepL API with the connection's credentials.
Create a glossary of term pairs for one language pair, so later translations render those terms exactly as given.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- DeepL
- Secret shape
- the DeepL auth key, or {"api_key": "…"}
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 fields, 4 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
name Name for the glossary, shown in DeepL's account area. | string | Yes | — | — | Product terms EN-DE |
source_lang Language the left-hand terms are written in, such as en. Run deepl.list_glossary_language_pairs for the pairs DeepL accepts. | string | Yes | — | — | en |
target_lang Language the right-hand terms are written in, such as de. A glossary is one-directional, so EN to DE and DE to EN are two glossaries. | string | Yes | — | — | de |
entries The term pairs themselves, one per line, source and target separated by a tab (or a comma when entries_format is csv). | string | Yes | — | — | — |
entries_format How the entries are separated: tab-separated (DeepL's default) or comma-separated values. | string | No | tsv | one of "tsv", "csv" | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"entries_format": "tsv",
"name": "Product terms EN-DE",
"source_lang": "en",
"target_lang": "de"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
glossary_id Identifier DeepL assigned to the glossary. | string | — |
name Name the glossary was created with. | string | — |
ready True once the glossary can be used in a translation. | boolean | — |
source_lang Source language of the glossary's term pairs. | string | — |
target_lang Target language of the glossary's term pairs. | string | — |
creation_time When the glossary was created, as an ISO 8601 timestamp. | string | — |
entry_count How many term pairs the glossary holds. | number | — |
{
"creation_time": "",
"entry_count": 0,
"glossary_id": "",
"name": "",
"ready": false,
"source_lang": "",
"target_lang": ""
}Notes
- A glossary is immutable: editing terms means creating a new glossary and pointing the translation nodes at the new id.
See Create Glossary run in a workflow.
In a technical demo we add the DeepL connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.