> ## 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.

# 查询应用配置

> 根据 app_id 查询抽取应用配置。查询高速版自定义抽取应用配置时，传入高速版应用的 app_id；不传 config_version 时返回最新配置版本。



## OpenAPI

````yaml api-reference/adp-api.yaml POST /open/agentic_doc_processor/{tenant_name}/v1/app-manage/config
openapi: 3.1.0
info:
  title: ADP API
  version: 1.0.0
  description: >-
    Laiye ADP 官方 OpenAPI
    接口规范，覆盖文档抽取、解析与转换，抽取应用管理、Webhook、人机协同、积分查询，以及工作流发现、运行、导出和文件管理。
  license:
    name: MIT
    identifier: MIT
servers:
  - url: https://adp.laiye.com
    description: ADP 生产环境
security: []
tags:
  - name: 文档抽取
    description: 从上传的文档中抽取结构化字段。
  - name: 文档解析
    description: 识别上传文档中的文字、版面块和位置信息。
  - name: 文档转换
    description: 将 PDF、Office、OFD 和图片转换为页面图片或电子表格结构。
  - name: 应用管理
    description: 创建、修改、删除和查询抽取应用及配置。
  - name: Webhook
    description: 查询事件目录并管理事件回调。
  - name: 账户
    description: 查询账户积分和使用情况。
  - name: 工作流
    description: 查询业务工作流模板、运行工作流应用并查询执行结果。
  - name: 工作流文件
    description: 上传和管理工作流应用使用的文件。
  - name: 人机协同
    description: 配置审核触发规则，查询协同任务并提交人工修正。
