Document Thumbnail

Returns the intrinsic size (width, height in points/pixels) of every page in a document.#

Fast, non-rendering metadata call. Iterates the document's pages and reports their native dimensions so clients can pre-compute a viewer layout (reserved per-page heights, aspect ratios) before any page image is fetched. Works for PDFs, multi-page images (e.g. TIFF) and, when LibreOffice is installed, office documents (measured on their PDF rendering). Units are whatever the underlying format uses natively: PDF pages are in points (1pt = 1/72in), image frames are in pixels. Only the ratio matters for viewer layout.

Parameters

Responses

curl -X GET "$LMKIT_ONE_URL/lmkit/v1/document-thumbnail/$FILEID/page-sizes" \
  -H "Authorization: Bearer $LMKIT_API_KEY"

Lists file extensions the thumbnail endpoint can render.#

Returns the union of PDF, image and office extensions supported by this endpoint; office formats are listed only while a LibreOffice runtime is installed. Clients should call this once at startup (cache the result) and use it to decide whether to route a document into a paginated viewer or fall back to a generic display. Using this endpoint avoids hard-coded extension lists drifting from server capabilities.

Responses

curl -X GET "$LMKIT_ONE_URL/lmkit/v1/document-thumbnail/supported-formats" \
  -H "Authorization: Bearer $LMKIT_API_KEY"

Renders a page of a document (PDF, image or office document) as an image.#

Returns an image for a previously uploaded file. Supports PDF documents (any page), image files including TIFF, BMP, PNG, JPEG, GIF, and WebP, and, when LibreOffice is installed, office documents (Word, Excel, PowerPoint, OpenDocument and the other formats listed by 'supported-formats'). An office document's first page is answered from the preview image the file carries when it is large enough, otherwise from its PDF rendering, which is converted once and cached. For multi-page TIFF files, the 'page' parameter selects which frame to render. Output format is controlled by the 'format' parameter (jpeg, png, or webp; default jpeg). The response includes an 'X-Page-Count' header with the total number of pages in the document. Returns 422 Unprocessable Content if the file cannot be processed (e.g. encrypted PDF). The response includes the ProblemDetails error codes: 'password_required', 'invalid_format', 'unsupported_security', 'page_error'.

Parameters

Responses

curl -X GET "$LMKIT_ONE_URL/lmkit/v1/document-thumbnail/$FILEID" \
  -H "Authorization: Bearer $LMKIT_API_KEY"