Documentation
Learn how to use Compozy
Complete API reference for Compozy workflows configuration.
{ "type": "object", "required": ["name", "version", "tasks"], "properties": { "name": { "type": "string", "description": "Name of the workflow" }, "version": { "type": "string", "description": "Version of the workflow" }, "description": { "type": "string", "description": "Description of what the workflow does" }, "input": { "type": "object", "patternProperties": { "^.*$": { "type": "object", "properties": { "type": { "type": "string", "description": "Data type of the input field" }, "required": { "type": "boolean", "description": "Whether the field is required" }, "default": { "description": "Default value if not provided" }, "description": { "type": "string", "description": "Description of the input field" } }, "required": ["type"] } } }, "tasks": { "type": "array", "items": { "$ref": "https://compozy.dev/schemas/tasks.json#/properties/tasks/items" } }, "env": { "type": "object", "patternProperties": { "^.*$": { "type": "string", "description": "Environment variable value or reference" } } } } }
Show Properties
running
success
error
Show Usage
{{ input.PROPERTY }} # Direct property access {{ input.nested.PROPERTY }} # Nested property access
{{ env.VARIABLE_NAME }} # Environment variable access