Import files from Box.com

🤖/box/import imports files from Box.com.

Usage example

{
  "steps": {
    "imported": {
      "robot": "/box/import",
      "credentials": "YOUR_BOX_CREDENTIALS",
      "path": "path/to/files/"
    }
  }
}

Parameters

• interpolate

  boolean | Record<string, boolean>

  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.

• 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 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.

• user_meta

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

  Adds custom metadata to each file emitted by this Robot without modifying the file’s contents.

  The values are merged with any existing user_meta carried by the input file. If both objects contain the same key, this Robot’s value takes precedence. Assembly Variables are supported, for example { "internal_file_id": "${file.id}" }.

• 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.

• ignore_errors

  boolean | Array<meta | import | execute>(default: [])

  Ignore errors during specific phases of processing.

  Setting this to ["meta"] will cause the Robot to ignore errors during metadata extraction.

  Setting this to ["execute"] will cause the Robot to ignore errors during the main execution phase.

  Setting this to ["import"] will cause the Robot to ignore errors while importing the source file. The "import" phase is only available to import Robots.

  Setting this to true is equivalent to ["meta", "import", "execute"] and will ignore errors in all three phases.

• force_name

  string | Array<string> | null(default: null)

  Custom name for the imported file(s). By default file names are derived from the source.

• import_on_errors

  Array<meta>(default: [])

  Setting this to ["meta"] will still import the file on metadata extraction errors. ignore_errors is similar, it also ignores the error and makes sure the Robot doesn't stop, but it doesn't import the file.

• credentials

  string

  Create a Box app in the Box Developer Console⁠ using Server Authentication (JWT).

  Generate a public/private keypair for that app. Box will download a JSON config file (with boxAppSettings and appAuth) that includes your JWT private key material.

  In your Transloadit account, create Template Credentials of type Box and paste that full JSON file into key_file_contents. Then set this credentials parameter to the Template Credentials name.

  If your Box enterprise requires it, make sure the app is authorized by an admin before using it in production.

• path — required

  string | Array<string>

  The path in your Box to the specific file or directory. If the path points to a file, only this file will be imported. For example: images/avatar.jpg.

  If it points to a directory, indicated by a trailing slash (/), then all files that are descendants of this directory are recursively imported. For example: images/.

  If you want to import all files from the root directory, please use / as the value here.

  You can also use an array of path strings here to import multiple paths in the same Robot's Step.