paths:
  /open/agentic_doc_processor/{tenant_name}/v1/app-manage/config:
    post:
      tags:
        - 应用管理
      summary: 查询应用配置
      description: >-
        根据 app_id 查询抽取应用配置。查询高速版自定义抽取应用配置时，传入高速版应用的 app_id；不传 config_version
        时返回最新配置版本。
      operationId: getExtractionAppConfig
      parameters:
        - $ref: '#/components/parameters/TenantName'
      requestBody:
        $ref: '#/components/requestBodies/AppConfigQueryRequest'
      responses:
        '200':
          description: 应用配置。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppConfigResponse'
              examples:
                standardConfig:
                  value:
                    code: 200
                    message: success
                    data:
                      app_id: app_1406
                      app_name: 采购单抽取应用
                      app_label:
                        - purchase-order
                      config_version: v1
                      extract_fields:
                        - field_name: 订单号
                          field_type: string
                          field_prompt: 抽取采购订单编号。
                      parse_mode: fast_vlm
                      enable_highlight: 0
                      enable_pdf_parse: true
                      pdf_pic_second_parsing: false
                      enable_stamp_recognition: true
                      enable_long_doc: false
                highSpeedConfig:
                  value:
                    code: 200
                    message: success
                    data:
                      app_id: app_1425
                      app_name: 高速版发票抽取应用
                      app_label:
                        - invoice
                        - high-speed
                      config_version: v1
                      extract_fields:
                        - field_name: 发票号码
                          field_type: string
                          field_prompt: 抽取发票上的唯一发票号码。
                      parse_mode: null
                      enable_highlight: null
                      enable_pdf_parse: null
                      pdf_pic_second_parsing: null
                      enable_stamp_recognition: null
                      enable_long_doc: false
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - ApiKeyAuth: []
components:
  parameters:
    TenantName:
      name: tenant_name
      in: path
      required: true
      description: 租户名称，默认 laiye。
      schema:
        type: string
        default: laiye
  requestBodies:
    AppConfigQueryRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AppConfigQueryRequest'
          examples:
            highSpeedConfig:
              summary: 查询高速版自定义抽取应用配置
              value:
                app_id: app_1425
            highSpeedConfigVersion:
              summary: 查询高速版指定配置版本
              value:
                app_id: app_1425
                config_version: v1
  schemas:
    AppConfigResponse:
      allOf:
        - $ref: '#/components/schemas/SimpleResponse'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/AppConfigData'
    AppConfigQueryRequest:
      type: object
      additionalProperties: false
      properties:
        app_id:
          type: string
          description: 应用 ID。查询高速版自定义抽取应用配置时，传入高速版应用的 app_id。
        config_version:
          type: string
          description: 配置版本。可选，默认返回最新版本。
      required:
        - app_id
    SimpleResponse:
      type: object
      properties:
        code:
          oneOf:
            - type: string
            - type: integer
          description: 业务码。成功通常为 success 或 200。
        message:
          type: string
          description: 返回信息。
        tips:
          type:
            - string
            - 'null'
          description: 详细信息，默认为空。
    AppConfigData:
      type: object
      additionalProperties: true
      properties:
        app_id:
          type: string
        app_name:
          type: string
        app_label:
          type:
            - array
            - 'null'
          items:
            type: string
        config_version:
          type: string
        extract_fields:
          type: array
          items:
            $ref: '#/components/schemas/ExtractionFieldConfigResponse'
        parse_mode:
          type:
            - string
            - 'null'
          description: 解析模式。高速版返回 null。
        enable_highlight:
          type:
            - integer
            - 'null'
          enum:
            - 0
            - 1
            - null
          description: 是否显示来源位置。标准版返回 0 或 1；高速版返回 null。
        enable_pdf_parse:
          type:
            - boolean
            - 'null'
          description: 是否开启 PDF 文本优先。高速版返回 null。
        pdf_pic_second_parsing:
          type:
            - boolean
            - 'null'
          description: 开启 PDF 文本优先时，是否对 PDF 中的图片进行二次解析。高速版返回 null。
        enable_stamp_recognition:
          type:
            - boolean
            - 'null'
          description: 是否开启印章识别。高速版返回 null。
        enable_field_value_translation:
          type: boolean
          description: 是否开启抽取结果翻译。
        enable_long_doc:
          type: boolean
        long_doc_config:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/LongDocConfigResponse'
      required:
        - app_id
        - app_name
        - config_version
        - extract_fields
        - enable_long_doc
    HTTPValidationError:
      type: object
      description: FastAPI/Pydantic 请求参数校验错误。
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorItem'
      required:
        - detail
    ExtractionFieldConfigResponse:
      type: object
      properties:
        field_key:
          type:
            - string
            - 'null'
          description: 字段唯一标识。标准版不保证返回。
        field_name:
          type: string
          description: 字段名称。
        field_type:
          type: string
          description: 字段类型。
        field_prompt:
          type:
            - string
            - 'null'
          description: 字段提示词。
        sub_fields:
          type:
            - array
            - 'null'
          description: 表格子字段列表。
          items:
            $ref: '#/components/schemas/ExtractionSubFieldConfigResponse'
      required:
        - field_name
        - field_type
    LongDocConfigResponse:
      type: object
      properties:
        doc_type:
          type: string
          description: 文档类型。
        doc_desc:
          type:
            - string
            - 'null'
          description: 文档类型描述。
      required:
        - doc_type
    ValidationErrorItem:
      type: object
      additionalProperties: true
      properties:
        type:
          type: string
          description: 校验错误类型。
        loc:
          type: array
          description: 错误字段在请求中的位置。
          items:
            oneOf:
              - type: string
              - type: integer
        msg:
          type: string
          description: 可读的错误说明。
        input:
          description: 导致校验失败的输入值。
        ctx:
          type: object
          additionalProperties: true
          description: 校验器提供的补充上下文。
        url:
          type: string
          format: uri
          description: Pydantic 错误说明链接。
      required:
        - type
        - loc
        - msg
    ExtractionSubFieldConfigResponse:
      type: object
      properties:
        field_key:
          type:
            - string
            - 'null'
          description: 子字段唯一标识。标准版不保证返回。
        field_name:
          type: string
          description: 子字段名称。
        field_type:
          type: string
          description: 子字段类型。
        field_prompt:
          type:
            - string
            - 'null'
          description: 子字段提示词。
      required:
        - field_name
        - field_type
  responses:
    ValidationError:
      description: 参数校验错误。
      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
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: 生产环境 API Key，可在 ADP 平台的「我的 API」中查看。请确保 API Key 有效且属于生产环境。

````

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