The /sftp/import Robot

We are happy to import from whatever storage solution suits you best.

The /sftp/import Robot imports whole libraries of files from your SFTP servers into Transloadit. This Robot relies on public key authentication.


Name Type Default Description
credentials (required) 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 SFTP host, user and optional custom public key. While we recommend to use Template Credentials at all times, some use cases demand dynamic credentials for which using Template Credentials with their static nature is too unwieldy. If you have this requirement, feel free to use the following parameters instead: "host", "port", "user", "public_key" (optional).
path (required) String The path on your SFTP server where to search for files.
ignore_errors Boolean false There might be an error coming up when trying to extract meta data from your imported files. This happens for files that are zero bytes big for example. Setting this to true will cause the Robot to not stop the import (and the entire Assembly) when that happens.
port Integer 22 The port to use for the connection.

Live demos

Our /sftp/import Robot can be used in combination with other Robots, to create powerful workflows unique to your use case.
Here are a few example scenarios, and the required Assembly Instructions to implement them.
You can also try demos of these examples right here, live on our website.

Import an entire folder of files from an SFTP Server

  "steps": {
    "imported": {
      "robot": "/sftp/import",
      "result": true,
      "credentials": "YOUR_CREDENTIALS",
      "path": "my_folder/"
    "resized": {
      "use": ["imported"],
      "robot": "/image/resize",
      "result": true,
      "height": 130,
      "imagemagick_stack": "v2.0.3",
      "width": 130,
      "zoom": false
    "exported": {
      "use": ["imported", "resized"],
      "robot": "/s3/store",
      "credentials": "demo_s3_credentials"

Blog posts about our /sftp/import Robot

Over the years we wrote the following posts about our /sftp/import Robot on our blog:

Did you know?

You can easily combine Robots to create powerful workflows, unique to your business.
This is the power of Transloadit.