Documents

A page as an image, with rulers and the fields placed on it

Renders one page of the uploaded PDF as a PNG. Rulers labelled in points from the top-left corner are drawn on it, which is the frame field positions use, so a caller that places fields by eye reads coordinates off the page instead of converting pixels. Fields already placed are outlined, so it can check its own work.

get/api/v1/documents/{id}/pages/{pageNumber}/image

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/documents/{id}/pages/{pageNumber}/image
  • Auth: one of:
    • API key in header X-API-Key
    • bearer (a scheme the document does not define)

Path parameters

idstring required
pageNumbernumber required

Query parameters

rulersboolean

Draw rulers labelled in points from the top-left corner, the frame field positions use

fieldsboolean

Outline the fields already placed on this page

Response

pageNumbernumber required
pageCountnumber required

Pages in the document

widthPointsnumber required

Page width in PDF points

heightPointsnumber required

Page height in PDF points

pixelsPerPointnumber required

Image pixels per PDF point. Divide a pixel position by this to get the point position a field takes.

fieldsShownnumber required

Fields outlined on the image

pngBase64string required

The page as a PNG, base64-encoded

Example response

{
  "pageNumber": 1,
  "widthPoints": 612,
  "heightPoints": 792,
  "pixelsPerPoint": 2,
  "fields": [
    {
      "number": 1
    }
  ]
}

Changes

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