Create workflow

http
POST /projects/{project_reference}/workflows

Create a workflow source file in the project source or a preview branch when a new multi-step process must be runnable or schedulable; returns the workflow source document. Requires project.runs.write.

Servers

json
[
  {
    "url": "https://api.veryfront.com"
  }
]

Authentication

json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyAuth": []
  }
]
json
{
  "bearerAuth": {
    "type": "http",
    "scheme": "bearer",
    "bearerFormat": "JWT or API Key",
    "description": "Use a JWT bearer token or a Veryfront API key in the `Authorization` header."
  },
  "apiKeyAuth": {
    "type": "apiKey",
    "in": "header",
    "name": "X-API-Key",
    "description": "Alternative API key header for `vf_<prefix>_<secret>` tokens."
  }
}

Parameters

NameLocationRequiredDescription
project_referencepathYesProject slug, UUID, or domain that identifies the project.
source_target_kindqueryNo
target_branch_idqueryNo

Parameter contracts

json
[
  {
    "schema": {
      "$ref": "#/components/schemas/ProjectReference"
    },
    "required": true,
    "description": "Project slug, UUID, or domain that identifies the project.",
    "name": "project_reference",
    "in": "path"
  },
  {
    "schema": {
      "type": "string"
    },
    "required": false,
    "name": "source_target_kind",
    "in": "query"
  },
  {
    "schema": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "required": false,
    "name": "target_branch_id",
    "in": "query"
  }
]

Request body

json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "pattern": "^[a-z0-9][a-z0-9-]*$",
            "description": "Stable workflow identifier used in MCP and project source."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "Optional short description of what the workflow does."
          },
          "version": {
            "type": [
              "string",
              "null"
            ],
            "description": "Optional workflow version string."
          },
          "schedulable": {
            "type": "boolean",
            "description": "Whether the workflow can be triggered by schedulers."
          }
        },
        "required": [
          "id"
        ]
      }
    }
  }
}

Responses

201

Created workflow document

json
{
  "description": "Created workflow document",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Workflow identifier."
          },
          "name": {
            "type": "string",
            "description": "Human-readable workflow name."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "Short description of the workflow purpose."
          },
          "target": {
            "type": "string",
            "description": "Execution target that implements the workflow."
          },
          "source_path": {
            "type": "string",
            "description": "Source file path where the workflow definition lives."
          },
          "source": {
            "type": "string",
            "description": "Workflow source code or structured document content."
          },
          "version": {
            "type": [
              "string",
              "null"
            ],
            "description": "Version string for the workflow definition, when tracked."
          },
          "schedulable": {
            "type": "boolean",
            "description": "Whether the workflow can be triggered by schedulers."
          },
          "edit_mode": {
            "type": "string",
            "enum": [
              "structured",
              "source_only"
            ],
            "description": "Editing mode supported for the workflow definition."
          },
          "source_only_reasons": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Reasons why the workflow can only be edited as raw source, when applicable."
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "target",
          "source_path",
          "source",
          "version",
          "schedulable",
          "edit_mode",
          "source_only_reasons"
        ],
        "description": "Workflow definition including editable source content."
      }
    }
  }
}

400

Bad request

json
{
  "description": "Bad request",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/WorkflowProblem"
      }
    }
  }
}

401

Unauthorized

json
{
  "description": "Unauthorized",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/WorkflowProblem"
      }
    }
  }
}

403

Forbidden

json
{
  "description": "Forbidden",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/WorkflowProblem"
      }
    }
  }
}

409

Conflict

json
{
  "description": "Conflict",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/WorkflowProblem"
      }
    }
  }
}

Referenced contracts

components/parameters/ProjectReference

json
{
  "schema": {
    "$ref": "#/components/schemas/ProjectReference"
  },
  "required": true,
  "description": "Project slug, UUID, or domain that identifies the project.",
  "name": "project_reference",
  "in": "path"
}

components/schemas/ProjectReference

json
{
  "type": "string"
}

components/schemas/WorkflowProblem

json
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Problem"
    },
    {
      "type": "object",
      "properties": {
        "edit_mode": {
          "type": "string",
          "enum": [
            "structured",
            "source_only"
          ],
          "description": "Edit mode of the workflow definition, on a source_only_conflict."
        },
        "source_only_reasons": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Why the workflow can only be edited as raw source, on a source_only_conflict."
        },
        "source_path": {
          "type": "string",
          "description": "Source file of the workflow definition, on a source_only_conflict."
        }
      }
    }
  ]
}

components/schemas/Problem

