Envelope
The workflow.
name is 1-120 characters and description up to 500. Unknown keys are rejected.id,
ownerUserId, status, counts, dates, sharedUserIds) are informational: an import ignores them.
settings holds the workflow’s notification recipients (up to 20) and its
credit limits: monthlyCreditLimit and
perRunCreditLimit in whole credits (1-10,000,000), and hourlyExecutionLimit in runs
(1-10,000). null means the plan default (on Business, no monthly limit). A file exported before credit limits, with
monthlySpendLimitMinor and perRunLimit, still imports, with every limit at the plan default.
Graph
Every node has
id, type and position (x, y within ±10,000), and optionally title (120
characters), note (500) and comment (500). Steps other than the trigger can also carry:
active: false— kept but skipped;errorPolicy—maxAttempts(1-10, including the first) and/oronFailure(fail_runorcontinue). A policy that sets neither is rejected.
prompt, model, tools, connectorPins, outputSchema
and maxSteps on an agent; expression or router on a condition; loop, wait, approval,
action, output, webSearch, image and document on their steps; agents on parallel_agents;
read (provider, operationId and params) and connectorPin on an app_read — are
listed with their limits in the
triggers and steps reference. Placeholders use {{step_id.path}}.
What export strips
Exports leave out anything that only means something to the exporter:- Personal accounts. A step pinned to a specific connected account (
provider::connectionId) keeps that pin in the file only when the account is yours. Anyone else’s account is exported with only the provider, for examplexero. Import keeps a pin that names one of the importer’s own connected accounts, so re-importing your own export keeps the accounts you chose. Every other account is removed from the pins: if the importer has exactly one account for that provider it is used, otherwise the step asks them to connect or choose one. - Reader-specific fields: permissions, access, owner details, run-account requirements, the workflow’s cost to date, and its failed and test run counts.
shareScope, sharedUserIds) is in the file, but an import ignores it.
What import does
Importing needs the Operator role or higher. Hive then:- checks the file against the format above, and refuses it if it is malformed, repeats a node id, or contains an action your role may not put in a workflow;
- creates a new private draft you own, whatever the file’s status or sharing said;
- keeps the file’s
settings(a monthly credit limit above your workspace’s maximum is held to that maximum when the workflow runs); - records the import in the audit log;
- returns the draft with a list of issues — up to 50 things a deploy would refuse until you fix them.
nodeId, or null for the whole workflow), a code and a message:
connector_capability_missing,
workflow_model_unavailable, web_search_unavailable, saved_agent_unavailable,
output_key_unknown and error_policy_reference. See
Deploy a release.
When a file is refused
A file that does not match the format is refused with400 and code invalid_input, and no draft
is created. The message names the first field at fault by its path in the file,
details.fieldErrors lists every field at fault in English, and details.fieldIssues gives each
of those problems as a machine-readable code with its limits:
message and fieldErrors are always in English. Use code and fieldIssues when you want
to show the problem in your own words or language: the issue codes are Zod’s (invalid_type,
too_small, too_big, invalid_string, invalid_enum_value, unrecognized_keys, custom…),
and the limits beside them (minimum, maximum, options…) are numbers, true or false, or text.
The other workflow requests that refuse a request body with invalid_input (creating, editing,
deploying, sharing and running a workflow, cancelling a run, and workflow templates and schedules)
name the field the same way.
Related
Share and reuse
Duplicate, export, import and share.
Triggers and steps
Every node type and its fields.
Limits reference
Every limit in one table.
Developer overview
Every way to build on Hive.