Get Glossary
deepl.get_glossary
ActionAI & modelsconnection required
Calls the DeepL API with the connection's credentials.
Fetch one glossary's metadata, including whether it is ready to use.
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
1 field, 1 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 |
|---|---|---|---|---|---|
glossary_id Identifier of the glossary to act on, as returned by deepl.list_glossaries. | string | Yes | — | — | — |
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": ""
}See Get 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.