Get Usage

deepl.get_usage
ActionAI & modelsconnection required

Calls the DeepL API with the connection's credentials.

Report how many characters this DeepL account has translated in the current billing period, and how many its plan allows.

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

This node takes no configuration beyond its connection.

Output

One shape.

result

FieldTypeExample
character_count
Characters translated in the billing period.
number—
character_limit
Characters the plan allows in that period.
number—
characters_remaining
Allowance left before the limit.
number—
percent_used
Share of the allowance used, as a percentage.
number—
limit_reached
True once the character limit has been reached and calls will be refused.
boolean—
{
  "character_count": 0,
  "character_limit": 0,
  "characters_remaining": 0,
  "limit_reached": false,
  "percent_used": 0
}

See Get Usage 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.