# Create Workflow Run

> POST /api/v1/workflow/{workflow_id}/runs — request parameters and responses from the Menace Voice API schema.

`POST /api/v1/workflow/{workflow_id}/runs`

{/* Generated by scripts/sync_docs_api.mjs. Edit the API schema source to change the contract. */}

See [authentication](/api-reference/authentication) for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

## API contract for documentation tools

Generated from the OpenAPI schema. Do not infer a different parameter type from an example. Authentication headers are alternatives as explained in the authentication guide.

### Parameters

| Name | Location | Type | Required | Description and constraints |
| --- | --- | --- | --- | --- |
| workflow_id | path | integer | yes |  |
| authorization | header | string or null | no |  |
| X-API-Key | header | string or null | no |  |

### Request body: application/json

Required body. Schema: CreateWorkflowRunRequest (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| mode | string | yes |  |
| name | string | yes |  |

### Response 200

Successful Response

application/json: CreateWorkflowRunResponse (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| id | integer | yes |  |
| workflow_id | integer | yes |  |
| name | string | yes |  |
| mode | string | yes |  |
| created_at | string | yes | format: "date-time" |
| definition_id | integer | yes |  |
| initial_context | object or null | no |  |

### Response 404

Not found

### Response 422

Validation Error

application/json: HTTPValidationError (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| detail | array of ValidationError (object) | no |  |

## OpenAPI

````yaml api-reference/openapi.json post /api/v1/workflow/{workflow_id}/runs
openapi: 3.1.0
info:
  title: Menace Voice API
  description: API for Menace Voice agents
  version: 1.0.0
servers:
  - url: https://voice.menaceui.com
    description: Production
  - url: http://localhost:8000
    description: Local development
paths:
  /api/v1/workflow/{workflow_id}/runs:
    post:
      tags:
        - main
      summary: Create Workflow Run
      description: >-
        Create a new workflow run when the user decides to execute the workflow
        via chat or voice


        Args:
            workflow_id: The ID of the workflow to run
            request: The create workflow run request
            user: The user to create the workflow run for
      operationId: create_workflow_run_api_v1_workflow__workflow_id__runs_post
      parameters:
        - name: workflow_id
          in: path
          required: true
          schema:
            type: integer
            title: Workflow Id
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: Authorization
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateWorkflowRunRequest"
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateWorkflowRunResponse"
        "404":
          description: Not found
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
components:
  schemas:
    CreateWorkflowRunRequest:
      properties:
        mode:
          type: string
          title: Mode
        name:
          type: string
          title: Name
      type: object
      required:
        - mode
        - name
      title: CreateWorkflowRunRequest
    CreateWorkflowRunResponse:
      properties:
        id:
          type: integer
          title: Id
        workflow_id:
          type: integer
          title: Workflow Id
        name:
          type: string
          title: Name
        mode:
          type: string
          title: Mode
        created_at:
          type: string
          format: date-time
          title: Created At
        definition_id:
          type: integer
          title: Definition Id
        initial_context:
          anyOf:
            - additionalProperties: true
              type: object
            - type: "null"
          title: Initial Context
      type: object
      required:
        - id
        - workflow_id
        - name
        - mode
        - created_at
        - definition_id
      title: CreateWorkflowRunResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: "#/components/schemas/ValidationError"
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
````