Build
The workflow document
A slug you choose, inputs with defaults, an optional schedule, and one to ten steps.
spinrun.workflow/v1: a slug you choose (it cannot change afterwards), inputs with optional defaults, an optional schedule, and one to ten steps. A step is either a tool call or an agent prompt; after names the steps it waits for.
Workflow fields
| Field | Type | Required | Description |
|---|
kind | "spinrun.workflow/v1" | Yes | Document discriminator. |
slug | string | Yes | URL slug. Cannot change after creation. |
name | string | Yes | Display name. |
description | string | null | Yes | What the workflow does. |
enabled | boolean | Yes | Whether the workflow runs. |
updated_at | string | No | Version stamp. Required on replace. |
space | object | Yes | Where the workflow lives. |
send_as | string | null | Yes | Identity runs send as. |
inputs | object | Yes | Inputs with optional defaults. |
schedule | object | null | Yes | Optional schedule. |
steps | object[] | Yes | One to ten steps. |
output | string | null | Yes | Which step's output is the workflow's output. |
space
| Field | Type | Required | Description |
|---|
team | string | null | Yes | Team slug, or null. |
schedule
| Field | Type | Required | Description |
|---|
cron | string | Yes | Cron expression. |
timezone | string | Yes | IANA timezone. |
| Field | Type | Required | Description |
|---|
id | string | Yes | Step handle a later step references. |
kind | "tool" | Yes | Step kind. |
tool | string | Yes | Tool slug to call. |
args | object | No | Arguments for the tool. |
after | string[] | No | Steps this one waits for. |
note | string | No | Author note, not executed. |
steps[] ("agent")
| Field | Type | Required | Description |
|---|
id | string | Yes | Step handle a later step references. |
kind | "agent" | Yes | Step kind. |
agent | string | Yes | Agent slug or id to run. |
args | object | Yes | The agent's input. |
after | string[] | No | Steps this one waits for. |
note | string | No | Author note, not executed. |
steps[] ("agent").args
| Field | Type | Required | Description |
|---|
prompt | string | Yes | Prompt for the agent. |
Full JSON Schema: /schemas/workflow-v1.json.