Encrypt a PDF with password protection. Provide a user password (to open) and/or an owner password (to edit). At least one is required.
API Key (starts with ak_...)
File ID of the PDF to protect
"550e8400-e29b-41d4-a716-446655440000"
User password (required to open the PDF). At least one of userPassword or ownerPassword is required.
"my-secret"
Owner password (required to change permissions). At least one of userPassword or ownerPassword is required.
"owner-secret"
Optional webhook configuration
Protect job created
Job ID
"550e8400-e29b-41d4-a716-446655440000"
Action that was performed
"pdf.merge"
Current job status
PENDING, PROCESSING, COMPLETED, FAILED "PENDING"
Input file IDs used for this job
["file-id-1"]Output file ID (available when COMPLETED)
null
Error message (available when FAILED)
null
Job creation timestamp
Job start timestamp
Job completion timestamp
Structured job result data (e.g. OCR markdown/JSON, generated filename, PDF metadata, form fields). Available when the job produces a direct result instead of an output file.
Deprecated — use result instead. Additional metadata, duplicated from result for backward compatibility.