Cookie Consent by Free Privacy Policy Generator

API entities

A conversion entity is returned as a JSON object when calling, for example, the /convert and the /status endpoints, and it looks like this:
{ "uuid": {*"88667411-3fb9-4c92-8488-8e277aed3021"*}, "status": "Pending", "createdDate": "2024-10-12T07:18:40+00:00", "startedDate": "2024-10-12T07:19:40+00:00", "failedDate": null, "failDescriptions": null, "completedDate": null, "deliveredDate": null, "deliveryExpirationDate": null, "sourceImageFileName": "test.heic", "progressPercentage": 0, "conversionTime": 10, "estimatedRemainingTime": 0, "blurHash": "elMj?o;JW3H1R%D%~AxfUCt7?bt7M{WBRkIBE2t1rcofWBayfRayf7", "averageColor": "#9B9B9B", "variants": { { "uuid": "83b58e48-96bc-4a9c-be18-c0b737ef8bdc", "status": "Pending", "createdDate": "2024-10-12T07:18:40+00:00", "failedDate": null, "failDescriptions": null, "warningDescriptions": null, "completedDate": null, "conversionTime": null, "fileName": null, "format": "jpeg-xt", "outputImageFileName": "test_1200q80.jpg", "outputImageFileSize": 844367, "outputImageWidth": 1600, "outputImageHeight": 1200, "outputImageMegapixels": 1.92, "outputImageAspectRatio": 1.333333, "outputImageCompressionRatio": 114.76, "conversionParameters": { "width": 100, "height": 0, "extrapolate": false, "baseQuality": 0, "gainmapQuality": 0, "onSdr": "fail" } }, {_[...]_} } }
  • uuid
    The unique identifier of the conversion.
  • status
    The current status of the conversion.
    • Pending
      The conversion has been received and is waiting to start.
    • Running
      The conversion is running.
    • Failed
      The conversion has failed. Find error details in the failDescriptions of the conversion entity and in the associated variants.
    • Ready
      The conversion has been completed and is ready to be downloaded. Once ready, conversions are kept available for you to download for 7 days.
    • Delivered
      The conversion has been downloaded.
  • step
    The current step within the conversion process.
    • Pending
      The conversion is waiting to start.
    • Preparing
      The conversion has started and preparations tasks are in progress.
    • Converting
      The files resulting from each variant are being built.
    • Finalizing
      The variant files have been built and final conversion tasks are in progress.
  • createdDate
    The timestamp indicating when this conversion was created.
  • startedDate
    The timestamp indicating when this conversion started processing. null if it hasn't started yet.
  • failedDate
    The timestamp indicating when this conversion failed. null if it hasn't failed.
  • failDescriptions
    An array of strings describing the errors encountered. null if no errors found.
  • completedDate
    The timestamp indicating when this conversion was completed. null if it hasn't been completed yet.
  • deliveredDate
    The timestamp indicating when this conversion was delivered. null if it hasn't been delivered yet.
  • deliveryExpirationDate
    The timestamp indicating when this conversion will no longer be available for download. null if it has not yet been made available for download.
  • sourceImageFileName
    The original name of the uploaded source image file.
  • progressPercentage
    An approximate percentage of the overall conversion progress.
  • conversionTime
    The time in seconds that has passed between the conversion started and completed processing.
  • estimatedRemainingTime
    An estimate of the time in seconds that remains until the conversion completes processing.
  • blurHash
    A string that represents a blurry preview of the image being converted, formatted according to the BlurHash standard.
  • averageColor
    An HTML hexadecimal representation of the average color of the image being converted.
  • variants
    An array of the variant entities that specify which files must be produced by this conversion.
Normally, multiple variant entities are returned in the variants key of the conversion entity. Each variant represents one conversion to be done to the provided source image, and will produce one resulting file.
{ "uuid": "83b58e48-96bc-4a9c-be18-c0b737ef8bdc", "status": "Pending", "createdDate": "2024-10-12T07:18:40+00:00", "failedDate": null, "failDescriptions": null, "warningDescriptions": null, "completedDate": null, "conversionTime": null, "fileName": null, "format": "jpeg-xt", "outputImageFileName": "test_1200q80.jpg", "outputImageFileSize": 844367, "outputImageWidth": 1600, "outputImageHeight": 1200, "outputImageMegapixels": 1.92, "outputImageAspectRatio": 1.333333, "outputImageCompressionRatio": 114.76, "conversionParameters": { "width": 100, "height": 0, "extrapolate": false, "baseQuality": 0, "gainmapQuality": 0, "onSdr": "fail" } }
  • uuid
    The unique identifier of the variant. Note that this is different than the conversion uuid.
  • status
    The current status of the variant.
    • Pending
      The work on this conversion variant is waiting to start.
    • Prepared
      The conversion of this variant has been prepared and is ready to run.
    • Running
      The work on this conversion variant is running.
    • Failed
      The work on this conversion variant has failed. Find error details in the failDescriptions key.
    • Skipped
      This variant has been skipped, either because another variant has failed, or because the conversion parameters caused it to be skipped.
    • Completed
      The work on this conversion variant has been completed.
  • createdDate
    The timestamp indicating when this variant was created.
  • failedDate
    The timestamp indicating when the work on this variant failed. null if it hasn't failed.
  • failDescriptions
    An array of strings describing the errors encountered. null if no errors found.
  • warningDescriptions
    An array of strings describing the warnings encountered. null if no warnings found.
  • completedDate
    The timestamp indicating when the work on this variant was completed. null if it hasn't been completed yet.
  • conversionTime
    The amount of time in seconds it took to complete the work on this variant.
  • fileName
    The name of the file produced by this variant. If not specified, the name will be automatically generated from the source image file name.
  • format
    The format of the image produced by this variant, from one of the accepted format strings documented for the /conversion endpoint.
  • outputImageFileName
    The name of the image file produced by this variant. This is the file name you'll encounter inside the ZIP file when downloading the conversion results.
  • outputImageFileSize
    The file size in bytes of the image file produced by this variant.
  • outputImageWidth
    The width of the image file produced by this variant.
  • outputImageHeight
    The height of the image file produced by this variant.
  • outputImageMegapixels
    The number of megapixels of the image file produced by this variant.
  • outputImageAspectRatio
    The aspect ratio of the image file produced by this variant.
  • outputImageCompressionRatio
    The compression ratio attained by the image file produced by this variant, in comparison to an uncompressed HDR file of the same size.
  • conversionParameters
    The parameters of the conversion as documented for the /conversion endpoint.