Deprecated APIs for (Re-)Fetching Processing Results and Artifacts#
Danger
The processing results endpoints on this page are deprecated and being replaced by new /processing endpoints that serve the same requirements.
You can find more information about the new endpoints in Fetch Processing Results and Artifacts.
This document is meant as a maintenance reference for pre-existing client implementations.
Sub PDFs#
GET /processing/results/{processing_id}/sub-pdfs
Generated as part of the document splitting process, providing URL maps to download the split PDFs. Similar to the document splitting result, this result is only available as part of workflows that implement document splitting.
Response Details#
On success, this endpoint returns an application/json document.
The response returns a list of links, following the format detailed below:
[
"/processing/results/181eb796-509b-4b34-bdde-4fddb8f5fb70/sub-pdfs/0",
"/processing/results/181eb796-509b-4b34-bdde-4fddb8f5fb70/sub-pdfs/1"
]
Individual Sub PDFs#
GET /processing/results/{processing_id}/sub-pdfs/{index}
Retrieves a PDF file for a sub-document based on the results of the document splitting process, specified by the given split point index.
This endpoint corresponds to the download paths returned by GET /processing/results/{processing_id}/sub-pdfs.
Additional Parameters#
| Field | Type | Description |
|---|---|---|
jpeg_quality |
int (optional) | Defines the quality of the pdf images. The higher the value, the better the image quality and bigger the output file size. Valid range is from 1 to 100. |
pdfa_compliant |
bool (optional) | Defines if the PDF should be made PDF/A compliant. |
image_height |
int (optional) |
The size of the rendered images' short side in pixels.
For portrait orientation images, this corresponds to the width.
If image_height is not given, it will be calculated from dpi, page_height and page_width.
If page_height and page_width are not given, image_height will be derived from the original image aspect ratio.
|
image_width |
int (optional) |
The size of the rendered images' short side in pixels.
For portrait orientation images, this corresponds to the width.
If image_height is not given, it will be calculated from dpi, page_height and page_width.
If page_height and page_width are not given, image_height will be derived from the original image aspect ratio.
|
page_height |
float (optional) |
The size of the PDF pages' long side in millimeters.
For portrait orientation pages, this corresponds to the height.
If specified, page_width will be required.
|
page_width |
float (optional) |
The size of the PDF pages' short side in millimeters.
For portrait orientation pages, this corresponds to the width.
If specified, page_height will be required.
|
dpi |
int (optional) | The resolution of the rendered PDF document in pixels per inch. The default value is 220. Higher values result in better image quality but also increase file size. |
return_pages_with_ocr_data |
bool (optional) |
Defines whether the sub-document should be directly split out of the original uploaded PDF document rather than be rendered based on the processing results.
Note that the original PDF pages will be returned as-is and will not benefit from augmented OCR information, orientation and skew correction and cropping.
This setting overrides all parameters regarding image quality and archival compliance and is only supported if the originally uploaded document is in PDF format.
The default value is true.
|
Hint
For self-trained splitting models that are configured to crop uploaded documents, keep in mind the following special behavior of the endpoint when the return_pages_with_ocr_data parameter is set to false:
If you have trained your splitting model to split scanned pages that contain e.g. two receipts on a single page into two sub-documents, then GET /processing/results/{processing_id}/sub-pdfs/{index} will return the same original PDF page containing both receipts for both sub-document indices.
Please consider using the endpoint with the default setting true for return_pages_with_ocr_data if your use case requires different PDFs for sub-documents that are cropped from the same page.
Response Details#
On success, this endpoint returns an application/pdf response.