Export files to Vimeo

Usage example

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

Parameters

• interpolate

  boolean | Record<string, boolean>

• output_meta

  Record<string, boolean> | boolean | Array<string>

• result

  boolean (default: false)

• queue

  batch

• force_accept

  boolean (default: false)

• ignore_errors

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

• use

  string | Array<string> | Array<object> | object

• credentials

  string

• title — required

  string

• description — required

  string

• acl

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

• password

  string

• showcases

  Array<string> (default: [])

• downloadable

  boolean (default: false)

• folder_id

  string | null (default: null)

• folder_uri

  string

Related blog posts

Getting started

Since Vimeo works with OAuth, you will need to generate Template Credentials to use this Robot.

To change the title or description per video, we recommend to inject variables into your Template.

Note that this Robot only accepts videos.

Export an uploaded video to Vimeo and set its title and description:

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.

Whether the results of this Step should be present in the Assembly Status JSON

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

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

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.

The title of the video to be displayed on Vimeo.

The description of the video to be displayed on Vimeo.

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.

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

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.

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.

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

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

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.