# Import files from Box.com

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

![](/_next/static/media/box-import.0udqawi8axhgx.png?dpl=dpl_BKGqLNQjWctpVS239h7ZAKL6edZN)

###### Keep your credentials safe

Since you need to provide credentials to this Robot, always use this together with Templates and/or Template Credentials, so that you can never leak any secrets while transmitting your Assembly Instructions.

###### Note

Transloadit supports file sizes up to 200 GB. If you require a higher limit for your application, [get in touch](mailto:hello@transloadit.com?subject=Large%20filesizes).

## Usage example

Import files from Box.com

```
{
  "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](https://blurha.sh) 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 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](/docs/robots/video-encode.md), 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`\
Create a Box app in the [Box Developer Console](https://app.box.com/developers/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](/c/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.
