# 工作流运行接口

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/workflow/run:
    post:
      summary: 工作流运行接口
      deprecated: false
      description: |-
        详细说明参考：[工作流运行接口文档](https://docs.link-ai.tech/platform/api/workflow-run)
        该接口标准版及以上可用
      tags: []
      parameters:
        - name: Authorization
          in: header
          description: >-
            在 [LinkAI平台-应用接入](https://link-ai.tech/console/interface) 生成API
            Key并填入
          required: true
          example: Bearer YOUR_API_KEY
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                app_code:
                  type: string
                  title: 应用code
                  description: 应用或工作流的 code。若不填则表示不绑定具体应用，将请求直接传递给模型
                args:
                  type: object
                  properties: {}
                  x-apifox-orders: []
                  title: 工作流变量
                  description: 工作流输入变量，包括系统默认变量和自定义变量，在开始节点中定义
                session_id:
                  type: string
                  title: 会话ID
                  description: >-
                    每个session_id有独立的上下文记忆存储，大模型和应用节点开启记忆后即可使用。若该字段不填则系统会自动分配一个唯一标识，在响应中返回，下次请求时可传入该值
              x-apifox-orders:
                - app_code
                - args
                - session_id
              required:
                - args
                - session_id
            example:
              app_code: T8kjAqQw7o
              args:
                height: '1.8'
                weight: '75'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: 是否运行成功
                  code:
                    type: integer
                    description: 状态码
                  message:
                    type: string
                    description: 错误信息
                  data:
                    type: object
                    properties:
                      output_text:
                        type: string
                        description: 工作流输出文本
                    required:
                      - output_text
                    x-apifox-orders:
                      - output_text
                    description: 输出数据
                required:
                  - success
                  - code
                  - message
                  - data
                x-apifox-orders:
                  - success
                  - code
                  - message
                  - data
              example:
                success: true
                code: 200
                message: success
                data:
                  output_text: >-
                    您好！您的BMI值是23.15，这个结果处于正常范围（18.5-23.9之间）。恭喜您，保持在这个范围内是健康的标志！


                    为了进一步维护您的健康，建议您继续保持均衡的饮食和适量的运动。可以考虑增加一些富含纤维的食物，比如水果、蔬菜和全谷物，同时减少高糖和高脂肪食物的摄入。此外，每周至少进行150分钟的中等强度锻炼，比如快走、游泳或骑自行车，都是非常有益的。
          headers: {}
          x-apifox-name: 成功
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                    x-apifox-orders:
                      - type
                      - message
                required:
                  - error
                x-apifox-orders:
                  - error
              example:
                error:
                  type: invalid_request_error
                  message: 'Invalid request: user message content is empty'
          headers: {}
          x-apifox-name: 参数不正确
        '401':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                    x-apifox-orders:
                      - type
                      - message
                required:
                  - error
                x-apifox-orders:
                  - error
              example:
                error:
                  type: invalid_request_error
                  message: >-
                    Authentication failed, please check your API_KEY in
                    https://link-ai.tech/console/interface
          headers: {}
          x-apifox-name: API Key鉴权失败
        '402':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                    required:
                      - message
                    x-apifox-orders:
                      - message
                x-apifox-orders:
                  - error
              example:
                error:
                  message: App not found, please check your app_code param
          headers: {}
          x-apifox-name: 应用不存在
        '403':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                    required:
                      - message
                    x-apifox-orders:
                      - message
                x-apifox-orders:
                  - error
              example:
                error:
                  message: No app access permissions
          headers: {}
          x-apifox-name: 应用无访问权限
        '406':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                    required:
                      - message
                    x-apifox-orders:
                      - message
                x-apifox-orders:
                  - error
              example:
                error:
                  message: >-
                    You exceeded your current quota, please check your balance
                    in https://link-ai.tech/console/account
          headers: {}
          x-apifox-name: 余额不足
        '408':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
              example:
                success: false
                code: 408
                message: 当前版本无可用API访问权限
                data: null
          headers: {}
          x-apifox-name: 无API访问权限
        '409':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                    required:
                      - message
                    x-apifox-orders:
                      - message
                x-apifox-orders:
                  - error
              example:
                error:
                  message: Content sensitivity detection failed (内容合规检查不通过)
          headers: {}
          x-apifox-name: 内容审核不通过
        '503':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                    required:
                      - message
                    x-apifox-orders:
                      - message
                x-apifox-orders:
                  - error
              example:
                error:
                  message: >-
                    Server is too busy, please retry or contact the customer
                    service
          headers: {}
          x-apifox-name: 服务异常
      security: []
      x-apifox-folder: ''
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/3294133/apis/api-222894766-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.link-ai.tech
    description: 正式环境
security: []

```