Skip to main content
Operations are created via:

Request schema (ExternalDoRequest)

  • action (required) – the operation to perform:
    • "convert"
    • "compress"
    • "merge"
    • "zip"
    • "lock"
    • "unlock"
    • "reset_password"
  • file_keys (required) – array of one or more file keys returned by upload.
  • parameters (optional) – action‑specific parameters (see below).
  • notes (optional) – arbitrary key‑value metadata persisted alongside the external operation.
Response (ExternalDoResponse):
Use main_task_id for status polling and correlating webhook notifications.

Create an operation

Supported operations

Before creating an operation, you can validate that a given extension and action are supported:
Server‑side this is backed by SupportedOperationRequest / SupportedOperationResponse:
Example responses:
  • Only ext provided – returns available_actions for that extension.
  • ext + action – returns supported + parameters metadata, such as:
    • valid convert_to targets for convert
    • valid compression_value options for compress

Action‑specific parameters

Convert

  • convert_to (required) – target format (e.g. pdf, png, docx).
Common use cases:
  • Document: docx → pdf, pdf → docx, pptx → pdf.
  • Image: jpg → png, png → webp.
  • Media: mp4 → mp3, wav → mp3.

Compress

  • compression_value – compression level such as recommended_compression, extreme_compression, or less_compression (see supported‑operation metadata).

Merge

Merges multiple compatible files (typically PDFs) into a single output file.

Zip

Creates a zip archive containing the given files.

Lock PDF

Protects PDFs with a password.

Unlock PDF

Removes password protection from PDFs.

Reset PDF password

Changes the password on password‑protected PDFs.