Skip to content

workflow_template_apply

Create a workflow from a template.

Tool

workflow_template_apply

Create a workflow from a template.

Create a workflow from a template. It lands exactly as `workflow_definition_create` leaves one: a draft at version 0, with the validator’s issues on it — including, on a Product that has not set the config keys the template references, the issue that names `workflow_config_set`. Edit it, then publish it. An inapplicable template applies too: the draft records what it needs rather than being refused with nothing to look at.

Behavior

HTTP
POST /workflow/templates/apply

Arguments

Name
Type
Required
Description
name
string
—
Defaults to the template's own name.
template_id
string
•
No description in the catalog.

Response

Field
Type
Always
Description
live
object
•
draft
object
•
grants
object
•
The workflow principal's grants; null when Governance could not be reached.
health
object
•
What the dependency check found; null when nothing is unknown.
issues
array
•
Validation of the draft as it stands right now.
timeline
array
•
The last 20 health entries, newest first; `workflow_health_list` pages the rest.
workflow
object
•
dependencies
array
•
What the live version was validated against, with the hashes it saw.

Try it

Create a workflow from a template.

When to use

Create a workflow from a template. It lands exactly as `workflow_definition_create` leaves one: a draft at version 0, with the validator’s issues on it — including, on a Product that has not set the config keys the template references, the issue that names `workflow_config_set`. Edit it, then publish it. An inapplicable template applies too: the draft records what it needs rather than being refused with nothing to look at.

Example

Ask your agent something like this:

Create a workflow from a template.

The agent will invoke workflow_template_apply with these arguments:

{
  "template_id": "<template_id>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select