Agentic Workflow Spec
Definition
The sandbox an automation's runs execute in: what it may reach, and what it is built from.
Establish as a parent-child hierarchy between automations. You will not want to set this explicitly; instead, this is going to be set by the automation engine when one automation is deciding to create another.
The explicit grants on this automation.
On a write, three cases are distinguished:
- Omitted: the stored grants are left untouched. Use this when the request carries no opinion about access, for example a content-only update.
- Empty array: the grants are reset to the ones a newly created automation receives. This is how a declarative caller removes grants it previously declared — omitting the field would be a silent no-op.
- Non-empty array: the stored grants are replaced by exactly this set.
Computed, read-only. The set of actions the requesting user is permitted to perform on this automation, derived from their org role, dataset permissions, team memberships, and explicit permission entries. Ignored on write.
Computed, read-only. Whether the requesting user has starred this automation. Stars are per-user state held outside the versioned definition, so a value supplied on write is ignored. Absent for machine-token callers, which have no user whose stars could be read.
Optional model spec override, resolved on every run of this automation the same way a
per-invocation override is: modelClass and reasoningEffort take precedence over the
automations surface's user/organization default, each resolving independently; the
remaining fields (thinking, budgetTokens, speed, adaptive, reasoningSummary)
are passed straight through. When absent, runs resolve through the surface default as
usual. The resolved value is stamped on run telemetry; it does not yet steer which
model actually answers the turn. See Agent0ModelSpec.
Optional model selection, the routing counterpart of modelSpec. Resolved on every run
the same way. Invalid together with modelSpec.
Static key-value pairs the automation's author defines, available by name as {{theKeyName}} in the prompt and in tool parameter overrides. Surfaced in the UI as "Parameters". Always available regardless of trigger type. On a name conflict a constant WINS over a caller-supplied variable (a trigger payload value or a test-run variable) and LOSES to a built-in such as dash0.dataset — see resolveVariables in components/agents/src/server/routes/agentic-workflows/prompt.ts, whose merge order is caller < constants < builtIns.
Optional notification channels to notify when an automation run completes. Channels are grouped by outcome, so a run can notify different channels on success and on failure.
Used by 1
These schemas and endpoints reference this type directly.