Spinrun Docs
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

FieldTypeRequiredDescription
kind"spinrun.workflow/v1"YesDocument discriminator.
slugstringYesURL slug. Cannot change after creation.
namestringYesDisplay name.
descriptionstring | nullYesWhat the workflow does.
enabledbooleanYesWhether the workflow runs.
updated_atstringNoVersion stamp. Required on replace.
spaceobjectYesWhere the workflow lives.
send_asstring | nullYesIdentity runs send as.
inputsobjectYesInputs with optional defaults.
scheduleobject | nullYesOptional schedule.
stepsobject[]YesOne to ten steps.
outputstring | nullYesWhich step's output is the workflow's output.

space

FieldTypeRequiredDescription
teamstring | nullYesTeam slug, or null.

schedule

FieldTypeRequiredDescription
cronstringYesCron expression.
timezonestringYesIANA timezone.

steps[] ("tool")

FieldTypeRequiredDescription
idstringYesStep handle a later step references.
kind"tool"YesStep kind.
toolstringYesTool slug to call.
argsobjectNoArguments for the tool.
afterstring[]NoSteps this one waits for.
notestringNoAuthor note, not executed.

steps[] ("agent")

FieldTypeRequiredDescription
idstringYesStep handle a later step references.
kind"agent"YesStep kind.
agentstringYesAgent slug or id to run.
argsobjectYesThe agent's input.
afterstring[]NoSteps this one waits for.
notestringNoAuthor note, not executed.

steps[] ("agent").args

FieldTypeRequiredDescription
promptstringYesPrompt for the agent.

Full JSON Schema: /schemas/workflow-v1.json.

On this page