json
{
  "type": "object",
  "properties": {
    "cause": {
      "type": "string",
      "enum": [
        "schedule_concurrency_forbidden",
        "schedule_fire_in_progress",
        "schedule_run_limit_reached"
      ],
      "description": "Schedule admission refusal."
    },
    "idempotency": {
      "type": "object",
      "properties": {
        "state": {
          "type": "string",
          "enum": [
            "in_progress",
            "payload_mismatch",
            "outcome_unknown"
          ]
        },
        "operation": {
          "type": "string",
          "minLength": 1
        },
        "retryable": {
          "type": "boolean"
        },
        "retry_after_seconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "recovery": {
          "type": "object",
          "properties": {
            "available": {
              "type": "boolean"
            },
            "description": {
              "type": "string"
            },
            "resource_url": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "description"
          ]
        }
      },
      "required": [
        "state",
        "operation",
        "retryable",
        "retry_after_seconds",
        "expires_at"
      ],
      "description": "Replay status, retry timing, and recovery lookup."
    },
    "type": {
      "type": "string",
      "description": "URI reference identifying the problem type",
      "example": "https://api.veryfront.com/errors/validation-failed"
    },
    "title": {
      "type": "string",
      "description": "Short human-readable summary of the problem",
      "example": "Validation Failed"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599,
      "description": "HTTP status code",
      "example": 400
    },
    "code": {
      "type": "string",
      "description": "Stable machine-readable error code",
      "example": "RUN_INVALID_INPUT"
    },
    "detail": {
      "type": "string",
      "description": "Human-readable explanation specific to this occurrence",
      "example": "The 'email' field must be a valid email address"
    },
    "instance": {
      "type": "string",
      "description": "URI reference identifying the specific occurrence",
      "example": "/projects/my-project/members"
    },
    "slug": {
      "type": "string",
      "description": "Stable identifier for the problem type",
      "example": "validation-failed"
    },
    "category": {
      "type": "string",
      "enum": [
        "AUTH",
        "RESOURCE",
        "VALIDATION",
        "DATABASE",
        "SUBSCRIPTION",
        "INTEGRATION",
        "INTERNAL"
      ],
      "description": "API error category",
      "example": "VALIDATION"
    },
    "suggestion": {
      "type": "string",
      "description": "Suggested action to resolve the problem",
      "example": "Check the request body and query parameters against the API documentation."
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "Field path that caused the error",
            "example": "email"
          },
          "message": {
            "type": "string",
            "description": "Error message for this field",
            "example": "Invalid email format"
          },
          "code": {
            "type": "string",
            "description": "Error code for this field",
            "example": "INVALID_FORMAT"
          }
        },
        "required": [
          "field",
          "message"
        ]
      },
      "description": "Detailed field-level errors for validation failures"
    }
  },
  "required": [
    "type",
    "title",
    "status"
  ]
}

Operation contract

json
{
  "operationId": "createWorkflow",
  "tags": [
    "agents/Workflows/Workflows"
  ],
  "summary": "Create workflow",
  "description": "Create a workflow source file in the project source or a preview branch when a new multi-step process must be runnable or schedulable; returns the workflow source document. Requires project.runs.write.",
  "parameters": [
    {
      "$ref": "#/components/parameters/ProjectReference"
    },
    {
      "schema": {
        "type": "string"
      },
      "required": false,
      "name": "source_target_kind",
      "in": "query"
    },
    {
      "schema": {
        "type": [
          "string",
          "null"
        ],
        "format": "uuid"
      },
      "required": false,
      "name": "target_branch_id",
      "in": "query"
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128,
              "pattern": "^[a-z0-9][a-z0-9-]*$",
              "description": "Stable workflow identifier used in MCP and project source."
            },
            "description": {
              "type": [
                "string",
                "null"
              ],
              "description": "Optional short description of what the workflow does."
            },
            "version": {
              "type": [
                "string",
                "null"
              ],
              "description": "Optional workflow version string."
            },
            "schedulable": {
              "type": "boolean",
              "description": "Whether the workflow can be triggered by schedulers."
            }
          },
          "required": [
            "id"
          ]
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Created workflow document",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Workflow identifier."
              },
              "name": {
                "type": "string",
                "description": "Human-readable workflow name."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Short description of the workflow purpose."
              },
              "target": {
                "type": "string",
                "description": "Execution target that implements the workflow."
              },
              "source_path": {
                "type": "string",
                "description": "Source file path where the workflow definition lives."
              },
              "source": {
                "type": "string",
                "description": "Workflow source code or structured document content."
              },
              "version": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Version string for the workflow definition, when tracked."
              },
              "schedulable": {
                "type": "boolean",
                "description": "Whether the workflow can be triggered by schedulers."
              },
              "edit_mode": {
                "type": "string",
                "enum": [
                  "structured",
                  "source_only"
                ],
                "description": "Editing mode supported for the workflow definition."
              },
              "source_only_reasons": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Reasons why the workflow can only be edited as raw source, when applicable."
              }
            },
            "required": [
              "id",
              "name",
              "description",
              "target",
              "source_path",
              "source",
              "version",
              "schedulable",
              "edit_mode",
              "source_only_reasons"
            ],
            "description": "Workflow definition including editable source content."
          }
        }
      }
    },
    "400": {
      "description": "Bad request",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/WorkflowProblem"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/WorkflowProblem"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/WorkflowProblem"
          }
        }
      }
    },
    "409": {
      "description": "Conflict",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/WorkflowProblem"
          }
        }
      }
    }
  },
  "x-documentation-source-tag": "Project workflows",
  "x-canonical-documentation": {
    "domain": "agents",
    "resource": "Workflows",
    "subgroup": "Workflows",
    "name": "Create workflow",
    "description": "Create a workflow source file in the project source or a preview branch when a new multi-step process must be runnable or schedulable; returns the workflow source document. Requires project.runs.write.",
    "operationId": "createWorkflow"
  },
  "x-mint": {
    "href": "/cloud/rest/api-reference/agents-workflows-workflows/create-workflow"
  }
}