Skip to main content
GET
Get document family page image

Authorizations

x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

id
string<uuid>
required

Unique identifier (UUID) of the resource.

Query Parameters

page
string

Page number (1-indexed). Defaults to 1 (first page).

dpi
string

Resolution in DPI for rendering. Lower values produce smaller thumbnails. Defaults to 72.

Response

Page image

The response is of type file.