Get content object page image

Returns a rendered page image (PNG) of the content object. Use the page parameter to specify which page to render.

GET /api/content-objects/{id}/image

Get content object page image

cURL

curl --request GET \
  --url https://platform.kodexa.ai/api/content-objects/{id}/image \
  --header 'x-api-key: <api-key>'

200

"<string>"

Authorizations

x-api-keybearerAuth

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

200

image/png

Page image

The response is of type file.