Check Document Status
deepl.get_document_status
ActionAI & modelsconnection required
Calls the DeepL API with the connection's credentials.
Check once how far DeepL has got with a document translation job, without waiting for it to finish.
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
2 fields, 2 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 |
|---|---|---|---|---|---|
document_id Identifier of the document translation job, returned by deepl.translate_document. | string | Yes | — | — | — |
document_key Key DeepL returned alongside document_id; the encrypted document cannot be read without it. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
document_id Identifier of the job that was checked. | string | — |
status DeepL's status for the job: queued, translating, done or error. | string | — |
done True when the translated document is ready to download. | boolean | — |
failed True when DeepL reported an error for the job. | boolean | — |
seconds_remaining DeepL's estimate of the time left, when it offers one; 0 otherwise. | number | — |
billed_characters Characters the document was billed for, once the job is done. | number | — |
error_message Why the job failed, when status is error. | string | — |
{
"billed_characters": 0,
"document_id": "",
"done": false,
"error_message": "",
"failed": false,
"seconds_remaining": 0,
"status": ""
}Notes
- This is one status check, not a wait: it returns immediately with the job's current status. Loop it with control.while on `done == false` and a control.delay of a few seconds rather than expecting the node to block a worker until DeepL finishes.
- document_id and document_key both come from deepl.translate_document. DeepL stores the uploaded file encrypted under document_key and will not return it without that key.
See Check Document Status 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.