Vimeo connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Set up the connector

   Register your Vimeo credentials with Scalekit so it handles the token lifecycle. You do this once per environment.

   Dashboard setup steps

   Register your Vimeo app credentials with Scalekit so it can manage the OAuth 2.0 authentication flow and token lifecycle on your behalf. You’ll need a Client Identifier and Client Secret from the Vimeo Developer Portal.

   1. Create a Vimeo app

      • Go to the Vimeo Developer Portal and click Create an app in the top-right corner.

      • Fill in the required fields:

        • App name — enter a name for your app (e.g., Scalekit-Auth)
        • Brief description — describe what the app does
        • Select Yes under “Will people besides you be able to access your app?” to allow other Vimeo accounts to authenticate
        • Check the box to agree to the Vimeo API License Agreement and Terms of Service
        

      • Click Create App.

   2. Copy your Client Identifier

      After creating the app, you are taken to the app’s settings page. Copy the Client identifier — you’ll need it in a later step.

      

   3. Create a connection in Scalekit

      • In Scalekit dashboard, go to AgentKit > Connections > Create Connection. Search for Vimeo and click Create.

        

      • Copy the Redirect URI from the connection configuration panel. It looks like https://<SCALEKIT_ENVIRONMENT_URL>/sso/v1/oauth/<CONNECTION_ID>/callback.

        

   4. Configure the callback URL in Vimeo

      • Back in the Vimeo Developer Portal, open your app and click Edit settings.

      • Paste the Scalekit Redirect URI into the App URL field and the Your callback URLs field.

      • Click Add secret under Client secrets to generate a new client secret. Copy the secret value.

        

      • Click Update to save.

   5. Add credentials in Scalekit

      • In Scalekit dashboard, go to AgentKit > Connections and open the Vimeo connection you created.

      • Enter your credentials:

        • Client ID — the Client Identifier from your Vimeo app
        • Client Secret — the secret you generated in step 4
        • Scopes — select the scopes your app needs (e.g., create, delete, edit, interact, private, public)

      • Click Save.

