Activepieces · JSON Structure

Activepieces Create Flow Request Structure

Request body for creating a flow

Type: object Properties: 5 Required: 2
AutomationNo-CodeOpen SourceWorkflowAI AgentsMCP

CreateFlowRequest is a JSON Structure definition published by Activepieces, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

displayName projectId folderId templateId metadata

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/activepieces/refs/heads/main/json-structure/activepieces-create-flow-request-structure.json",
  "name": "CreateFlowRequest",
  "description": "Request body for creating a flow",
  "type": "object",
  "properties": {
    "displayName": {
      "type": "string",
      "description": "Flow display name",
      "example": "My New Flow"
    },
    "projectId": {
      "type": "string",
      "description": "Project ID to create flow in",
      "example": "project-xyz789"
    },
    "folderId": {
      "type": "string",
      "description": "Optional folder ID"
    },
    "templateId": {
      "type": "string",
      "description": "Optional template to base the flow on"
    },
    "metadata": {
      "type": "object",
      "description": "Custom metadata"
    }
  },
  "required": [
    "displayName",
    "projectId"
  ]
}