pdfToolbox in the cloud- Preflight

Apply a pdfToolbox profile on an input file (with optional reports).

Required parameters

  • profile: pdfToolbox profile
    • example: https://s3.eu-central-1.amazonaws.com/ccapi-sample/sample.kfpx
    • the URLs of all predefined Profiles can be found in the article: Predefined Profiles
    • type: url
    • mandatory: true
  • finput: Input file to be processed
    • example: https://s3.eu-central-1.amazonaws.com/ccapi-sample/sample.pdf
    • type: url
    • mandatory: true
  • json_report: Create a JSON report
    • example: true
    • type: boolean
    • default value: false
    • mandatory: false
  • json_compact_report: Create a compact JSON report (The JSON document is written in a single line)
    • example: true
    • type: boolean
    • default value: false
    • mandatory: false
  • pdf_report: Create a PDF report
    • example: false
    • type: boolean
    • default value: false
    • mandatory: false
  • vars: Map of arbitrary variable definitions (consisting of name/value pairs). For further information regarding variables see Variables.
    • type: json object
    • mandatory: false
      Example:
{
	"downsampleImages": true,
	"downsampleTo": 100
}
Click to copy

The preflight_vars operation can be used to retrieve possible variable definitions.

Usage example 

curl -X POST https://api.callassoftware.io/v1/pdfToolbox/preflight -H 'x-api-key: your-api-key' -d @preflight.json
Click to copy

Response and error codes

  • 200: operation completed (retrieve result files from the result_url field)
    • description": the result_url field points to a .json file containing the produced files
    • state: COMPLETED
    • progress: 100
    • result_url: https://a_server/some_sub_folder/a_json_file_containing_the_resulting_urls
  • 202: operation pending (keep going using a GET on the belonging path ...)
    • description: processing has not finished yet. it is essential to wait until one of the final HTTP states is reached (such as HTTP/200 or HTTP/4xx or HTTP/5xx). The state and progress fields can be used to indicate progress
    • state: PROCESSING
    • progress: 10
  • 4xx: a client error has occurred
  • 5xx: a server error has occurred