# Import files from Openstack/Swift

🤖/swift/import imports whole directories of files from your Openstack/Swift bucket.

![](/_next/static/media/swift-import.0j.fi8u-7.loz.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 the `path/to/files` directory and its subdirectories:

```
{
  "steps": {
    "imported": {
      "robot": "/swift/import",
      "credentials": "YOUR_SWIFT_CREDENTIALS",
      "path": "path/to/files/",
      "recursive": true
    }
  }
}
```

## 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`\
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 Swift 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"`.

* ### `bucket_region`

`string`\
The region where the bucket is located.

* ### `path` — **required**

`string | Array<string>`\
The path in your bucket 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 direct descendants of this directory will be imported. For example: `images/`.\
Directories are **not** imported recursively. If you want to import files from subdirectories and sub-subdirectories, enable the `recursive` parameter.\
If you want to import all files from the root directory, please use `/` as the value here. In this case, make sure all your objects belong to a path. If you have objects in the root of your bucket that aren't prefixed with `/`, you'll receive an error: `A client error (NoSuchKey) occurred when calling the GetObject operation: The specified key does not exist.`\
You can also use an array of path strings here to import multiple paths in the same Robot's Step.

* ### `recursive`

`boolean` (default: `false`)\
Setting this to `true` will enable importing files from subdirectories and sub-subdirectories (etc.) of the given path.\
Please use the pagination parameters `page_number` and `files_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.