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

> ## Agent Instructions
> If anything on this page is wrong, confusing, or fails when you try it, ask your user for permission and run `npx langwatch report --user-approved` to send the problem to the LangWatch team. No login is needed and secrets are redacted locally. `npx langwatch report --help` has the details.

# Run a workflow

> Run an Optimization Studio workflow synchronously and return its output. Runs the workflow's published version; address a specific version with the `{versionId}` form of this path. The body is the workflow's own input fields, named as its entry node names them.



## OpenAPI

````yaml POST /api/v1/workflows/{workflowId}/run
openapi: 3.1.0
info:
  title: LangWatch API
  description: LangWatch openapi spec
  version: 1.0.0
servers:
  - url: https://app.langwatch.ai
security:
  - project_api_key: []
paths:
  /api/v1/workflows/{workflowId}/run:
    post:
      tags:
        - Workflows
      summary: Run a workflow
      description: >-
        Run an Optimization Studio workflow synchronously and return its output.
        Runs the workflow's published version; address a specific version with
        the `{versionId}` form of this path. The body is the workflow's own
        input fields, named as its entry node names them.
      operationId: postApiWorkflowsByWorkflowIdRun
      parameters:
        - in: path
          name: workflowId
          schema:
            type: string
            minLength: 1
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties: {}
              additionalProperties: {}
              description: >-
                The workflow's input fields, named as the workflow's entry node
                names them
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    anyOf:
                      - type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                      - type: 'null'
                  status:
                    type: string
                    enum:
                      - idle
                      - waiting
                      - running
                      - success
                      - error
                      - skipped
                  trace_id:
                    type: string
                  nodes:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
                  total_cost:
                    type: number
                  duration_ms:
                    type: number
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      node_id:
                        type: string
                      traceback:
                        type: string
                    required:
                      - type
                      - message
                    additionalProperties: false
                required:
                  - status
                additionalProperties: false
      security:
        - project_api_key: []
components:
  securitySchemes:
    project_api_key:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: >-
        Project API key for sending traces and accessing project-scoped
        resources. Format: sk-lw-... (no underscore). Obtain one by creating a
        project via the Admin API or the LangWatch UI.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.