> ## Documentation Index
> Fetch the complete documentation index at: https://adp-doc.laiye.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Run workflow application (sync)

> Run the published workflow application version synchronously and wait for the result.



## OpenAPI

````yaml en/api-reference/adp-api.yaml POST /open/agentic_engine/laiye/v1/app/run
openapi: 3.1.0
info:
  title: ADP API
  version: 1.0.0
  description: >-
    Laiye ADP OpenAPI reference for document extraction, recognition, and
    conversion; extraction application management; webhooks; human
    collaboration; credit usage; workflow discovery, runs, exports, and file
    management.
  license:
    name: MIT
    identifier: MIT
servers:
  - url: https://adp-global.laiye.com
    description: ADP global production endpoint
security: []
tags:
  - name: Document extraction
    description: Extract structured fields from uploaded documents.
  - name: Document recognition
    description: Recognize text, layout blocks, and positions from uploaded documents.
  - name: Document conversion
    description: >-
      Convert PDFs, Office documents, OFD files, and images into page images or
      native spreadsheet structures.
  - name: Application management
    description: >-
      Create, update, delete, and query extraction applications and
      configurations.
  - name: Webhook
    description: List system events and manage event callbacks.
  - name: Account
    description: Query credit usage.
  - name: Workflow
    description: >-
      List business workflow templates, run workflow applications, and query run
      results.
  - name: Workflow files
    description: Upload and manage files used by workflow applications.
  - name: Human collaboration
    description: >-
      Configure review triggers, query collaboration tasks, and submit human
      corrections.
paths:
  /open/agentic_engine/laiye/v1/app/run:
    post:
      tags:
        - Workflow
      summary: Run workflow application (sync)
      description: >-
        Run the published workflow application version synchronously and wait
        for the result.
      operationId: runWorkflowApp
      requestBody:
        $ref: '#/components/requestBodies/WorkflowRunRequest'
      responses:
        '200':
          $ref: '#/components/responses/WorkflowRunResponse'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - EngineApiKeyAuth: []
components:
  requestBodies:
    WorkflowRunRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WorkflowRunRequest'
  responses:
    WorkflowRunResponse:
      description: Workflow run result.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WorkflowRunResponse'
          example:
            code: success
            message: ''
            data:
              run_id: run_abc123
              status: succeeded
              output:
                answer: Completed
              error: null
              started_at: '2026-04-30T10:00:00Z'
              ended_at: '2026-04-30T10:00:15Z'
    ValidationError:
      description: Validation error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/HTTPValidationError'
          example:
            detail:
              - type: greater_than
                loc:
                  - query
                  - limit
                msg: Input should be greater than 0
                input: 0
                ctx:
                  gt: 0
  schemas:
    WorkflowRunRequest:
      type: object
      additionalProperties: false
      properties:
        application_id:
          type: string
        release_version_id:
          type: string
        session_id:
          type: string
        files:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowInputFile'
        inputs:
          type: object
          additionalProperties: true
          description: >-
            Workflow input values. Available fields are defined by the input
            configuration of the target published workflow version.
          properties:
            query:
              type: string
              description: >-
                Common text input example. A workflow can define any other
                fields.
      required:
        - application_id
    WorkflowRunResponse:
      allOf:
        - $ref: '#/components/schemas/SimpleResponse'
        - type: object
          properties:
            data:
              type: object
              properties:
                run_id:
                  type: string
                status:
                  type: string
                  enum:
                    - pending
                    - running
                    - succeeded
                    - failed
                    - cancelled
                    - paused
                    - timeout
                output:
                  type:
                    - object
                    - 'null'
                  additionalProperties: true
                error:
                  type:
                    - string
                    - 'null'
                started_at:
                  type:
                    - string
                    - 'null'
                  format: date-time
                ended_at:
                  type:
                    - string
                    - 'null'
                  format: date-time
    HTTPValidationError:
      type: object
      description: FastAPI/Pydantic request validation error.
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorItem'
      required:
        - detail
    WorkflowInputFile:
      type: object
      additionalProperties: false
      properties:
        url:
          type: string
        name:
          type: string
        mime_type:
          type: string
        size:
          type: integer
        metadata:
          type:
            - object
            - 'null'
          additionalProperties: true
          description: Custom metadata passed with the file to the workflow.
      required:
        - url
        - name
        - mime_type
    SimpleResponse:
      type: object
      properties:
        code:
          oneOf:
            - type: string
            - type: integer
          description: Business code. A successful response is usually success or 200.
        message:
          type: string
          description: Response message.
        tips:
          type:
            - string
            - 'null'
          description: Details. Defaults to null.
    ValidationErrorItem:
      type: object
      additionalProperties: true
      properties:
        type:
          type: string
          description: Validation error type.
        loc:
          type: array
          description: Location of the invalid field in the request.
          items:
            oneOf:
              - type: string
              - type: integer
        msg:
          type: string
          description: Human-readable validation error message.
        input:
          description: Input value that failed validation.
        ctx:
          type: object
          additionalProperties: true
          description: Additional context supplied by the validator.
        url:
          type: string
          format: uri
          description: Link to the Pydantic error documentation.
      required:
        - type
        - loc
        - msg
  securitySchemes:
    EngineApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key for workflow endpoints.

````

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