Skip to main content
Version: 2.8

Testing the conversion functionality

The Conversion API contains a set of endpoints used by the Document.One (D1) client to run conversion jobs.

NOTE

The Conversion API endpoints and the D1 repository endpoints used to start a conversion job, are not the same. The Conversion API endpoints could be used, for example, to test the internal Conversion functionality. These endpoints are not accessible from within D1 itself, and they are not relevant (at least not directly) to the D1 user.

To access the Conversion API via OpenAPI, you need to open the tribefire-services page of the Conversion node, as in https://hostname:port/tribefire-services. Then, open the OpenAPI page as shown below:

Accessing the Conversion API

You are presented with the Conversion endpoints. Focus on the Mapped endpoints section, which only contains endpoints related to the Conversion functionality (and not the general platform endpoints).

Mapped endpoints

These endpoints are used by D1 to complete conversion jobs:

HTTP request typeEndpointService description
POST/conv/v1/cancelCancel a conversion job
POST/conv/v1/cleanupClean up conversion jobs
POST/conv/v1/create/combinedCombined job
POST/conv/v1/create/documentCreate a document
POST/conv/v1/create/extract-textExtract text
POST/conv/v1/create/html-to-pdfHTML to PDF
POST/conv/v1/create/image-to-hocrImage to HOCR
POST/conv/v1/create/image-to-imageImage to image
POST/conv/v1/create/image-to-textImage to text
POST/conv/v1/create/images-to-pdfImages to PDF
POST/conv/v1/create/merge-pdfsMerge PDFs
POST/conv/v1/create/nooperationNo Operation
POST/conv/v1/create/office-to-pdfOffice to PDF
POST/conv/v1/create/pdf-to-hocrPDF to HOCR
POST/conv/v1/create/pdf-to-imagesPDF to images
POST/conv/v1/create/pdf-to-textPDF to text
POST/conv/v1/create/resize-imageResize image
POST/conv/v1/create/split-pdfSplit PDF
POST/conv/v1/create/text-templateText template to text
POST/conv/v1/create/watermark-pdfWatermark PDF
POST/conv/v1/create/word-templateWord template to Word
GET/conv/v1/statusGet job status

You can also trigger all of them from the user interface.

See Conversion access for more information.

Corresponding GET endpoints are available under Generic Endpoints.