Render a document page as PNG

GET

/v1/documents/{id}/pages/{n}.png

const url = 'http://localhost:8080/v1/documents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/pages/1.png';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/v1/documents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/pages/1.png

Returns page n (1-based) rendered at documents.page_render_dpi; the render is cached beside the original and the response carries Cache-Control: private, max-age=3600. Any staff role or an API key with status:read. 404 for an unknown document, a page outside the document, or a LAR that is not a PDF.

Parameters

Path Parameters

required

string format: uuid

required

integer format: int32

/^-?(?:0|[1-9]\d*)$/

Render a document page as PNG

Parameters

Path Parameters

Responses

200