Import videos from Vimeo

Usage example

{
  "steps": {
    "imported": {
      "robot": "/vimeo/import",
      "credentials": "YOUR_VIMEO_CREDENTIALS",
      "path": "me/videos",
      "rendition": "720p",
      "page_number": 1,
      "files_per_page": 20
    }
  }
}

Parameters

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

• path

  string | Array<string> (default: "me/videos")

  The Vimeo API path to import from. The most common paths are:

  • me/videos: Your own videos
  • me/likes: Videos you've liked
  • me/albums/:album_id/videos: Videos from a specific album
  • me/channels/:channel_id/videos: Videos from a specific channel
  • me/groups/:group_id/videos: Videos from a specific group
  • me/portfolios/:portfolio_id/videos: Videos from a specific portfolio
  • me/watchlater: Videos in your watch later queue

  You can also use an array of path strings here to import multiple paths in the same Robot's Step.

• page_number

  string | number (default: 1)

  The page number to import from. Vimeo API uses pagination for large result sets.

• files_per_page

  string | number (default: 20)

  The number of files to import per page. Maximum is 100 as per Vimeo API limits.

• rendition

  240p | 360p | 540p | 720p | 1080p | source (default: "720p")

  The quality of the video to import.