> ## Documentation Index
> Fetch the complete documentation index at: https://docs.modulex.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a workflow

> Create a new workflow from a complete workflow schema. Requires the organization admin or owner role. The request body must contain a `workflow_schema` (a full WorkflowDefinition); top-level metadata fields override what is extracted from the schema.



## OpenAPI

````yaml /api-reference/openapi.json post /workflows
openapi: 3.0.3
info:
  title: ModuleX API
  version: 0.1.2
  description: >-
    ModuleX REST API. Authenticate with a user API key (`Authorization: Bearer
    mx_live_*`, or the `X-API-KEY` header) and supply the organization context
    header `X-Organization-ID` on org-scoped endpoints. Routers carry NO `/v1`
    version segment. Billing-gated surfaces (workflow run, managed knowledge
    search) reject before any write with a flat `DenialEnvelope` (402/403/429).
servers:
  - url: https://api.modulex.dev
    description: Production
security:
  - bearerAuth: []
    orgHeader: []
tags:
  - name: Workflows
    description: Create, read, update and delete workflow definitions.
  - name: Runs
    description: Execute workflows. Subject to the billing admission gate.
  - name: Schedules
    description: Recurring (cron / interval) workflow executions.
  - name: Knowledge
    description: Knowledge bases and semantic search.
  - name: Credentials
    description: Integration credentials (API key, bearer, OAuth2, ModuleX-managed).
  - name: Integrations
    description: Catalog of available tools, LLM providers and knowledge providers.
  - name: Organizations
    description: Organization management.
  - name: API keys
    description: User-owned API keys for programmatic access.
paths:
  /workflows:
    post:
      tags:
        - Workflows
      summary: Create a workflow
      description: >-
        Create a new workflow from a complete workflow schema. Requires the
        organization admin or owner role. The request body must contain a
        `workflow_schema` (a full WorkflowDefinition); top-level metadata fields
        override what is extracted from the schema.
      operationId: createWorkflow
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowCreate'
      responses:
        '201':
          description: The created workflow.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  schemas:
    WorkflowCreate:
      type: object
      required:
        - workflow_schema
      properties:
        workflow_schema:
          type: object
          additionalProperties: true
          description: Complete WorkflowDefinition (required).
        name:
          type: string
          description: Workflow name. Falls back to schema metadata if omitted.
        slug:
          type: string
          description: URL-friendly identifier. Auto-generated from name if omitted.
        description:
          type: string
        category:
          type: string
        status:
          type: string
          default: draft
        visibility:
          type: string
          default: organization
        tags:
          type: array
          items:
            type: string
        version:
          type: string
        input:
          type: object
          additionalProperties: true
          description: Default input parameters.
        config:
          type: object
          additionalProperties: true
          description: Default execution config.
    Workflow:
      type: object
      description: A workflow definition and its metadata.
      properties:
        id:
          type: string
          format: uuid
        organization_id:
          type: string
          format: uuid
        creator_id:
          type: string
          format: uuid
          nullable: true
        name:
          type: string
        description:
          type: string
          nullable: true
        version:
          type: string
          nullable: true
        tags:
          type: array
          items:
            type: string
        category:
          type: string
          nullable: true
        status:
          type: string
          example: draft
        visibility:
          type: string
          example: organization
        workflow_schema:
          type: object
          additionalProperties: true
          description: Full WorkflowDefinition (nodes, edges, state_schema, metadata).
        input:
          type: object
          additionalProperties: true
          description: Default input parameters.
        config:
          type: object
          additionalProperties: true
          description: Default execution config.
        edit_version:
          type: integer
          nullable: true
        last_edited_by:
          type: string
          format: uuid
          nullable: true
        last_edited_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      description: Standard FastAPI error response.
      properties:
        detail:
          description: >-
            Human-readable error message, or a structured object (some endpoints
            return `{message, code, ...}`).
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
    HTTPValidationError:
      type: object
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorItem'
    ValidationErrorItem:
      type: object
      required:
        - loc
        - msg
        - type
      properties:
        loc:
          type: array
          items:
            oneOf:
              - type: string
              - type: integer
        msg:
          type: string
        type:
          type: string
  responses:
    BadRequest:
      description: The request was malformed or failed a business rule.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: >-
        Authentication required or invalid. Provide `Authorization: Bearer
        <key>` or `X-API-KEY`.
      headers:
        WWW-Authenticate:
          schema:
            type: string
          description: Bearer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: The caller lacks the required role or access to the resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationError:
      description: Request validation failed (FastAPI 422).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/HTTPValidationError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        User API key: `Authorization: Bearer mx_live_*`. The `X-API-KEY:
        mx_live_*` header is also accepted.
    orgHeader:
      type: apiKey
      in: header
      name: X-Organization-ID
      description: Required organization context for org-scoped endpoints.

````