Sign in

v1

latestOpenAPI 3.0.02026-07-135965404.0 KB
Resources

Preview a file

Returns a resized image of the specified document for supported file types.

Image data returned is encoded in base64 format and can be viewed using the <img> element.

<img src='data:image/jpeg;base64' + meta.image/>

Notes:

  • Supported files types are 'jpg', 'jpeg', 'gif', 'png', 'bmp', 'pdf', 'psd', 'doc'
get/resources/preview

Query parameters

resourcestring required

Resource identifier for the image file.

size'small' | 'medium' | 'large' required

The size of the image.

widthinteger

Overrides sizes. Sets to a specific width.

heightinteger

Overrides sizes. Sets to a specific height.

pageinteger

Page number to extract from a multi-page document (0 is the first page). Vaild for .pdf or .doc files.

Headers

ev-api-keystring required
Example:exampleaccount-zwSuWUZ8S38h33qPS8v0s

API Key

ev-access-tokenstring required
Example:19853ef63a0bc348024a9e4cfd4a92520d2dfd04e88d8679fb1ed6bc551593d1

Access Token

Response

Successful Operation

responseStatusinteger

HTTP Status Code

Example response

{
  "responseStatus": 200,
  "data": {
    "id": 1,
    "type": "preview",
    "attributes": {
      "image": "iVBORw0KGgoAAAANSUhEUgAAACIAAAAoCAYAAACb3CikAAAABGdBTUEAALGPC",
      "size": 2186,
      "imageHash": "6afaa3ef4056dc602ccfc69ab52d6f40",
      "pageCount": 10
    }
  }
}