Skip to main content
POST
/
v1
/
ade
/
parse
/
jobs
cURL
curl -X POST 'https://api.va.landing.ai/v1/ade/parse/jobs' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -F 'document=@document.pdf' \
  -F 'model=dpt-2-latest' \ # Set the model (optional)
{
  "job_id": "12345678-1234-1234-1234-123456789012"
}

Authorizations

​
Authorization
string
header
required

Your unique API key for authentication.

Get your API key here: https://va.landing.ai/settings/api-key.

If using the EU endpoint, get your API key here: https://va.eu-west-1.landing.ai/settings/api-key.

Body

multipart/form-data
​
model
string | null

The version of the model to use for parsing.

​
document
file | null

A file to be parsed. The file can be a PDF or an image. See the list of supported file types here: https://docs.landing.ai/ade/ade-file-types. Either this parameter or the document_url parameter must be provided.

​
document_url
string | null

The URL to the file to be parsed. The file can be a PDF or an image. See the list of supported file types here: https://docs.landing.ai/ade/ade-file-types. Either this parameter or the document parameter must be provided.

​
split
enum<string> | null

If you want to split documents into smaller sections, include the split parameter. Set the parameter to page to split documents at the page level. The splits object in the API output will contain a set of data for each page.

Available options:
TitleConst
SplitTypepage
​
output_save_url
string | null

If zero data retention (ZDR) is enabled, you must enter a URL for the parsed output to be saved to. When ZDR is enabled, the parsed content will not be in the API response.

Response

Job queued successfully

​
job_id
string
required
⌘I