Sphereon BV

11/Oct/2018 13:06:07 PM CEST


Production and Sandbox Endpoints

Production and Sandbox URLs:

Sandbox Endpoints

Dev and test URLs:


The PDF conversion API 'conversion2pdf' converts image, office and PDF files to (searcheable) PDF files. The flow is generally as follows: 1. First create a job using the /conversion2pdf/jobs POST endpoint. You will get back a job response that contains a job with its associated settings. 2. Upload one or more images/files using the /conversion2pdf/jobs/{jobId}/streams/multipart POST endpoint. You can also add stream locations from the storage API . You will get back the update job response that contains a job with its associated settings. Currently you can only merge spreadsheets with spreadsheet, documents with documents and images/pdfs with images/pdfs 3. Start the job from a PUT request to the /conversion2pdf/jobs/{jobid} endpoint, with the Job and Settings JSON as request body. The conversion to PDF will now start. The OCR setting is only applicable to images, since other files will always be searchable. 4. Check the job status from the /conversion2pdf/jobs/{jobid} GET endpoint until the status has changed to DONE or ERROR. Messaging using a websocket will be available as an alternative in a future version 5. Retrieve the PDF file using the /conversion2pdf/jobs/{jobid}/streams/result GET endpoint. This will return the PDF file only when the status is DONE. In other cases it will return the Job Response JSON (with http code 202 instead of 200) Interactive testing: A web based test console is available in the Sphereon API Store

Business Information

Business Owner : Sphereon BV [support@sphereon.com]

Technical Owner : Sphereon Devops Team [dev@sphereon.com]



No comments yet


You require an access token to try the API. Please login and subscribe to the API to generate an access token.   If you already have an access token, please provide it below.

Warning! The selected application does not have an access token for the selected environment. Please go to the subscription page and generate an access token first.
Authorization : Bearer
Name Summary
Authentication Authenticate against the REST API View Content
API Documentation and SDKs Please see the URL for documentation and SDK's https://docs.sphereon.com/api/pdf/1.1/html