Verify the file type

Usage example

{
  "steps": {
    "scanned": {
      "robot": "/file/verify",
      "use": ":original",
      "error_on_decline": true,
      "error_msg": "At least one of the uploaded files was not the desired type",
      "verify_to_be": "image"
    }
  }
}

Parameters

• output_meta

  Record<string, boolean> | boolean | Array<string>

  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"
      ]
    }
    

  Tip

  That's likely all you need to know about use, but you can view Advanced use cases.

• error_on_decline

  boolean (default: false)

  If this is set to true and one or more files are declined, the Assembly will be stopped and marked with an error.

• error_msg

  string (default: "One of your files was declined")

  The error message shown to your users (such as by Uppy) when a file is declined and error_on_decline is set to true.

• verify_to_be

  string (default: "pdf")

  The type that you want to match against to ensure your file is of this type. For example, image will verify whether uploaded files are images. This also works against file media types, in this case image/png would also work to match against specifically png files.