Skip to main content
POST

Authorizations

​
X-API-KEY
string
header
required

Production OpenAPI Accessor access_key. You can find it in My API in the ADP platform. If the key is disabled, expired, or does not belong to the production environment, the API returns Accessor not found.

Path Parameters

​
tenant_name
string
default:laiye
required

Tenant name. Default: laiye.

Body

application/json

Set ai_function first. Use the standard custom extraction application parameters when ai_function is 1406. Use the high-speed custom extraction application parameters when ai_function is 1425.

​
ai_function
enum<integer>
default:1406
required

Application type. Use 1406 to create a standard custom extraction application. If omitted, the API handles the request as 1406 by default.

Available options:
1406
​
app_name
string
required

Application name.

Required string length: 1 - 100
​
extract_fields
object[]
required

Extraction field configuration list. Up to 20 fields.

Maximum array length: 20
​
parse_mode
enum<string>
required

Parsing mode. Required for standard custom extraction applications. Mode capabilities match the Web parsing configuration:

  • standard: Standard parsing for clear digital documents. Supports source locations, PDF text first, and stamp recognition.
  • advance: Enhanced parsing 1.0 for documents with stamps, signatures, multiple tables, or moderately complex layouts. Source locations are not supported.
  • fast_vlm: Enhanced parsing 2.0 for complex layouts, scanned files, and multi-table documents. Supports source locations, PDF text first, and stamp recognition.
  • agentic: Smart parsing that combines multiple models for complex documents. Supports source locations, PDF text first, and stamp recognition.
Available options:
standard,
advance,
fast_vlm,
agentic
​
app_label
string[]

Application labels. Up to 5 labels.

Maximum array length: 5
​
enable_highlight
enum<integer>
default:1

Whether to include source locations. Pass 1 to enable or 0 to disable. Supported by standard, fast_vlm, and agentic. Not supported by advance.

Available options:
0,
1
​
enable_pdf_parse
boolean
default:false

Whether to prefer PDF text extraction. Use this for digital PDFs with selectable text to improve processing speed and text stability.

​
pdf_pic_second_parsing
boolean
default:false

When PDF text extraction is enabled, whether to run secondary parsing on images inside the PDF.

​
enable_stamp_recognition
boolean
default:false

Whether to enable stamp recognition. The service attempts to recognize stamp information in the document. Stamp recognition capability must be enabled.

​
enable_field_value_translation
boolean
default:false

Whether to enable extracted value translation. Disabled by default.

​
enable_long_doc
boolean
default:false

Whether to enable long document support.

​
long_doc_config
object[]

Long document configuration. Used only when enable_long_doc is true.

Maximum array length: 5

Response

Extraction application result.

​
code

Business code. A successful response is usually success or 200.

​
message
string

Response message.

​
tips
string | null

Details. Defaults to null.

​
data
object