Documentation
Learn how to use Compozy
Complete API reference for Compozy base structure configuration.
{ "type": "object", "required": ["name", "version"], "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" }, "author": { "$ref": "https://compozy.dev/schemas/authors.json" }, "tools": { "$ref": "https://compozy.dev/schemas/tools.json" }, "agents": { "$ref": "https://compozy.dev/schemas/agents.json" }, "tasks": { "$ref": "https://compozy.dev/schemas/tasks.json" }, "workflows": { "$ref": "https://compozy.dev/schemas/workflows.json" }, "env": { "type": "object", "patternProperties": { "^.*$": { "type": "string", "description": "Environment variable value or reference" } } }, "memory": { "$ref": "https://compozy.dev/schemas/memory.json" }, "trigger": { "$ref": "https://compozy.dev/schemas/triggers.json" }, "template-dependencies": { "type": "object", "properties": { "npm": { "type": "array", "items": { "type": "string" } }, "python": { "type": "array", "items": { "type": "string" } } } } } }
Show Properties