Export files to Vimeo

🤖/vimeo/store exports encoding results to Vimeo.

Usage example

{
  "steps": {
    "exported": {
      "credentials": "YOUR_VIMEO_CREDENTIALS",
      "description": "Some nice description",
      "robot": "/vimeo/store",
      "title": "Transloadit: Video Example",
      "use": ":original"
    }
  }
}

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 images, "thumbhash": true instead extracts a base64-encoded ThumbHash⁠ into meta.thumbhash, together with meta.has_alpha (whether an alpha channel exists, even when fully opaque). It describes EXIF-oriented pixels and uses the first frame of animated images. Extraction is best-effort: images above 40 megapixels, unsupported formats, or a failed/bounded decode produce no placeholder. Successful extraction adds a metadata charge equivalent to 20% of that file's bytes. No ThumbHash surcharge applies when disabled or when no hash is produced.

  Set this option on the Step producing the image, such as /upload/handle for uploaded originals or /image/resize for processed outputs. Setting it only on /transloadit/store does not request extraction: storage preserves the producer's metadata. Transloadit Storage persists a generated hash with its immutable version and returns it in stored results and native asset reads. Direct S3 uploads do not generate placeholders. A placeholder contains image information, so protect it with the same access controls as the full image.

  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 JSON metadata to each emitted file without changing its contents. Nested objects and arrays are supported.

  Inheritance depends on the Robot. Values merge with existing user_meta on the output file; the current Step replaces matching top-level keys. Assign required keys explicitly when a Robot creates fresh outputs.

  In processing Steps, ${file.*} refers to the first input and ${result.*} to the emitted file. Values are evaluated per output after the Robot runs, before subsequent metadata extraction and temporary storage. On :original, values are evaluated per upload before metadata extraction.

  Downstream Steps read ${file.user_meta.key}. See Custom metadata for a complete example and inheritance rules.

• 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 | 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 true is equivalent to ["meta", "execute"] and will ignore errors in both phases.

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

  • You can also tag input Steps with as to pass semantic intent to robots:

    {
      "use": [
        {
          "name": ":original",
          "as": "image"
        },
        {
          "name": ":original",
          "as": "mask"
        }
      ]
    }
    

  Tip

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

• 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 Vimeo access token.

  For /vimeo/import, create your own app at developer.vimeo.com/apps⁠, open Generate Access Token, choose Authenticated (you), and select Public, Private, and Video Files (public private video_files). Generate the personal access token, then choose Vimeo and Paste a personal access token in the Console. The token is stored as access_token and is never displayed back in the Console. Saving checks your Vimeo account and the token’s scopes. Video file links also require an eligible Vimeo account and video permissions.

  Vimeo OAuth in the Console supports /vimeo/store. It cannot grant video_files for other members’ accounts because Transloadit is not a Vimeo partner. Imports require your own personal access token. To use that token for /vimeo/store too, also grant Upload, Edit, and Interact (upload edit interact) and ensure your Vimeo app has upload access.

  Updating a credential does not run OAuth again or add permissions. To reconnect, Remove the credential (which revokes its token at Vimeo), then create a new credential with the same name. For a personal token, generate a new one before saving it again. Revocation also affects any other use of that token. See the Vimeo credential instructions.

• title — required

  string

  The title of the video to be displayed on Vimeo.

• description — required

  string

  The description of the video to be displayed on Vimeo.

• acl

  anybody | contacts | disable | nobody | password | unlisted | users(default: "anybody")

  Controls access permissions for the video. Here are the valid values:

  • "anybody" — anyone can access the video.
  • "contacts" — only those who follow the owner on Vimeo can access the video.
  • "disable" — the video is embeddable, but it's hidden on Vimeo and can't be played.
  • "nobody" — no one except the owner can access the video.
  • "password" — only those with the password can access the video.
  • "unlisted" — only those with the private link can access the video.
  • "users" — only Vimeo members can access the video.

• password

  string

  The password to access the video if acl is "password".

• showcases

  Array<string>(default: [])

  An array of string IDs of showcases that you want to add the video to. The IDs can be found when browsing Vimeo. For example https://vimeo.com/manage/showcases/[SHOWCASE_ID]/info.

• downloadable

  boolean(default: false)

  Whether or not the video can be downloaded from the Vimeo website.

  Only set this to true if you have unlocked this feature in your Vimeo accounting by upgrading to their "Pro" plan. If you use it while on their Freemium plan, the Vimeo API will return an "Invalid parameter supplied" error.

• folder_id

  string | null(default: null)

  The ID of the folder to which the video is uploaded.

  When visiting one of your folders, the URL is similar to https://vimeo.com/manage/folders/xxxxxxxx. The folder_id would be "xxxxxxxx".

• folder_uri

  string

  Deprecated. Please use folder_id instead. The URI of the folder to which the video is uploaded.

Related blog posts