JSON Schema

https://compozy.dev/schemas/base-structure.json
{
  "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" }
        }
      }
    }
  }
}

Parameters

Base Structure

name
string
required
Unique identifier for the workflow
version
string
required
Semantic version (MAJOR.MINOR.PATCH)
description
string
Human-readable workflow description
author
object
Author and contributor information. See Authors API Reference
env
object
Environment configuration
trigger
object
required
Workflow trigger configuration. See complete Triggers Reference
template-dependencies
object
Custom dependencies for template expressions. Learn more

Components

memory
object
Memory and context settings. See Memory API Reference
tools
array
Tool definitions and configurations. See Tools API Reference
mcp_servers
array
MCP Server configurations. See MCP Server API Reference
agents
array
AI agent configurations. See Agents API Reference
tasks
array
Task definitions and flow control. See Tasks API Reference
workflows
object
required
Nested workflow definitions and imports. See Workflows API Reference