4. Authorize and make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'vimeo'
   const identifier = 'user_123'
   
   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Vimeo:', link)
   process.stdout.write('Press Enter after authorizing...')
   await new Promise(r => process.stdin.once('data', r))
   
   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'vimeo_categories_list',
     toolInput: {},
   })
   console.log(result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "vimeo"
   identifier = "user_123"
   
   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Vimeo:", link_response.link)
   input("Press Enter after authorizing...")
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="vimeo_categories_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

What you can do

Connect this agent connector to let your agent:

• Unlike video — Remove the authenticated user’s like from a Vimeo video
• List video texttracks, video pictures, video likes — List the caption/subtitle text tracks on a Vimeo video
• Delete video texttrack, group, folder — Remove a caption/subtitle text track from a Vimeo video
• Create video texttrack, video picture, video — Add a caption/subtitle text track resource to a Vimeo video, specifying its language, name, and type
• Add video tags, group video, showcase video — Add one or more tags to a Vimeo video in a single batch call
• Remove video tag — Remove a specific tag from a Vimeo video

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

vimeo_categories_list#Retrieve all top-level Vimeo content categories (e.g., Animation, Documentary, Music). Requires public scope.4 params▾

Retrieve all top-level Vimeo content categories (e.g., Animation, Documentary, Music). Requires public scope.

NameTypeRequiredDescription

directionstringoptionalSort direction

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of categories per page

sortstringoptionalSort order for categories

vimeo_category_get#Retrieve details about a specific top-level Vimeo content category, including its name, description, and links. Requires public scope.1 param▾

Retrieve details about a specific top-level Vimeo content category, including its name, description, and links. Requires public scope.

NameTypeRequiredDescription

categorystringrequiredCategory name/slug as used in Vimeo's category URIs

vimeo_category_videos_list#Retrieve videos published under a specific top-level Vimeo content category. Requires public scope.6 params▾

Retrieve videos published under a specific top-level Vimeo content category. Requires public scope.

NameTypeRequiredDescription

categorystringrequiredCategory name/slug to list videos from

directionstringoptionalSort direction for results

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of videos per page

querystringoptionalSearch query to filter videos by title within the category

sortstringoptionalSort order for results

vimeo_channel_get#Retrieve detailed information about a specific Vimeo channel including its name, description, and stats. Requires public scope.1 param▾

Retrieve detailed information about a specific Vimeo channel including its name, description, and stats. Requires public scope.

NameTypeRequiredDescription

channel_idstringrequiredVimeo channel ID or name

vimeo_channel_videos_list#Retrieve all videos in a specific Vimeo channel. Requires public scope.7 params▾

Retrieve all videos in a specific Vimeo channel. Requires public scope.

NameTypeRequiredDescription

channel_idstringrequiredVimeo channel ID or slug

directionstringoptionalSort direction

filterstringoptionalFilter videos by type

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of videos per page

querystringoptionalSearch query to filter channel videos

sortstringoptionalSort order for videos

vimeo_channels_list#Retrieve a list of Vimeo channels. Can list all public channels or channels the authenticated user follows/manages. Requires public scope.6 params▾

Retrieve a list of Vimeo channels. Can list all public channels or channels the authenticated user follows/manages. Requires public scope.

NameTypeRequiredDescription

directionstringoptionalSort direction

filterstringoptionalFilter channels by type

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of channels per page

querystringoptionalSearch query to filter channels by name

sortstringoptionalSort order for channels

vimeo_comment_delete#Permanently delete a comment from a Vimeo video. This action is irreversible and requires delete scope and ownership of the comment or video.2 params▾

Permanently delete a comment from a Vimeo video. This action is irreversible and requires delete scope and ownership of the comment or video.

NameTypeRequiredDescription

comment_idstringrequiredID of the comment to delete

video_idstringrequiredVimeo video ID the comment belongs to

vimeo_comment_replies_list#Retrieve all replies posted to a specific comment on a Vimeo video. Requires public scope.4 params▾

Retrieve all replies posted to a specific comment on a Vimeo video. Requires public scope.

NameTypeRequiredDescription

comment_idstringrequiredID of the comment to list replies for

video_idstringrequiredVimeo video ID the comment belongs to

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of replies per page

vimeo_folder_create#Create a new folder (project) in the authenticated user's Vimeo account for organizing private video content. Requires create scope.2 params▾

Create a new folder (project) in the authenticated user's Vimeo account for organizing private video content. Requires create scope.

NameTypeRequiredDescription

namestringrequiredName of the new folder

parent_folder_uristringoptionalURI of the parent folder to nest this folder inside

vimeo_folder_delete#Permanently delete a folder (project) from the authenticated user's Vimeo account. Videos inside the folder are not deleted, only the folder organization. Requires delete scope.1 param▾

Permanently delete a folder (project) from the authenticated user's Vimeo account. Videos inside the folder are not deleted, only the folder organization. Requires delete scope.

NameTypeRequiredDescription

folder_idstringrequiredVimeo folder (project) ID to delete

vimeo_folder_video_add#Move or add a video into a Vimeo folder (project). Requires edit scope.2 params▾

Move or add a video into a Vimeo folder (project). Requires edit scope.

NameTypeRequiredDescription

folder_idstringrequiredFolder (project) ID to add the video to

video_idstringrequiredVideo ID to add to the folder

vimeo_folder_videos_list#Retrieve all videos inside a specific Vimeo folder (project). Requires private scope.7 params▾

Retrieve all videos inside a specific Vimeo folder (project). Requires private scope.

NameTypeRequiredDescription

folder_idstringrequiredFolder (project) ID to list videos from

directionstringoptionalSort direction

filterstringoptionalFilter videos by type

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of videos per page

querystringoptionalSearch query to filter videos by name

sortstringoptionalSort order for videos

vimeo_folders_list#Retrieve all folders (projects) owned by the authenticated Vimeo user for organizing private video libraries. Requires private scope.5 params▾

Retrieve all folders (projects) owned by the authenticated Vimeo user for organizing private video libraries. Requires private scope.

NameTypeRequiredDescription

directionstringoptionalSort direction

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of folders per page

querystringoptionalSearch query to filter folders by name

sortstringoptionalSort order for folders

vimeo_following_list#Retrieve a list of Vimeo users that the authenticated user is following. Requires private scope.6 params▾

Retrieve a list of Vimeo users that the authenticated user is following. Requires private scope.

NameTypeRequiredDescription

directionstringoptionalSort direction

filterstringoptionalFilter following list by type

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of users per page

querystringoptionalSearch query to filter following list by name

sortstringoptionalSort order

vimeo_group_create#Create a new Vimeo group that members can join to share videos and discuss a common topic. Requires create scope.2 params▾

Create a new Vimeo group that members can join to share videos and discuss a common topic. Requires create scope.

NameTypeRequiredDescription

namestringrequiredName of the new group

descriptionstringoptionalDescription of the group's topic or purpose

vimeo_group_delete#Permanently delete a Vimeo group. This action is irreversible and requires delete scope and ownership of the group.1 param▾

Permanently delete a Vimeo group. This action is irreversible and requires delete scope and ownership of the group.

NameTypeRequiredDescription

group_idstringrequiredVimeo group ID to delete

vimeo_group_get#Retrieve detailed information about a specific Vimeo group including its name, description, stats, and privacy settings. Requires public scope.1 param▾

Retrieve detailed information about a specific Vimeo group including its name, description, stats, and privacy settings. Requires public scope.

NameTypeRequiredDescription

group_idstringrequiredVimeo group ID

vimeo_group_users_list#Retrieve the list of users who have joined a specific Vimeo group. Requires public scope.4 params▾

Retrieve the list of users who have joined a specific Vimeo group. Requires public scope.

NameTypeRequiredDescription

group_idstringrequiredVimeo group ID to list members from

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of members per page

querystringoptionalSearch query to filter members by name

vimeo_group_video_add#Share an existing video to a Vimeo group. Requires edit scope and membership in the group.2 params▾

Share an existing video to a Vimeo group. Requires edit scope and membership in the group.

NameTypeRequiredDescription

group_idstringrequiredVimeo group ID to add the video to

video_idstringrequiredVideo ID to share to the group

vimeo_group_videos_list#Retrieve all videos that have been shared to a specific Vimeo group. Requires public scope.5 params▾

Retrieve all videos that have been shared to a specific Vimeo group. Requires public scope.

NameTypeRequiredDescription

group_idstringrequiredVimeo group ID to list videos from

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of videos per page

querystringoptionalSearch query to filter videos by title

sortstringoptionalSort order for results

vimeo_groups_list#Retrieve a list of Vimeo groups, optionally filtered by a search query. Requires public scope.5 params▾

Retrieve a list of Vimeo groups, optionally filtered by a search query. Requires public scope.

NameTypeRequiredDescription

directionstringoptionalSort direction for results

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of groups per page

querystringoptionalSearch query to filter groups by name

sortstringoptionalSort order for results

vimeo_liked_videos_list#Retrieve all videos liked by the authenticated Vimeo user. Requires private scope.5 params▾

Retrieve all videos liked by the authenticated Vimeo user. Requires private scope.

NameTypeRequiredDescription

directionstringoptionalSort direction

filterstringoptionalFilter liked videos by type

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of videos per page

sortstringoptionalSort order for liked videos

vimeo_me_get#Retrieve the authenticated Vimeo user's profile including account type, bio, location, stats, and links. Requires a valid Vimeo OAuth2 connection.0 params▾

Retrieve the authenticated Vimeo user's profile including account type, bio, location, stats, and links. Requires a valid Vimeo OAuth2 connection.

vimeo_my_videos_list#Retrieve all videos uploaded by the authenticated Vimeo user. Supports filtering, sorting, and pagination. Requires private scope.7 params▾

Retrieve all videos uploaded by the authenticated Vimeo user. Supports filtering, sorting, and pagination. Requires private scope.

NameTypeRequiredDescription

containing_uristringoptionalFilter videos that contain a specific URI

directionstringoptionalSort direction

filterstringoptionalFilter videos by type

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of videos per page

querystringoptionalSearch query to filter videos by title or description

sortstringoptionalSort order for video results

vimeo_showcase_create#Create a new showcase (album) on Vimeo for organizing videos. Supports privacy, password protection, branding, and embed settings. Requires create scope.9 params▾

Create a new showcase (album) on Vimeo for organizing videos. Supports privacy, password protection, branding, and embed settings. Requires create scope.

NameTypeRequiredDescription

namestringrequiredName/title of the showcase

brand_colorstringoptionalHex color code for showcase branding

descriptionstringoptionalDescription of the showcase

hide_navbooleanoptionalWhether to hide Vimeo navigation in the showcase

hide_upcomingbooleanoptionalWhether to hide upcoming live events in the showcase

passwordstringoptionalPassword for the showcase when privacy is set to 'password'

privacystringoptionalPrivacy setting for the showcase

review_modebooleanoptionalEnable review mode for the showcase

sortstringoptionalDefault sort for videos in the showcase

vimeo_showcase_video_add#Add a video to a Vimeo showcase. Requires edit scope and ownership of both the showcase and the video.2 params▾

Add a video to a Vimeo showcase. Requires edit scope and ownership of both the showcase and the video.

NameTypeRequiredDescription

album_idstringrequiredShowcase (album) ID to add the video to

video_idstringrequiredVideo ID to add to the showcase

vimeo_showcase_videos_list#Retrieve all videos in a specific Vimeo showcase. Requires private scope.5 params▾

Retrieve all videos in a specific Vimeo showcase. Requires private scope.

NameTypeRequiredDescription

album_idstringrequiredShowcase (album) ID

directionstringoptionalSort direction

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of videos per page

sortstringoptionalSort order for videos

vimeo_showcases_list#Retrieve all showcases (formerly albums) owned by the authenticated Vimeo user. Requires private scope.5 params▾

Retrieve all showcases (formerly albums) owned by the authenticated Vimeo user. Requires private scope.

NameTypeRequiredDescription

directionstringoptionalSort direction

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of showcases per page

querystringoptionalSearch query to filter showcases by name

sortstringoptionalSort order for showcases

vimeo_user_follow#Follow a Vimeo user on behalf of the authenticated user. Requires interact scope.1 param▾

Follow a Vimeo user on behalf of the authenticated user. Requires interact scope.

NameTypeRequiredDescription

follow_user_idstringrequiredVimeo user ID to follow

vimeo_user_followers_list#List the followers of a Vimeo user — the inverse of List Following. Requires public scope.6 params▾

List the followers of a Vimeo user — the inverse of List Following. Requires public scope.

NameTypeRequiredDescription

user_idstringrequiredVimeo user ID whose followers to list

directionstringoptionalSort direction for results

pageintegeroptionalPage number of results to return

per_pageintegeroptionalNumber of items to show per page, up to a maximum of 100

querystringoptionalSearch query to filter the followers list by name

sortstringoptionalSort order for the results

vimeo_user_get#Retrieve public profile information for any Vimeo user by their user ID or username. Requires public scope.1 param▾

Retrieve public profile information for any Vimeo user by their user ID or username. Requires public scope.

NameTypeRequiredDescription

user_idstringrequiredVimeo user ID or username

vimeo_user_unfollow#Stop following a Vimeo user on behalf of the authenticated user. Requires interact scope.1 param▾

Stop following a Vimeo user on behalf of the authenticated user. Requires interact scope.

NameTypeRequiredDescription

follow_user_idstringrequiredVimeo user ID to unfollow

vimeo_user_update#Edit the authenticated Vimeo user's account profile: bio, display name, location, custom URL, content rating filters, default password for password-protected videos, and default upload privacy settings. Requires edit scope; only the authenticated user's own profile can be edited.12 params▾

Edit the authenticated Vimeo user's account profile: bio, display name, location, custom URL, content rating filters, default password for password-protected videos, and default upload privacy settings. Requires edit scope; only the authenticated user's own profile can be edited.

NameTypeRequiredDescription

user_idstringrequiredVimeo user ID to edit (must be the authenticated user)

biostringoptionalNew bio text for the user

content_filterarrayoptionalList of content rating values describing the content in this user's videos. See the /contentratings endpoint for the full list.

custom_urlstringoptionalThe user's custom Vimeo URL slug

default_privacy_addbooleanoptionalDefault setting for whether others can add this user's future videos to albums, channels, or groups

default_privacy_commentsstringoptionalDefault setting for who can comment on this user's future videos

default_privacy_downloadbooleanoptionalDefault setting for whether this user's future videos can be downloaded

default_privacy_embedstringoptionalDefault embed privacy for this user's future videos

default_privacy_viewstringoptionalDefault view privacy for this user's future videos

locationstringoptionalNew location text for the user

namestringoptionalNew display name for the user

passwordstringoptionalDefault password for future videos uploaded with password-protected view privacy

vimeo_user_videos_list#Retrieve all public videos uploaded by a specific Vimeo user. Supports filtering and pagination. Requires public scope.7 params▾

Retrieve all public videos uploaded by a specific Vimeo user. Supports filtering and pagination. Requires public scope.

NameTypeRequiredDescription

user_idstringrequiredVimeo user ID or username

directionstringoptionalSort direction

filterstringoptionalFilter results by video type

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of videos per page

querystringoptionalSearch query to filter videos

sortstringoptionalSort order for video results

vimeo_users_search#Search for Vimeo users by name or other keywords. Per Vimeo's API reference this is served by GET /users with a query parameter (there is no separate /users/search path). Requires public scope; the API may return a 503 if search is temporarily disabled.5 params▾

Search for Vimeo users by name or other keywords. Per Vimeo's API reference this is served by GET /users with a query parameter (there is no separate /users/search path). Requires public scope; the API may return a 503 if search is temporarily disabled.

NameTypeRequiredDescription

directionstringoptionalSort direction for results

pageintegeroptionalPage number of results to return

per_pageintegeroptionalNumber of items to show per page, up to a maximum of 100

querystringoptionalSearch query to filter users by name

sortstringoptionalSort order for the results

vimeo_video_comment_add#Post a comment on a Vimeo video on behalf of the authenticated user. Requires interact scope.2 params▾

Post a comment on a Vimeo video on behalf of the authenticated user. Requires interact scope.

NameTypeRequiredDescription

textstringrequiredComment text to post

video_idstringrequiredVimeo video ID to comment on

vimeo_video_comment_update#Edit the text of an existing comment on a Vimeo video. Requires edit scope and that the authenticated user wrote the comment.3 params▾

Edit the text of an existing comment on a Vimeo video. Requires edit scope and that the authenticated user wrote the comment.

NameTypeRequiredDescription

comment_idstringrequiredID of the comment to edit

textstringrequiredThe new comment text

video_idstringrequiredVimeo video ID the comment belongs to

vimeo_video_comments_list#Retrieve all comments posted on a specific Vimeo video. Requires public scope.4 params▾

Retrieve all comments posted on a specific Vimeo video. Requires public scope.

NameTypeRequiredDescription

video_idstringrequiredVimeo video ID to list comments from

directionstringoptionalSort direction

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of comments per page

vimeo_video_create#Create a new Vimeo video by having Vimeo pull the source file from a publicly accessible URL. This is the simplest upload approach and does not require chunked/binary transfer. Requires create and upload scopes.4 params▾

Create a new Vimeo video by having Vimeo pull the source file from a publicly accessible URL. This is the simplest upload approach and does not require chunked/binary transfer. Requires create and upload scopes.

NameTypeRequiredDescription

file_linkstringrequiredPublicly accessible HTTPS URL of the video file for Vimeo to pull and transcode

descriptionstringoptionalDescription for the new video

namestringoptionalTitle for the new video

privacy_viewstringoptionalWho can view the video once created

vimeo_video_delete#Permanently delete a Vimeo video. This action is irreversible. Requires delete scope and ownership of the video.1 param▾

Permanently delete a Vimeo video. This action is irreversible. Requires delete scope and ownership of the video.

NameTypeRequiredDescription

video_idstringrequiredVimeo video ID to delete

vimeo_video_edit#Update the metadata of an existing Vimeo video including title, description, privacy settings, tags, and content rating. Requires edit scope.11 params▾

Update the metadata of an existing Vimeo video including title, description, privacy settings, tags, and content rating. Requires edit scope.

NameTypeRequiredDescription

video_idstringrequiredVimeo video ID to edit

content_ratingstringoptionalContent rating of the video

descriptionstringoptionalNew description for the video

licensestringoptionalCreative Commons license to apply

namestringoptionalNew title for the video

passwordstringoptionalPassword for the video when privacy view is set to 'password'

privacy_addbooleanoptionalWhether users can add the video to their showcases or channels

privacy_commentsstringoptionalWho can comment on the video

privacy_downloadbooleanoptionalWhether users can download the video

privacy_embedstringoptionalWho can embed the video

privacy_viewstringoptionalWho can view the video

vimeo_video_get#Retrieve detailed information about a specific Vimeo video including metadata, privacy settings, stats, and embed details. Requires a valid Vimeo OAuth2 connection.1 param▾

Retrieve detailed information about a specific Vimeo video including metadata, privacy settings, stats, and embed details. Requires a valid Vimeo OAuth2 connection.

NameTypeRequiredDescription

video_idstringrequiredVimeo video ID

vimeo_video_like#Like a Vimeo video on behalf of the authenticated user. Use PUT /me/likes/{video_id} to like. Requires interact scope.1 param▾

Like a Vimeo video on behalf of the authenticated user. Use PUT /me/likes/{video_id} to like. Requires interact scope.

NameTypeRequiredDescription

video_idstringrequiredVimeo video ID to like

vimeo_video_likes_list#Retrieve the list of users who have liked a specific Vimeo video. Requires public scope.3 params▾

Retrieve the list of users who have liked a specific Vimeo video. Requires public scope.

NameTypeRequiredDescription

video_idstringrequiredVimeo video ID to list likes from

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of users per page

vimeo_video_picture_create#Add a new thumbnail image resource to a Vimeo video. Pass 'time' to have Vimeo auto-generate the thumbnail from that timestamp in the video (fully self-contained). If 'time' is omitted, Vimeo creates an empty picture resource and returns an upload link for a custom image, which must be uploaded in a separate follow-up step outside this tool. Requires upload scope.3 params▾

Add a new thumbnail image resource to a Vimeo video. Pass 'time' to have Vimeo auto-generate the thumbnail from that timestamp in the video (fully self-contained). If 'time' is omitted, Vimeo creates an empty picture resource and returns an upload link for a custom image, which must be uploaded in a separate follow-up step outside this tool. Requires upload scope.

NameTypeRequiredDescription

video_idstringrequiredVimeo video ID to add a thumbnail to

activebooleanoptionalWhether the thumbnail created from 'time' should become the video's default thumbnail

timenumberoptionalTime offset (in seconds) into the video to capture as the thumbnail image

vimeo_video_pictures_list#List the thumbnail images available for a Vimeo video. Requires public scope.3 params▾

List the thumbnail images available for a Vimeo video. Requires public scope.

NameTypeRequiredDescription

video_idstringrequiredVimeo video ID to list pictures from

pageintegeroptionalPage number of results to return

per_pageintegeroptionalNumber of items to show per page, up to a maximum of 100

vimeo_video_tag_remove#Remove a specific tag from a Vimeo video. Requires edit scope.2 params▾

Remove a specific tag from a Vimeo video. Requires edit scope.

NameTypeRequiredDescription

tagstringrequiredThe tag word to remove from the video

video_idstringrequiredVimeo video ID to remove the tag from

vimeo_video_tags_add#Add one or more tags to a Vimeo video in a single batch call. The total number of tags on a video cannot exceed 20. Requires edit scope. Note: per Vimeo's API reference, this operation is a PUT to the tags collection (not POST).2 params▾

Add one or more tags to a Vimeo video in a single batch call. The total number of tags on a video cannot exceed 20. Requires edit scope. Note: per Vimeo's API reference, this operation is a PUT to the tags collection (not POST).

NameTypeRequiredDescription

tagsarrayrequiredList of tag names to add to the video.

video_idstringrequiredVimeo video ID to add tags to

vimeo_video_tags_list#Retrieve all tags applied to a specific Vimeo video. Requires public scope.1 param▾

Retrieve all tags applied to a specific Vimeo video. Requires public scope.

NameTypeRequiredDescription

video_idstringrequiredVimeo video ID to list tags from

vimeo_video_texttrack_create#Add a caption/subtitle text track resource to a Vimeo video, specifying its language, name, and type. This creates the text track's metadata; the response includes a link used to upload the actual caption file (VTT) content in a separate follow-up step. Requires upload scope.5 params▾

Add a caption/subtitle text track resource to a Vimeo video, specifying its language, name, and type. This creates the text track's metadata; the response includes a link used to upload the actual caption file (VTT) content in a separate follow-up step. Requires upload scope.

NameTypeRequiredDescription

languagestringrequiredLanguage of the text track. Use the /languages?filter=texttracks endpoint for the full list of supported codes.

namestringrequiredName of the text track

typestringrequiredType of the text track

video_idstringrequiredVimeo video ID to add the text track to

activebooleanoptionalWhether this text track is the active one shown in the player. Only one text track per language and type can be active.

vimeo_video_texttrack_delete#Remove a caption/subtitle text track from a Vimeo video.2 params▾

Remove a caption/subtitle text track from a Vimeo video.

NameTypeRequiredDescription

texttrack_idstringrequiredID of the text track to delete

video_idstringrequiredVimeo video ID the text track belongs to

vimeo_video_texttracks_list#List the caption/subtitle text tracks on a Vimeo video. Requires public scope.1 param▾

List the caption/subtitle text tracks on a Vimeo video. Requires public scope.

NameTypeRequiredDescription

video_idstringrequiredVimeo video ID to list text tracks from

vimeo_video_unlike#Remove the authenticated user's like from a Vimeo video. Use DELETE /me/likes/{video_id} to unlike. Requires interact scope.1 param▾

Remove the authenticated user's like from a Vimeo video. Use DELETE /me/likes/{video_id} to unlike. Requires interact scope.

NameTypeRequiredDescription

video_idstringrequiredVimeo video ID to unlike

vimeo_videos_search#Search for public videos on Vimeo using keywords and filters. Returns paginated video results with metadata. Requires a valid Vimeo OAuth2 connection with public scope.6 params▾

Search for public videos on Vimeo using keywords and filters. Returns paginated video results with metadata. Requires a valid Vimeo OAuth2 connection with public scope.

NameTypeRequiredDescription

querystringrequiredSearch query keywords

directionstringoptionalSort direction for results

filterstringoptionalFilter results by video type

pageintegeroptionalPage number of results to return

per_pageintegeroptionalNumber of results to return per page

sortstringoptionalSort order for search results

vimeo_watchlater_add#Add a video to the authenticated user's Vimeo Watch Later queue. Requires interact scope.1 param▾

Add a video to the authenticated user's Vimeo Watch Later queue. Requires interact scope.

NameTypeRequiredDescription

video_idstringrequiredVimeo video ID to add to Watch Later

vimeo_watchlater_list#Retrieve all videos in the authenticated user's Vimeo Watch Later queue. Requires private scope.5 params▾

Retrieve all videos in the authenticated user's Vimeo Watch Later queue. Requires private scope.

NameTypeRequiredDescription

directionstringoptionalSort direction

filterstringoptionalFilter by video type

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of videos per page

sortstringoptionalSort order for watch later videos

vimeo_webhook_create#Register a new webhook endpoint to receive real-time Vimeo event notifications. Supports events for video uploads, transcoding, privacy changes, and comments. Requires private scope.2 params▾

Register a new webhook endpoint to receive real-time Vimeo event notifications. Supports events for video uploads, transcoding, privacy changes, and comments. Requires private scope.

NameTypeRequiredDescription

event_typesarrayrequiredList of event types that will trigger this webhook

urlstringrequiredHTTPS URL that Vimeo will send webhook POST requests to

vimeo_webhook_delete#Delete a registered Vimeo webhook endpoint so it no longer receives event notifications. Requires private scope.1 param▾

Delete a registered Vimeo webhook endpoint so it no longer receives event notifications. Requires private scope.

NameTypeRequiredDescription

webhook_idstringrequiredWebhook ID to delete

vimeo_webhooks_list#Retrieve all webhooks registered for the authenticated Vimeo application. Requires private scope.2 params▾

Retrieve all webhooks registered for the authenticated Vimeo application. Requires private scope.

NameTypeRequiredDescription

pageintegeroptionalPage number of results

per_pageintegeroptionalNumber of webhooks per page