Document Extraction

post

https://{endpoint}/v2/extract

Body Params

extractor_id

string

required

Extractor ID

image

file

The image file, can be a JPG, PNG or PDF file Either specify this or provide the image_url parameter

image_url

string

URL of the image to be processed in jpg or png format, or URL of a pdf file

pdf_dpi

number

Defaults to 150

DPI of the uploaded pdf file

ocr_engine

string

enum

OCR Engine

Allowed:

original_file_name

string

original file name

async

string

enum

Defaults to false

Flag for using the asynchronous mode

Allowed:

auto_adjust_image_size

string

enum

Defaults to true

Flag for auto adjusting image size for better extraction result, it will take a longer for extraction if enabled

Allowed:

output_ocr

string

enum

Defaults to false

Flag for returning OCR result in the response.

Allowed:

processing_mode

string

enum

Defaults to per-page

Processing mode: If set, it will override the processing mode setting on the specified extractor. Please note that the per-file mode is not supported by all models. When it is not applicable, only the first page of the file will be processed.

Allowed:

extra_data

string

length ≤ 2048

Pass extra data as ASCII string to FormX. For structured data, consider represent it as JSON. For string containing non-ASCII string, consider encode it with base64

import_to_accuracy_center

string

enum

Defaults to false

should import to accuracy center

Allowed:

Responses

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

202Accepted async extraction

4XXFailure