Extract Images

Introduction

This REST API provides the functionality to extract images from the document. There are following ways to extract images from a document:

  • Extract all images from the whole document;
  • Extract images from specific document pages by setting pages range.

It saves extracted images to the storage so they can be easily downloaded. The API allows extracting images from containers like ZIP archives, PDF portfolios, Email attachments, MS Outlook storages (PST/OST). For protected documents, it is also required to provide a password.

The table below contains the full list of properties that can be specified when extracting images from a document.

NameDescriptionComment
FileInfo.FilePathThe path of the document, located in the storage.Required.
FileInfo.StorageNameStorage nameIt could be omitted for default storage.
FileInfo.PasswordThe password to open fileIt should be specified only for password-protected documents.
ContainerItemInfo.RelativePathThe relative path of the container.Should be specified only for container files like ZIP archives, emails or PDF portfolios.
ContainerItemInfo.PasswordPassword for processing password-protected container items.It should be specified only for password-protected container items.
StartPageNumberExtraction start page.The zero-based index.Extracts from the whole document if not specified.
CountPagesToExtractThe number of pages to extract.Required if StartPageNumber is specified.

Resource URI


HTTP POST ~/images

Swagger UI lets you call this REST API directly from the browser. 

Use Cases