
Import files from Cloudflare R2
🤖/cloudflare/import imports whole directories of files from your cloudflare r2 bucket.
Keep your credentials safe
Note
Usage example
Import files from the path/to/files
directory and its subdirectories:
{
"steps": {
"imported": {
"robot": "/cloudflare/import",
"credentials": "YOUR_CLOUDFLARE_CREDENTIALS",
"path": "path/to/files/",
"recursive": true
}
}
}
Parameters
output_meta
Record<string, boolean> | boolean
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 videos, you can add the
"colorspace: true"
parameter to extract the colorspace of the output video.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.result
boolean
(default:false
)Whether the results of this Step should be present in the Assembly Status JSON
queue
"batch"
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_accept
boolean
(default:false
)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.
force_name
string | Array<string> | null
(default:null
)Custom name for the imported file(s). By default file names are derived from the source.
credentials
string
Please create your associated Template Credentials in your Transloadit account and use the name of your Template Credentials as this parameter's value. They will contain the values for your cloudflare bucket, Key, Secret and Bucket region.
While we recommend to use Template Credentials at all times, some use cases demand dynamic credentials for which using Template Credentials is too unwieldy because of their static nature. If you have this requirement, feel free to use the following parameters instead:
"bucket"
,"host"
,"key"
,"secret"
.recursive
boolean
(default:false
)Setting this to
true
will enable importing files from subfolders and sub-subfolders, etc. of the given path.Please use the pagination parameters
page_number
andfiles_per_page
wisely here.page_number
string | number
(default:1
)The pagination page number. For now, in order to not break backwards compatibility in non-recursive imports, this only works when recursive is set to
true
.When doing big imports, make sure no files are added or removed from other scripts within your path, otherwise you might get weird results with the pagination.
files_per_page
string | number
(default:1000
)The pagination page size. This only works when recursive is
true
for now, in order to not break backwards compatibility in non-recursive imports.return_file_stubs
boolean
(default:false
)If set to
true
, the Robot will not yet import the actual files but instead return an empty file stub that includes a URL from where the file can be imported by subsequent Robots. This is useful for cases where subsequent Steps need more control over the import process, such as with 🤖/video/ondemand. This parameter should only be set if all subsequent Steps use Robots that support file stubs.