Schema — download and validate¶
Engine version: 0.1.4
JSON Schema dialect: Draft 2020-12
Download¶
- workflow-definition.json — bundled schema for this docs version
- Latest mirror — rolling
latestchannel
Canonical URI¶
Workflow instances declare:
{
"document": {
"schema": "https://agent-workflow.dev/schemas/workflow-definition.json",
"name": "my-workflow",
"version": "1.0.0"
}
}
The document.schema URI identifies the protocol profile. document.version is your workflow definition semver (authoring artifact), not the engine package version.
Validate locally¶
From a repository clone:
npm ci
npm run validate-workflows
npm run engine:validate -- path/to/workflow.json
One-off with ajv-cli (no install):
npx --yes ajv-cli@5 validate -s schemas/workflow-definition.json -d path/to/workflow.json --spec=draft2020
Download the schema from this site and point your editor JSON Schema support at the local file path.
jq subset¶
Switch conditions, set_state, and output mappings use jq expressions. The reference engine implements a documented subset — see State, jq and reducers.
Related¶
- Compatibility matrix — core vs optional features
- Node reference — per-type configuration