Decompress archives
🤖/file/decompress extracts entire archives of files to be consumed by other Robots or exported as individual files.
🤖/file/decompress extracts entire archives of files to be consumed by other Robots or exported as individual files.
{
"steps": {
"decompressed": {
"robot": "/file/decompress",
"use": ":original"
}
}
}interpolateboolean | Record<string, boolean>output_metaRecord<string, boolean> | boolean | Array<string>resultboolean (default: false)queuebatchforce_acceptboolean (default: false)ignore_errorsboolean | Array<meta | execute> (default: [])usestring | Array<string> | Array<object> | objectpasswordstringturboboolean (default: true)This Robot supports the following archive formats:
This Robot also detects and handles any of the following before evaluating the archive file:
For security reasons, archives that contain symlinks to outside the archived dir, will error out the Assembly.
Password-protected archives (ZIP with ZipCrypto or AES encryption, RAR encrypted, 7z with AES-256) are supported via the password parameter.
Decompress an uploaded archive:
Controls whether Assembly Variables are interpolated for individual instruction fields.
By default, most Robot instruction fields interpolate Assembly Variables. Set this to false to treat every instruction field as literal text, or set an individual field path to false to treat only that field as literal text. For Robot-specific fields that are literal by default, set this to true or set that field path to true to opt back into interpolation.
Use field names such as path, or dotted paths such as ffmpeg.vf for nested objects.
Whether the results of this Step should be present in the Assembly Status JSON
Setting the queue to 'batch', manually downgrades the priority of jobs for this step to avoid consuming Priority job slots for jobs that don't need zero queue waiting times
Force a Robot to accept a file type it would have ignored.
By default, Robots ignore files they are not familiar with. 🤖/video/encode, for example, will happily ignore input images.
With the force_accept parameter set to true, you can force Robots to accept all files thrown at them.
This will typically lead to errors and should only be used for debugging or combatting edge cases.
A possible array member is only "meta".
You might see an error when trying to extract metadata from the files inside your archive. This happens, for example, for files with a size of zero bytes. Setting this to true will cause the Robot to not stop the file decompression (and the entire Assembly) when that happens.
To keep backwards compatibility, setting this parameter to true will set it to ["meta"] internally.
Specifies which Step(s) to use as input.
":original" (reserved for user uploads handled by Transloadit){
"use": [
":original",
"encoded",
"resized"
]
}
as to pass semantic intent to robots:
{
"use": [
{
"name": ":original",
"as": "image"
},
{
"name": ":original",
"as": "mask"
}
]
}
That's likely all you need to know about use, but you can view Advanced use cases.
The password to use for decrypting password-protected archives.
Supports encrypted ZIP (ZipCrypto and AES), RAR (encrypted), and 7z (AES-256 encrypted) archives.
For security, this value should be passed via Template Variables (${fields.archive_password}) or Template Credentials rather than hardcoded in your Assembly Instructions. The password is never logged or included in Assembly status responses.
If the archive is encrypted and no password is provided, or if the password is incorrect, the Assembly will fail with a FILE_DECOMPRESS_PASSWORD_REQUIRED or FILE_DECOMPRESS_PASSWORD_INCORRECT error.
Allows you to specify a set of metadata that is more expensive on CPU power to calculate, and thus is disabled by default to keep your Assemblies processing fast.
For images, you can add "has_transparency": true in this object to extract if the image contains transparent parts and "dominant_colors": true to extract an array of hexadecimal color codes from the image.
For images, you can also add "blurhash": true to extract a BlurHash string — a compact representation of a placeholder for the image, useful for showing a blurred preview while the full image loads.
For videos, you can add the "colorspace: true" parameter to extract the colorspace of the output video.
For videos, you can also add "interlaced": true to detect whether the video is interlaced. This combines the cheap ffprobe field_order flag with a bounded idet sampling pass over the first frames of the source, exposing interlaced, field_order, and a diagnostic interlace_detection object under file.meta. This is computationally expensive and billed accordingly.
For audio, you can add "mean_volume": true to get a single value representing the mean average volume of the audio file.
You can also set this to false to skip metadata extraction and speed up transcoding.
Enables Turbo Mode for /file/decompress.
This setting defaults to true. Set it to false to disable Turbo Mode.
When enabled, extracted files are emitted as soon as they are available, which can speed up downstream processing for large archives.
Turbo Mode also changes usage accounting: emitted extracted-file bytes and original input-archive bytes are billed with a surcharge (25% by default).