Transloadit

Export files to Backblaze

🤖/backblaze/store exports encoding results to Backblaze.

Usage example

Export uploaded files to my_target_folder on Backblaze:

{
  "steps": {
    "exported": {
      "robot": "/backblaze/store",
      "use": ":original",
      "credentials": "YOUR_BACKBLAZE_CREDENTIALS",
      "path": "my_target_folder/${unique_prefix}/${file.url_name}"
    }
  }
}

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.

  • use

    string | Array<string> | Array<object> | object

    Specifies which Step(s) to use as input.

    • You can pick any names for Steps except ":original" (reserved for user uploads handled by Transloadit)
    • You can provide several Steps as input with arrays:
      {
        "use": [
          ":original",
          "encoded",
          "resized"
        ]
      }
      
  • 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 Backblaze Bucket Name, App Key ID, and App Key.

    To create your credential information, head over to Backblaze, sign in to your account, and select "Create a Bucket". Save the name of your bucket, and click on the "App Keys" tab, scroll to the bottom of the page then select “Add a New Application Key”. Allow access to your recently created bucket, select “Read and Write” as your type of access, and tick the “Allow List All Bucket Names” option.

    Now that everything is in place, create your key, and take note of the information you are given so you can input the information into your Template Credentials.

    ⚠️ Your App Key will only be viewable once, so make sure you note this down.

    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", "app_key_id", "app_key".

  • path

    string (default: "${unique_prefix}/${file.url_name}")

    The path at which the file is to be stored. This may include any available Assembly variables.

  • headers

    Record<string, string> (default: {})

    An object containing a list of headers to be set for this file on backblaze, such as { FileURL: "${file.url_name}" }. This can also include any available Assembly Variables.

    Here you can find a list of available headers.

    Object Metadata can be specified using X-Bz-Info-* headers.