Document AI — DMS

Get document thumbnail

Get a thumbnail preview image of a specific document page. Returns base64-encoded WebP/JPEG image. Accepts pofid or documents_id. Use for document preview, visual comparison, page inspection.

get/documents/document-thumb-get/{pofid}/{page_number}

Request

  • Base URL: https://api.paperoffice.ai/latest
  • URL: https://api.paperoffice.ai/latest/documents/document-thumb-get/{pofid}/{page_number}
  • Auth: HTTP bearer

Path parameters

pofidstring required

PaperOffice File ID (POFID). At least one of pofid or documents_id MUST be provided.

page_numbernumber required

Page number (default: 1)

Query parameters

documents_idnumber

Numeric document ID — Alternative to pofid.

Response

Success

status'success' required
_billingobject

Changes

No recorded changes to this operation across all 1 revision of this API.