Convert

Convert a bundle of files

Converts every file in a ZIP or file list that matches bundle_type; the rest are treated as assets for the pages. Send exactly one of s3_key, zip_base64 or files, or use multipart. Requires bulk_enabled on the plan.

post/bulkjob

Request

  • Base URL: https://api.podpdf.com
  • URL: https://api.podpdf.com/bulkjob
  • Auth: API key in header X-API-Key

Request body

bundle_type'html' | 'markdown'
s3_keystring

Key from /bulkjob/upload-url.

zip_base64string

Base64 ZIP, up to 4 MB decoded.

email_notificationboolean

false skips the "bulk job finished" email for this job. Omit to follow the account's email settings; true cannot turn it on when job emails are off.

Example request

{
  "files": [
    {
      "path": "invoice-1.html"
    }
  ],
  "options": {
    "margin": {
      "top": "20mm",
      "right": "20mm",
      "bottom": "20mm",
      "left": "20mm"
    },
    "width": "100mm",
    "height": "150mm",
    "pageRanges": "1-3, 5"
  }
}

Response

Queued

job_idstring
statusstring
job_typestring
bundle_typestring
messagestring

Example response

{
  "job_id": "9f0a4b78-2c0c-4d14-9b8b-123456789abc",
  "status": "queued",
  "job_type": "bulk",
  "bundle_type": "html"
}

Changes

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