Conversion API
This API contains a set of endpoints used by ADx client to run conversion jobs. These endpoints are not accessible from within ADx itself and they are not relevant (at least not directly) to ADx user. They could be used, for example, to test the internal Conversion functionality. Do not confuse these with ADx repository endpoints used to start a conversion job.
To access this API via Swagger, you need to open tribefire-services page of the Conversion node, as in https://hostname:port/tribefire-services
. Then, open the Swagger page as shown below:
You are presented with Conversion endpoints. Focus on Mapped Endpoints section, which only contains endpoints related to Conversion functionality (and not general platform endpoints).
Mapped Endpoints
These endpoints are used by ADx to complete conversion jobs. You can also trigger all of them from the UI - see Conversion Access for more information
Method | Endpoint | Description |
---|---|---|
POST | /conv/v1/cancel | Cancel Job |
POST | /conv/v1/cleanup | Clean Up Conversion Jobs |
POST | /conv/v1/create/combined | Combined Job |
POST | /conv/v1/create/document | Create 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 |
Corresponding GET endpoints are available under Generic Endpoints.