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

• output_meta

  Record<string, boolean> | boolean

  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.

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

  Tip

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

• credentials

  string · required

  The authentication Template Credentials used for your Vimeo account. You can generate them on the Template Credentials page. You will be redirected to a Vimeo verification page. Accept the presented permissions and you will be good to go.

• title

  string · required

  The title of the video to be displayed on Vimeo.

• description

  string · required

  The description of the video to be displayed on Vimeo.

• acl

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

Related blog posts