Skip to main content
POST

Authorizations

X-API-KEY
string
header
required

Production API Key. You can find it under My API in the ADP platform. Make sure the API Key is active and belongs to the production environment.

Path Parameters

tenant_name
string
default:laiye
required

Tenant name. Default: laiye.

Body

application/json
file_url
string<uri>
required

Public HTTPS URL of the file to convert. Do not pass an internal-network URL or a URL containing long-lived credentials.

Maximum string length: 2048
file_base64
string<byte>

Base64 content of the file to convert. The decoded file can be at most 50 MiB.

scale
number
default:1

Page scale factor. The server currently exposes no stable upper bound; use the default value unless necessary.

first_convert_page
integer

First page to convert, starting at 1. Omit it to start from the first page.

Required range: x >= 1
last_convert_page
integer

Last page to convert, starting at 1 and not less than the first page. Omit it to continue through the last page.

Required range: x >= 1
result_mode
enum<string>
default:url

How page images are returned. URLs are temporary; Base64 significantly increases the response size.

Available options:
url,
base64

Response

Document conversion result. While processing is in progress or after a failure, the service may return an empty result or data=null.

code

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

message
string

Response message.

tips
string | null

Details. Defaults to null.

data
object | null