Jobs

Get a job

Changed on
get/jobs/{job_id}

Request

  • Base URL: https://api.podpdf.com
  • URL: https://api.podpdf.com/jobs/{job_id}
  • Auth: API key in header X-API-Key

Response

The job

job_idstring
status'draft' | 'queued' | 'processing' | 'completed' | 'partial_failed' | 'failed' | 'timeout' | 'cancelled'
job_type'quick' | 'long' | 'bulk' | 'pdfop' | 'mailmerge'
modestring
pagesinteger nullable
truncatedboolean
timeout_occurredboolean
bundle_typestring nullable
file_countinteger nullable
processed_countinteger nullable
success_countinteger nullable
failure_countinteger nullable
pages_totalinteger nullable
cancel_requestedboolean

Bulk jobs and mail merge campaigns. True once a cancel is asked for; status becomes cancelled when the job stops.

campaign_namestring nullable

Mail merge campaigns.

valid_row_countinteger nullable

Mail merge campaigns.

sent_countinteger nullable

Mail merge campaigns: emails the mail server accepted.

failed_countinteger nullable

Mail merge campaigns.

rejected_countinteger nullable

Mail merge campaigns.

unconfirmed_countinteger nullable

Mail merge campaigns.

skipped_countinteger nullable

Mail merge campaigns.

report_availableboolean

Mail merge campaigns: the report CSV can be downloaded.

unsent_availableboolean

Mail merge campaigns: rows that were not sent can be downloaded or sent again.

unsent_countinteger nullable

Mail merge campaigns.

outcome_countsobject nullable

Mail merge campaigns, once finished: how many rows ended each way, keyed by sent or the row's error code.

retry_ofstring nullable

Mail merge campaigns: the campaign whose unsent rows this one sends.

created_atstring date-time
completed_atstring date-time nullable
s3_urlstring uri nullable

Present only for jobs with stored output.

s3_url_expires_atstring date-time nullable
webhook_deliveredboolean
webhook_delivered_atstring date-time nullable
webhook_retry_countinteger
error_codestring nullable
error_messagestring nullable
pdf_standard'pdf/ua-1' | 'pdf/ua-2'

Alpha. Make an accessible, tagged PDF that conforms to PDF/UA-1 (ISO 14289-1, PDF 1.7) or PDF/UA-2 (ISO 14289-2, PDF 2.0). For input_type html and markdown and for template renders; other inputs return 400. Leave it out for an ordinary PDF.

PodPDF adds what the file itself needs (tags, language, title, metadata, link descriptions, artifacts for page furniture) and checks the result with veraPDF. What depends on your HTML stays yours: alt text on images, headings in order, header cells in tables. The check's verdict comes back in X-PDF-Conformance (or conformance in JSON). Built-in templates pass both standards.

pdf_standard_stability'alpha'

Alpha. Present with pdf_standard.

Example response

{
  "job_id": "9f0a4b78-2c0c-4d14-9b8b-123456789abc",
  "mode": "html",
  "conformance": {
    "validator": "veraPDF 1.30.3",
    "failed_rules": [
      {
        "rule": "7.18.1-2",
        "specification": "ISO 14289-1:2014"
      }
    ]
  }
}

Changes

  • 84eb21f3ee27Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status