Sign in

v6

latestOpenAPI 3.1.0raw.githubusercontent.com2025-06-241833312.7 KB
PDF Operations

Render PDF pages as images

Creates a task to render specified pages of a PDF file as images.

post/v1/pdf-operations/render

Request body

inputstring required

The id of the file or task to operate on.

namestring

The name of the file

dpiinteger

Dots per inch (DPI) for the rendered image. Default is 300.

pagesstring

Page range (e.g., 2-7), a comma-separated list (e.g., 2,3,7) of pages.

callback_urlstring uri

The URL to call when the task is completed or failed. If you want to receive events, you probably prefer to use webhooks instead.

Example request

{
  "input": "file_avyrvozb9302uwhq",
  "name": "File Name",
  "dpi": 300,
  "pages": "2-7",
  "callback_url": "https://example.com/callback"
}

Response

Task created successfully. Returns the task details.

OR
OR
OR

Example response

{
  "id": "task_euyrvozb9302uwhq",
  "operation": "render",
  "parameters": {
    "input": "file_avyrvozb9302uwhq",
    "name": "File Name",
    "dpi": 300,
    "pages": "2-7",
    "callback_url": "https://example.com/callback"
  },
  "status": "completed",
  "result": {
    "generated_files": [
      {
        "id": "file_euyrvozb9302uwhq",
        "name": "Example Image",
        "type": "image/png",
        "properties": {
          "size": 1024,
          "width": 800,
          "height": 600
        },
        "task_id": "task_euyrvozb9302uwhq",
        "created_at": "2021-05-01T12:00:00Z"
      }
    ]
  },
  "callback_url": "https://example.com/callback",
  "created_at": "2021-05-01T12:00:00Z",
  "updated_at": "2021-05-01T12:00:00Z"
}