Convert MS Office Documents to Image Files

To convert an Office document to an image, post a multipart request to the /api/build endpoint(opens in a new tab), including both the Office file as the input and the instructions JSON(opens in a new tab). In response, you’ll receive a ZIP archive containing all of the document’s pages as images.

Converting an Office document to an image requires you to provide dimensions for the resulting rendered pages via a width, height, or dpi option(opens in a new tab).

Only one option — width, height, or dpi — can be chosen. Other dimensions are calculated before rendering, so as to preserve the page aspect ratio of the rendered image.

The format of the rendered images can be controlled via a format option(opens in a new tab). Supported image formats are PNG, JPEG, WEBP, and TIFF.

For more information, refer to the API reference to learn about the /api/build endpoint and all the actions you can perform on PDFs with Document Engine.

For an overview of multipart requests, refer to the brief tour of multipart requests blog post.

Converting an Office File on Disk to an Image

Send a multipart request to the /api/build endpoint(opens in a new tab), attaching an input file and the instructions JSON(opens in a new tab):

Terminal window
curl -X POST http://localhost:5000/api/build \
  -H "Authorization: Token token=<API token>" \
  -F document=@/path/to/example-document.docx \
  -F instructions='{
  "parts": [
    {
      "file": "document"
    }
  ],
  "output": {
    "type": "image",
    "format": "jpg",
    "dpi": 500
  }
}' \
  -o result.zip

Converting an Office File from a URL to an Image

Send a multipart request to the /api/build endpoint(opens in a new tab), attaching an input file and the instructions JSON(opens in a new tab):

Terminal window
curl -X POST http://localhost:5000/api/build \
  -H "Authorization: Token token=<API token>" \
  -F instructions='{
  "parts": [
    {
      "file": {
        "url": "https://pspdfkit.com/downloads/examples/paper.docx"
      }
    }
  ],
  "output": {
    "type": "image",
    "format": "jpg",
    "dpi": 500
  }
}' \
  -o result.zip