Skip to main content

​
OpenAPI user guide

Applications in ADP can be integrated into third-party systems through APIs. Before calling the APIs, go to the ADP platform and get your API key. Click your profile avatar, then open My API. My API entry in the ADP platform

​
API reference

Use the ADP API section in the sidebar to browse APIs by scenario and by underlying endpoint. Each endpoint page includes request parameters, response schemas, and examples.

​
Authentication

Document extraction, document recognition, application management, and credit usage APIs use the X-API-KEY request header. Workflow APIs use the X-API-Key request header.

​
Base URL

https://adp-global.laiye.com

​
File input

Document extraction and recognition APIs support two file input methods:
  • file_url: An online file URL. Only HTTP URLs are supported.
  • file_base64: The Base64 content of a local file.
Use either file_url or file_base64.