FileVerbs API Documentation - Job Request API

Job Request API Documentation

Download All Outputs

This endpoint allows users to download all output files generated by a job in a single ZIP file. It is particularly useful when a job produces multiple output files, as it bundles them into a single, convenient download. The response is delivered as a Content-Type of application/zip, making it suitable for efficient transfer and storage.

Download All Outputs Example (cURL):

curl -X GET https://api.fileverbs.com/api/v1/jobrequests/603c9d91f7f1c51774f55ed1/outputs/download-all \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." -o outputs.zip

Specification:

This endpoint compresses all output files into a ZIP archive, making it easy to download and manage the results of a job in one file. The response is served with a Content-Type of application/zip, ensuring compatibility with most download managers and browsers.

Implementation Notes:

  • The ZIP file includes all outputs associated with the specified jobRequestId.
  • The jobRequestId is used to identify and gather the relevant files for bundling into the ZIP archive.
  • The ZIP archive is created in-memory for optimal performance and streaming to the client.
  • If the specified jobRequestId is invalid or does not belong to the authenticated user, a 404 Not Found response is returned.

Example Output:

The ZIP file will contain the converted outputs, each as a separate file within the archive. For example, if the job included conversions of a PDF into multiple formats, the ZIP might contain:

  • document.docx
  • document.xlsx
  • document.png

The resulting file is named using the format {jobRequestId}_outputs.zip by default when saved locally.