Testing the conversion functionality
The Conversion API contains a set of endpoints used by the Document.One (D1) client to run conversion jobs.
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:
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 type | Endpoint | Service description |
|---|---|---|
| POST | /conv/v1/cancel | Cancel a conversion job |
| POST | /conv/v1/cleanup | Clean up conversion jobs |
| POST | /conv/v1/create/combined | Combined job |
| POST | /conv/v1/create/document | Create a document |
| POST | /conv/v1/create/extract-text | Extract text |
| POST | /conv/v1/create/html-to-pdf | HTML to PDF |
| POST | /conv/v1/create/image-to-hocr | Image to HOCR |
| POST | /conv/v1/create/image-to-image | Image to image |
| POST | /conv/v1/create/image-to-text | Image to text |
| POST | /conv/v1/create/images-to-pdf | Images to PDF |
| POST | /conv/v1/create/merge-pdfs | Merge PDFs |
| POST | /conv/v1/create/nooperation | No Operation |
| POST | /conv/v1/create/office-to-pdf | Office to PDF |
| POST | /conv/v1/create/pdf-to-hocr | PDF to HOCR |
| POST | /conv/v1/create/pdf-to-images | PDF to images |
| POST | /conv/v1/create/pdf-to-text | PDF to text |
| POST | /conv/v1/create/resize-image | Resize image |
| POST | /conv/v1/create/split-pdf | Split PDF |
| POST | /conv/v1/create/text-template | Text template to text |
| POST | /conv/v1/create/watermark-pdf | Watermark PDF |
| POST | /conv/v1/create/word-template | Word template to Word |
| GET | /conv/v1/status | Get 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.