Adobe · Arazzo Workflow

Adobe Compress a PDF

Version 1.0.0

Upload a PDF, compress it to reduce file size, poll the job, and fetch the smaller result.

1 workflow 1 source API 1 provider
View Spec View on GitHub AnalyticsCreative CloudDigital Asset ManagementDocument ServicesE-CommerceE-SignaturesExperience CloudGenerative AIMarketingPDFWork ManagementArazzoWorkflows

Provider

adobe

Workflows

compress-pdf
Reduce a PDF's file size with a chosen compression level.
Requests an upload slot for the source PDF, submits a compressPDF job at the requested compression level, polls job status until compression finishes, and retrieves the download URI for the smaller PDF.
4 steps inputs: accessToken, compressionLevel, jobID outputs: downloadUri, outputAssetID, sourceAssetID
1
requestUpload
uploadAsset
Request a pre-signed upload URI and asset ID for the source PDF, which is then PUT to the returned uploadUri out of band.
2
submitCompress
compressPDF
Submit an asynchronous compressPDF job that reduces the uploaded PDF's size. Returns 201 with an in-progress job status.
3
pollStatus
getJobStatus
Poll the compressPDF job until it is no longer in progress, looping back while the status remains "in progress".
4
getOutput
getAsset
Resolve a pre-signed download URI for the compressed output PDF.

Source API Descriptions

Arazzo Workflow Specification

adobe-compress-pdf-workflow.yml Raw ↑
arazzo: 1.0.1
info:
  title: Adobe Compress a PDF
  summary: Upload a PDF, compress it to reduce file size, poll the job, and fetch the smaller result.
  description: >-
    Drives the Adobe PDF Services asynchronous compression pipeline that
    reduces a PDF's file size at a chosen compression level. The workflow
    registers the source PDF by requesting a pre-signed upload URI and asset
    ID, submits a compressPDF job, polls the job until it reports done, and
    resolves a download URI for the compressed output. Each step spells out its
    request inline. The polling job identifier is supplied as a workflow input
    because the submit response exposes only an opaque Location header.
  version: 1.0.0
sourceDescriptions:
- name: pdfServicesApi
  url: ../openapi/adobe-pdf-services-api-openapi.yml
  type: openapi
workflows:
- workflowId: compress-pdf
  summary: Reduce a PDF's file size with a chosen compression level.
  description: >-
    Requests an upload slot for the source PDF, submits a compressPDF job at
    the requested compression level, polls job status until compression
    finishes, and retrieves the download URI for the smaller PDF.
  inputs:
    type: object
    required:
    - accessToken
    - jobID
    properties:
      accessToken:
        type: string
        description: OAuth 2.0 bearer access token from Adobe IMS.
      compressionLevel:
        type: string
        description: Compression level (LOW, MEDIUM, or HIGH).
        default: MEDIUM
      jobID:
        type: string
        description: The job identifier taken from the compressPDF response Location header, used to poll status.
  steps:
  - stepId: requestUpload
    description: >-
      Request a pre-signed upload URI and asset ID for the source PDF, which is
      then PUT to the returned uploadUri out of band.
    operationId: uploadAsset
    parameters:
    - name: Authorization
      in: header
      value: "Bearer $inputs.accessToken"
    requestBody:
      contentType: application/json
      payload:
        mediaType: application/pdf
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      assetID: $response.body#/assetID
      uploadUri: $response.body#/uploadUri
  - stepId: submitCompress
    description: >-
      Submit an asynchronous compressPDF job that reduces the uploaded PDF's
      size. Returns 201 with an in-progress job status.
    operationId: compressPDF
    parameters:
    - name: Authorization
      in: header
      value: "Bearer $inputs.accessToken"
    requestBody:
      contentType: application/json
      payload:
        assetID: $steps.requestUpload.outputs.assetID
        compressionLevel: $inputs.compressionLevel
    successCriteria:
    - condition: $statusCode == 201
    outputs:
      status: $response.body#/status
  - stepId: pollStatus
    description: >-
      Poll the compressPDF job until it is no longer in progress, looping back
      while the status remains "in progress".
    operationId: getJobStatus
    parameters:
    - name: Authorization
      in: header
      value: "Bearer $inputs.accessToken"
    - name: operationType
      in: path
      value: compresspdf
    - name: jobID
      in: path
      value: $inputs.jobID
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      status: $response.body#/status
      outputAssetID: $response.body#/asset/assetID
    onSuccess:
    - name: stillRunning
      type: goto
      stepId: pollStatus
      criteria:
      - context: $response.body
        condition: $.status == "in progress"
        type: jsonpath
    - name: finished
      type: goto
      stepId: getOutput
      criteria:
      - context: $response.body
        condition: $.status == "done"
        type: jsonpath
  - stepId: getOutput
    description: >-
      Resolve a pre-signed download URI for the compressed output PDF.
    operationId: getAsset
    parameters:
    - name: Authorization
      in: header
      value: "Bearer $inputs.accessToken"
    - name: assetID
      in: path
      value: $steps.pollStatus.outputs.outputAssetID
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      downloadUri: $response.body#/downloadUri
  outputs:
    sourceAssetID: $steps.requestUpload.outputs.assetID
    outputAssetID: $steps.pollStatus.outputs.outputAssetID
    downloadUri: $steps.getOutput.outputs.downloadUri