1. Home
  2. Knowledge Base
  3. Set Document Thumbnail

Set Document Thumbnail


Add or replace a thumbnail of an existing document. The thumbnail needs to be an RGB or RGBA PNG or JPEG. If DocumentGUID does not exist – error will be shown (DocumentGUID – returned by api call Create Document).


POST: http://api.aurelon.com/api/v2/document/<DocumentGUID>/thumbnail/<PageNumber>

Request Parameters:

    • DocumentGUID : GUID, required : GUID of the document
    • PageNumber : int, optional : Page of the document, default 1

Request Headers:

Content-Type : image/png
MisKey : see Authentication

Request Body:

Binary content of the PNG or JPEG.


Content type application/json containing the result of the operation.


200 OK : { “Message”:”Document thumbnail successfully saved”, “ThumbnailGUID”: “00092EA6-fb01-11e5-9b85-793ef2c92c66” }


  • 401 Unauthorised : {“Message”:”Invalid MisKey”}
  • 401 Unauthorised : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
  • 404 Not Found : {“Message”:”DocumentGUID is not found”}
  • 500 Internal Server Error : {“Message”:”Internal Server Error”}
Updated on May 19, 2022

Was this article helpful?