Skip to content
Changelog

Report a bug

Vimeo integration: operations for AI agents

Vimeo connects to Type.com as an integration. This page lists the 397 operations documented for Claude and Codex in Type.com: 196 read, 130 write, 71 destructive.

About Vimeo

Vimeo provides video hosting APIs for authenticated member profiles, videos, transcripts, folders, privacy-aware metadata, and team-owner libraries.

Categories: Design & Media

How to connect Vimeo to Type.com

Connect
Access token
Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

397 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

397 operations listed.

analytics / essentials

  • Read

    Get bandwidth analytics for the user

    This method returns bandwidth analytics for the authenticated user.

    GET /users/{user_id}/analytics/bandwidth

  • Read

    Get storage analytics for the user

    Get storage analytics for the user.

    GET /users/{user_id}/analytics/storage

api-apps / webhooks

  • Read

    Get all webhooks for an app

    This method returns every webhook for the specified app.

    GET /apps/{app_id}/webhooks

  • Read

    Get a webhook

    This method returns the specified webhook.

    GET /apps/{app_id}/webhooks/{webhook_id}

  • Write

    Add a webhook for an app

    This method adds a webhook for the specified app.

    POST /apps/{app_id}/webhooks

  • Write

    Update a webhook

    This method updates the specified webhook.

    PATCH /apps/{app_id}/webhooks/{webhook_id}

  • Destructive

    Delete a webhook

    This method deletes the specified webhook.

    DELETE /apps/{app_id}/webhooks/{webhook_id}

api-information / essentials

  • Read

    Get the API specification

    This method returns the full OpenAPI specification for the Vimeo API.

    GET /

authentication-extras / essentials

  • Read

    Verify an OAuth 2 access token

    This method verifies that an OAuth 2 access token exists.

    GET /oauth/verify

  • Destructive

    Revoke the current access token

    This method revokes the access token that the requesting app is currently using. The token must be of the OAuth 2 type.

    DELETE /tokens

authentication-extras / authenticate

  • Write

    Authorize a client with OAuth

    This method uses the OAuth protocol to authorize a client. For details on OAuth client authorization, see our [Working with Authentication](/api/authentication) guide or the [OAuth spec](https://tools.ietf.org/html/draft-ietf-oauth-v2-31#section-4.4).

    POST /oauth/authorize/client

authentication-extras / convert

  • Write

    Convert an OAuth 1 access token to an OAuth 2 access token

    This method exchanges a legacy Advanced API OAuth 1 token for an API v3 OAuth 2 token.

    POST /oauth/authorize/vimeo_oauth1

authentication-extras / exchange

  • Write

    Exchange an authorization code for an access token

    This method exchanges an OAuth authorization code for an OAuth access token.

    POST /oauth/access_token

categories / essentials

  • Read

    Get all categories

    This method returns every available category.

    GET /categories

  • Read

    Get a specific category

    This method returns the specified category.

    GET /categories/{category}

categories / channels

  • Read

    Get all the channels in a category

    This method returns every channel that belongs to the specified category.

    GET /categories/{category}/channels

categories / groups

  • Read

    Get all the groups in a category

    This method returns every group that belongs to the specified category.

    GET /categories/{category}/groups

categories / users

  • Read

    Get all the categories that the user follows

    This method returns every category that the authenticated user follows.

    GET /users/{user_id}/categories

  • Read

    Check if the user follows a category

    This method determines whether the authenticated user follows the specified category.

    GET /users/{user_id}/categories/{category}

  • Write

    Cause the user to follow a specific category

    This method causes the authenticated user to follow the specified category.

    PUT /users/{user_id}/categories/{category}

  • Destructive

    Cause the user to stop following a category

    This method causes the authenticated user to stop following the specified category.

    DELETE /users/{user_id}/categories/{category}

categories / videos

  • Read

    Get all the videos in a category

    This method returns every video that belongs to the specified category.

    GET /categories/{category}/videos

  • Read

    Get a specific video in a category

    This method returns a single video in the specified category. You can use this method to determine whether the video belongs to the category.

    GET /categories/{category}/videos/{video_id}

  • Read

    Get all the categories to which a video belongs

    This method returns every category that contains the specified video.

    GET /videos/{video_id}/categories

  • Write

    Set categories for a video

    This method sets multiple categories and subcategories for the specified video. Include the categories as a JSON block in the body of the request using the **category** field, like this: `[{ "category": "Tech" }, { "category": "Music" }]`. The authenticated user must have edit access to the video. For more information on batch requests like this one, see [Using Common Formats and Parameters](https://developer.vimeo.com/api/common-formats#working-with-batch-requests).

    PUT /videos/{video_id}/categories

channels / essentials

  • Read

    Get all channels

    This method returns all available channels.

    GET /channels

  • Read

    Get a specific channel

    This method returns a single channel.

    GET /channels/{channel_id}

  • Read

    Get all the channels to which a user subscribes

    This method returns all the channels to which the specified user subscribes.

    GET /users/{user_id}/channels

  • Write

    Create a channel

    This method creates a new channel.

    POST /channels

  • Write

    Edit a channel

    This method edits the specified channel.

    PATCH /channels/{channel_id}

  • Destructive

    Delete a channel

    This method deletes the specified channel. The authenticated user must own the channel.

    DELETE /channels/{channel_id}

channels / categories

  • Read

    Get all the categories to which a channel belongs

    This method returns every category to which the specified channel belongs.

    GET /channels/{channel_id}/categories

  • Write

    Add a channel to a list of categories

    This method adds the specified channel to multiple categories.

    PUT /channels/{channel_id}/categories

  • Write

    Add a channel to a specific category

    This method adds the specified channel to a single category. The authenticated user must be the owner of the channel.

    PUT /channels/{channel_id}/categories/{category}

  • Destructive

    Remove a channel from a category

    This method removes a channel from the specified category. The authenticated user must be the owner of the channel.

    DELETE /channels/{channel_id}/categories/{category}

channels / moderators

  • Read

    Get all the moderators of a channel

    This method returns every moderator of the specified channel.

    GET /channels/{channel_id}/moderators

  • Read

    Get a specific moderator of a channel

    This method returns a single moderator of the specified channel.

    GET /channels/{channel_id}/moderators/{user_id}

  • Write

    Replace the moderators of a channel

    This method replaces the current list of channel moderators with a new list. The authenticated user must be the owner of the channel and a follower of each requested user to add them as a channel moderator.

    PATCH /channels/{channel_id}/moderators

  • Write

    Add a list of moderators to a channel

    This method adds multiple users as moderators to the specified channel. Include the users by their URI as a JSON array in the body of the request using the **user_uri** field, like this: `[{ "user_uri": "/users/1234" }, { "user_uri": "/users/1235" }]`. The authenticated user must be a follower of a requested user to add this person as a moderator. For more information on batch requests like this one, see [Using Common Formats and Parameters](https://developer.vimeo.com/api/common-formats#working-with-batch-requests).

    PUT /channels/{channel_id}/moderators

  • Write

    Add a specific moderator to a channel

    This method adds a single user as a moderator to the specified channel. The authenticated user must be a follower of the requested user to add them as a channel moderator.

    PUT /channels/{channel_id}/moderators/{user_id}

  • Destructive

    Remove a list of moderators from a channel

    This method removes multiple moderators from the specified channel. The authenticated user must be the owner of the channel.

    DELETE /channels/{channel_id}/moderators

  • Destructive

    Remove a specific moderator from a channel

    This method removes a single moderator from the specified channel. The authenticated user must be the owner of the channel.

    DELETE /channels/{channel_id}/moderators/{user_id}

channels / private-channel-members

  • Read

    Get all the users who can access a private channel

    This method returns all the users who have access to the specified private channel. The authenticated user must be the owner of the channel.

    GET /channels/{channel_id}/privacy/users

  • Write

    Permit a list of users to access a private channel

    This method gives multiple users access to the specified private channel. The authenticated user must be the owner of the channel.

    PUT /channels/{channel_id}/privacy/users

  • Write

    Permit a specific user to access a private channel

    This method gives a single user access to the specified private channel. The authenticated user must be the owner of the channel.

    PUT /channels/{channel_id}/privacy/users/{user_id}

  • Destructive

    Restrict a user from accessing a private channel

    This method prevents a single user from being able to access the specified private channel. The authenticated user must be the owner of the channel.

    DELETE /channels/{channel_id}/privacy/users/{user_id}

channels / subscriptions-and-subscribers

  • Read

    Get all the followers of a channel

    This method returns every follower of the specified channel.

    GET /channels/{channel_id}/users

  • Read

    Check if a user follows a channel

    This method determines whether the specified user is a follower of a particular channel.

    GET /users/{user_id}/channels/{channel_id}

  • Write

    Subscribe the user to a specific channel

    This method subscribes the authenticated user to the specified channel.

    PUT /users/{user_id}/channels/{channel_id}

  • Destructive

    Unsubscribe the user from a specific channel

    This method unsubscribes the authenticated user from the specified channel.

    DELETE /users/{user_id}/channels/{channel_id}

channels / tags

  • Read

    Get all the tags that have been added to a channel

    This method returns every tag that has been added to the specified channel.

    GET /channels/{channel_id}/tags

  • Read

    Check if a tag has been added to a channel

    This method determines whether a tag has been added to the specified channel.

    GET /channels/{channel_id}/tags/{word}

  • Write

    Add a list of tags to a channel

    This method adds multiple tags to the specified channel. Include the tags as a JSON array in the body of the request using the **tag** field, like this: `[{ "tag": "funny" }, { "tag": "concert" }]`. The authenticated user must be the owner of the channel. For more information on batch requests like this one, see [Using Common Formats and Parameters](https://developer.vimeo.com/api/common-formats#working-with-batch-requests).

    PUT /channels/{channel_id}/tags

  • Write

    Add a specific tag to a channel

    This method adds a single tag to the specified channel. The authenticated user must be the owner of the channel.

    PUT /channels/{channel_id}/tags/{word}

  • Destructive

    Remove a tag from a channel

    This method removes a single tag from the specified channel. The authenticated user must be the owner of the channel.

    DELETE /channels/{channel_id}/tags/{word}

channels / videos

  • Read

    Get all the videos in a channel

    This method returns every video in the specified channel.

    GET /channels/{channel_id}/videos

  • Read

    Get a specific video in a channel

    This method returns a single video in the specified channel. You can use it to determine whether the video is in the channel.

    GET /channels/{channel_id}/videos/{video_id}

  • Read

    Get all the channels to which the user can add or remove a specific video

    This method returns every channel to which the authenticated user can add or remove the specified video. The authenticated user must be a moderator of the channel.

    GET /videos/{video_id}/available_channels

  • Write

    Add a list of videos to a channel

    This method adds multiple videos to the specified channel. The authenticated user must be a moderator of the channel.

    PUT /channels/{channel_id}/videos

  • Write

    Add a specific video to a channel

    This method adds a single video to the specified channel. The authenticated user must be a moderator of the channel.

    PUT /channels/{channel_id}/videos/{video_id}

  • Destructive

    Remove a list of videos from a channel

    This method removes multiple videos from the specified channel. Include the videos by their URI as a JSON block in the body of the request using the **video_uri** field, like this: `[{ "video_uri": "/videos/1234" }, { "video_uri": "/videos/1235" }]`. The authenticated user must be a moderator of the channel. For more information on batch requests like this one, see [Using Common Formats and Parameters](https://developer.vimeo.com/api/common-formats#working-with-batch-requests).

    DELETE /channels/{channel_id}/videos

  • Destructive

    Remove a specific video from a channel

    This method removes a single video from the specified channel. The authenticated user must be a moderator of the channel.

    DELETE /channels/{channel_id}/videos/{video_id}

embed-presets / essentials

  • Read

    Get all the embed presets that a user has created

    This method returns every embed preset that belongs to the authenticated user.

    GET /users/{user_id}/presets

  • Read

    Get a specific embed preset

    This method returns a single embed preset. The authenticated user must be the owner of the preset.

    GET /users/{user_id}/presets/{preset_id}

  • Write

    Create an embed preset

    This method creates an embed preset.

    POST /users/{user_id}/presets

  • Write

    Edit an embed preset

    This method edits the specified embed preset. The authenticated user must be the owner of the preset.

    PATCH /users/{user_id}/presets/{preset_id}

  • Destructive

    Delete an embed preset

    This method deletes the specified embed preset. The authenticated user must be the owner of the preset.

    DELETE /users/{user_id}/presets/{preset_id}

embed-presets / custom-logos

  • Read

    Get all the custom logos that belong to the user

    This method returns every custom logo that belongs to the authenticated user or team owner.

    GET /users/{user_id}/customlogos

embed-presets / folders

  • Destructive

    Remove an embed preset from a folder

    This method removes the specified embed preset from a folder. The authenticated user must be either the owner of the folder or a team user with the contributor or admin role.

    DELETE /users/{user_id}/projects/{project_id}/presets/{preset_id}

embed-presets / timeline-events

embed-presets / videos

  • Read

    Get all the videos that have a specific embed preset

    This method returns every video to which the specified embed preset has been added. The authenticated user must be the owner of the videos.

    GET /users/{user_id}/presets/{preset_id}/videos

  • Read

    Check if an embed preset has been added to a video

    This method determines whether a video has the specified embed preset.

    GET /videos/{video_id}/presets/{preset_id}

  • Write

    Add an embed preset to a video

    This method adds an embed preset to the specified video. The authenticated user must either be the owner of the video or a team user with the contributor or admin role.

    PUT /videos/{video_id}/presets/{preset_id}

  • Destructive

    Remove an embed preset from a video

    This method removes the specified embed preset from a video. The authenticated user must either be the owner of the video or a team user with the contributor or admin role.

    DELETE /videos/{video_id}/presets/{preset_id}

files / view

  • Read

    Get a file

    This method returns a single hosted file by its public ID.

    GET /files/{file_id}

folders / essentials

  • Read

    Get a user's private-to-me folder

    This method returns the specified private-to-me folder.

    GET /users/{owner_id}/folders/private_to_me

  • Read

    Get all the folders that belong to the user

    This method returns all the folders belonging to the authenticated user.

    GET /users/{user_id}/projects

  • Read

    Get a specific folder

    This method returns a single folder belonging to the authenticated user.

    GET /users/{user_id}/projects/{project_id}

  • Write

    Create a folder

    This method creates a new folder for the authenticated user. By default, this method creates a top-level folder. To create a subfolder — that is, to place the new folder inside an existing folder — specify the parent folder by URI with the **parent_folder_uri** parameter in the body of the request.

    POST /users/{user_id}/projects

  • Write

    Edit a folder

    This method edits the specified folder. The authenticated user must be the owner of the folder.

    PATCH /users/{user_id}/projects/{project_id}

  • Destructive

    Delete a folder

    This method deletes the specified folder and optionally also the videos that it contains. The authenticated user must be the owner of the folder.

    DELETE /users/{user_id}/projects/{project_id}

folders / items

  • Read

    Get all the items in a folder

    This method returns every item that belongs to the specified folder.

    GET /me/projects/{project_id}/items

  • Read

    Get all the items in a folder

    This method returns every item that belongs to the specified folder.

    GET /users/{user_id}/projects/{project_id}/items

folders / videos

  • Read

    Get all the videos in a folder

    This method returns all the videos that belong to the specified folder.

    GET /users/{user_id}/projects/{project_id}/videos

  • Write

    Add a list of videos to a folder

    This method adds multiple videos to the specified folder. The authenticated user must be the owner of the folder.

    PUT /users/{user_id}/projects/{project_id}/videos

  • Write

    Add a video to a folder

    This method adds a single video to the specified folder. The authenticated user must be the owner of the folder.

    PUT /users/{user_id}/projects/{project_id}/videos/{video_id}

  • Destructive

    Remove a list of videos from a folder

    This method removes multiple videos from the specified folder. The authenticated user must be the owner of the folder.

    DELETE /users/{user_id}/projects/{project_id}/videos

  • Destructive

    Remove a video from a folder

    This method removes a single video from the specified folder. Please note that this doesn't delete the video itself.

    DELETE /users/{user_id}/projects/{project_id}/videos/{video_id}

groups / essentials

  • Read

    Get all groups

    This method returns every available group.

    GET /groups

  • Read

    Get a specific group

    This method returns the specified group.

    GET /groups/{group_id}

  • Write

    Create a group

    This method creates a new group.

    POST /groups

  • Destructive

    Delete a group

    This method deletes the specified group. The authenticated user must be the owner of the group.

    DELETE /groups/{group_id}

groups / subscriptions

  • Write

    Add the user to a group

    This method adds the authenticated user to the specified group.

    PUT /users/{user_id}/groups/{group_id}

  • Destructive

    Remove the user from a group

    This method removes the authenticated user from the specified group. The authenticated user can't be the owner of the group; assign a new owner through a PATCH request first.

    DELETE /users/{user_id}/groups/{group_id}

groups / users

  • Read

    Get all the members of a group

    This method returns every user who belongs to the specified group.

    GET /groups/{group_id}/users

  • Read

    Get all the groups that the user has joined

    This method returns every group to which the authenticated user belongs.

    GET /users/{user_id}/groups

  • Read

    Check if a user has joined a group

    This method determines whether the authenticated user belongs to the specified group.

    GET /users/{user_id}/groups/{group_id}

groups / videos

  • Read

    Get all the videos in a group

    This method returns every video from the specified group.

    GET /groups/{group_id}/videos

  • Read

    Get a specific video in a group

    This method returns a single video from the specified group. You can use this method to determine whether the video belongs to the group.

    GET /groups/{group_id}/videos/{video_id}

  • Read

    Get all the groups to which the user can add or remove a specific video

    This method returns every group to which the authenticated user can add or remove the specified video.

    GET /videos/{video_id}/available_groups

  • Write

    Add a video to a group

    This method adds a video to the specified group. The authenticated user must be the owner of the group.

    PUT /groups/{group_id}/videos/{video_id}

  • Destructive

    Remove a video from a group

    This method removes a video from the specified group. The authenticated user must be the owner of the group.

    DELETE /groups/{group_id}/videos/{video_id}

likes / essentials

  • Read

    Get all the users who have liked a video on an On Demand page

    This method returns every user who has liked the specified video on an On Demand page.

    GET /ondemand/pages/{ondemand_id}/likes

  • Read

    Get all the videos that the user has liked

    This method returns every video that the authenticated user has liked.

    GET /users/{user_id}/likes

  • Read

    Check if the user has liked a video

    This method checks if the authenticated user has liked the specified video.

    GET /users/{user_id}/likes/{video_id}

  • Read

    Get all the users who have liked a video

    This method returns every user who has liked the specified video.

    GET /videos/{video_id}/likes

  • Write

    Cause the user to like a video

    This method causes the authenticated user to like the specified video. The user can't like their own video.

    PUT /users/{user_id}/likes/{video_id}

  • Destructive

    Cause the user to unlike a video

    This method causes the authenticated user to unlike the specified video.

    DELETE /users/{user_id}/likes/{video_id}

live / essentials

  • Read

    Get all the events that belong to the user

    The method returns every event belonging to the authenticated user.

    GET /users/{user_id}/live_events

  • Read

    Get a specific event

    This method returns a single event belonging to the authenticated user.

    GET /users/{user_id}/live_events/{live_event_id}

  • Read

    Get live event occurrences in a date range

    Returns all live event occurrences for the user within the given date range. For recurring events (with rrule), each occurrence within the range is returned as a separate entry. For one-time events (no rrule), the event is included if its start_time falls within the range.

    GET /users/{user_id}/live_events_occurrences

  • Write

    Create an event

    This method creates a new event for the authenticated user.

    POST /users/{user_id}/live_events

  • Write

    Update an event

    This method updates an event belonging to the authenticated user.

    PATCH /users/{user_id}/live_events/{live_event_id}

  • Destructive

    Delete a list of events

    This method deletes multiple events belonging to the authenticated user.

    DELETE /users/{user_id}/live_events

  • Destructive

    Delete a specific event

    This method deletes a single event belonging to the authenticated user.

    DELETE /users/{user_id}/live_events/{live_event_id}

live / analytics

  • Write

    Export VPaaS viewer analytics

    This method queues an export of VPaaS viewer analytics for the specified live event. The authenticated user must be the owner of the event or have edit permissions. The webhook is delivered to the managing vendor app's registered webhook URL.

    POST /live_events/{live_event_id}/export_vpaas_analytics

live / audio-tracks

  • Read

    Get event audio track settings

    This method returns audio tracks settings for the specified event.

    GET /live_events/{live_event_id}/audio_tracks

  • Write

    Update event audio tracks

    This method updates audio tracks settings on the specified event.

    PATCH /live_events/{live_event_id}/audio_tracks

  • Destructive

    Delete event audio tracks

    This method removes all secondary audio tracks from the specified event, keeping the primary track, so the event reverts to single-track audio.

    DELETE /live_events/{live_event_id}/audio_tracks

live / embed-privacy

  • Read

    Get all the domains on which an event can be embedded

    This method returns every permitted domain for an event. The embed privacy setting must be `whitelist`.

    GET /users/{user_id}/live_events/{live_event_id}/privacy/domains

  • Write

    Embed an event on one or more domains

    This method embeds an event on the specified domains. The embed privacy setting must be `whitelist`.

    PUT /users/{user_id}/live_events/{live_event_id}/privacy/domains

live / event-activation

  • Write

    Activate an event

    This method creates the necessary RTMP links for the specified event. Begin streaming to these links to trigger the event on Vimeo. The authenticated user must be the owner of the event.

    POST /users/{user_id}/live_events/{live_event_id}/activate

live / event-automated-closed-captions

  • Write

    Edit the automated closed captions preference of an event

    This method edits the automated closed captions preference for the specified event.

    PATCH /users/{user_id}/live_events/{live_event_id}/auto_cc

live / event-destinations

  • Read

    Get an event destination

    This method returns the specified event destination belonging to the authenticated user.

    GET /destination/{destination_id}

  • Read

    Get all the destinations of a recurring event

    This method returns every destination of the specified event. The authenticated user must be the owner of the event.

    GET /me/live_events/{live_event_id}/destinations

  • Read

    Get all available event destinations for the user to stream to

    This method returns every available event destination for the authenticated user to stream to.

    GET /users/{user_id}/destinations

  • Read

    Get all the OTT destinations of a recurring event

    This method returns every OTT destination of the specified event. The authenticated user must be the owner of the event.

    GET /users/{user_id}/live_events/{live_event_id}/ott_destinations

  • Write

    Update an event destination

    This method updates the specified event destination belonging to the authenticated user.

    PATCH /destination/{destination_id}

  • Write

    Create an event destination

    This method creates a destination for the specified event. The authenticated user must be the owner of the event.

    POST /me/live_events/{live_event_id}/destinations

  • Write

    Create an event OTT destination

    This method creates an OTT channel as the destination of the specified event. The authenticated user must be the owner of the event.

    POST /users/{user_id}/live_events/{live_event_id}/ott_destinations

  • Destructive

    Delete an event destination

    This method deletes the specified event destination belonging to the authenticated user.

    DELETE /destination/{destination_id}

  • Destructive

    Delete an event OTT destination

    This method deletes an OTT channel as the destination of the specified event. The authenticated user must be the owner of the event.

    DELETE /users/{user_id}/live_events/{live_event_id}/ott_destination/{destination_id}

live / event-end

  • Write

    End an event

    This method ends the specified event. The authenticated user must be the owner of the event.

    POST /users/{user_id}/live_events/{live_event_id}/end

live / event-localizations

  • Read

    Get the localizations of a live event

    This method returns the localization configuration of a live event for the editor, including every target locale's published and draft values and their provenance.

    GET /live_events/{live_event_id}/localizations

  • Write

    Configure the source locale of a live event

    This method configures localization for a live event by recording which locale its existing title and description are authored in, or changes that locale while no target locales exist.

    PATCH /live_events/{live_event_id}/localizations

  • Write

    Translate live event localization strings

    This method machine-translates live event content strings from the configured source locale into one or more target locales. Nothing is saved; the caller stores the results via the locale PUT endpoint.

    POST /live_events/{live_event_id}/localizations/translate

  • Write

    Publish or unpublish a target locale of a live event

    This method publishes or unpublishes an already-saved target locale of a live event. `published` makes the locale's newest work live: a draft saved by a previous `PUT publish=false` is promoted and cleared, and a locale with no draft simply goes back on the page with what it already had. `unpublished` withholds the locale and keeps both halves, so republishing restores the language with no re-translation; use `DELETE` to discard it instead. Taking a language down never disturbs a draft outstanding over it.

    PATCH /live_events/{live_event_id}/localizations/{locale}

  • Write

    Replace a target locale of a live event

    This method replaces the localized values of one target locale of a live event. The whole document is replaced: a leaf omitted from the body is removed and falls back to the source value. Saving with `publish=false` stores the document as an editor-only working copy. Viewers keep being served the last published values for this locale, or the source content when it has never been published. Saving with `publish=true` (the default) makes the document live, which includes offering a locale the creator had previously unpublished. An editor that wants to edit a withheld locale without putting it back on the page must save with `publish=false`. Because the save is a full replacement, two editors on one locale would otherwise silently overwrite each other. Send back the `version` the GET returned to make the save conditional on the document not having changed since it was read.

    PUT /live_events/{live_event_id}/localizations/{locale}

  • Destructive

    Remove a target locale from a live event

    This method removes one target locale from a live event. The source locale selection is kept even when the last target is removed, so the source locale becomes changeable again.

    DELETE /live_events/{live_event_id}/localizations/{locale}

live / event-low-latency

  • Write

    Toggle the low-latency option of an event

    This method toggles the low-latency option of the specified event.

    PATCH /users/{user_id}/live_events/{live_event_id}/low_latency

live / event-m3u8-playback

  • Read

    Get an M3U8 playback URL for an event

    This method returns an M3U8 playback URL for the specified event stream. You should use this endpoint only in conjunction with our recommended procedure for playing events via HLS. For more information, see our [HLS guide](https://developer.vimeo.com/api/live/playback).

    GET /users/{user_id}/live_events/{live_event_id}/m3u8_playback

live / event-sessions

  • Read

    Get the ingest status of an event

    This method returns the ingest status of the specified event and associated video.

    GET /live_events/{live_event_id}/session_status

  • Read

    Get the ingest status of a one-time event

    This method returns the ingest status of the specified event.

    GET /videos/{video_id}/sessions/status

live / event-speaker-profiles

  • Read

    Get all the speakers of a live event

    This method returns every speaker attached to the specified event, in display order.

    GET /live_events/{live_event_id}/speaker_profiles

  • Read

    Get a speaker of a live event

    This method returns a single speaker of the specified event. Users who can edit the event see the speaker regardless of visibility; other users can only see it if it's visible, and get a 404 if it's hidden.

    GET /live_events/{live_event_id}/speaker_profiles/{speaker_profile_id}

  • Write

    Attach a speaker to a live event

    This method adds a speaker to the specified event by attaching a person profile that already exists in the account's reusable library. Profiles are managed on their own endpoints; this one never creates them. Attaching is idempotent. Re-attaching a person who is already a speaker returns the existing speaker with a `200 OK` instead of creating a duplicate, and re-attaching someone who was previously removed revives that same speaker at the end of the list.

    POST /live_events/{live_event_id}/speaker_profiles

  • Write

    Edit a speaker of a live event

    This method shows or hides a speaker on the specified event.

    PATCH /live_events/{live_event_id}/speaker_profiles/{speaker_profile_id}

  • Destructive

    Remove a speaker from a live event

    This method removes a speaker from the specified event. The underlying person profile stays in the account's reusable library.

    DELETE /live_events/{live_event_id}/speaker_profiles/{speaker_profile_id}

live / event-thumbnails

  • Read

    Get all the thumbnails of an event

    This method returns every thumbnail image of the specified event.

    GET /users/{user_id}/live_events/{live_event_id}/pictures

  • Read

    Get a specific event thumbnail

    This method returns a single thumbnail image of the specified event.

    GET /users/{user_id}/live_events/{live_event_id}/pictures/{thumbnail_id}

  • Write

    Create an event thumbnail

    This method creates a thumbnail image for the specified event.

    POST /users/{user_id}/live_events/{live_event_id}/pictures

  • Write

    Edit an event thumbnail

    This method edits a thumbnail image for the specified event.

    PATCH /users/{user_id}/live_events/{live_event_id}/pictures/{thumbnail_id}

  • Destructive

    Delete an event thumbnail

    This method deletes a thumbnail image for the specified event.

    DELETE /users/{user_id}/live_events/{live_event_id}/pictures/{thumbnail_id}

live / event-videos

  • Read

    Get all the videos in an event

    This method returns every video in the specified event.

    GET /users/{user_id}/live_events/{live_event_id}/videos

  • Read

    Get a specific video in an event

    This method returns a single video in the specified event.

    GET /users/{user_id}/live_events/{live_event_id}/videos/{video_id}

  • Write

    Add a list of videos to an event

    This method adds multiple videos to the specified event.

    POST /users/{user_id}/live_events/{live_event_id}/videos

  • Destructive

    Remove a list of videos from an event

    This method removes multiple videos from the specified event.

    DELETE /users/{user_id}/live_events/{live_event_id}/videos

live / graphics

  • Read

    Get all the video graphics items that belong to an event

    The method returns every video graphics item belonging to the specified event.

    GET /live_events/{live_event_id}/composer/graphics/videos

  • Write

    Add a new video graphics item to an event

    This method add a new video graphics item to the specified event.

    POST /live_events/{live_event_id}/composer/graphics/videos

  • Destructive

    Delete a video graphics item that belongs to an event

    This method deletes a video graphics item belonging to the specified event.

    DELETE /live_events/{live_event_id}/composer/graphics/videos/{video_id}

live / scenes

  • Read

    Get all the scenes that belong to an event

    The method returns every scene belonging to the specified event.

    GET /live_events/{live_event_id}/composer/scenes

  • Write

    Create a scene for an event

    The method creates a new scene for the specified event.

    POST /live_events/{live_event_id}/composer/scenes

  • Write

    Update the scene that belong to an event

    The method updates a scene belonging to the specified event.

    PATCH /live_events/{live_event_id}/composer/scenes/{scene_id}

  • Write

    Attach a graphic item to a scene

    This method attaches a graphic item to the specified scene.

    POST /live_events/{live_event_id}/composer/scenes/{scene_id}/graphics

  • Destructive

    Reset the scenes that belong to an event

    The method resets the scenes that belong to the specified event by deleting every existing scene and then recreating the default scene.

    DELETE /live_events/{live_event_id}/composer/scenes

on-demand / essentials

  • Read

    Get a specific On Demand page

    This method returns the specified On Demand page.

    GET /ondemand/pages/{ondemand_id}

  • Read

    Get all the On Demand pages of the user

    This method returns every On Demand page belonging to the authenticated user.

    GET /users/{user_id}/ondemand/pages

  • Write

    Edit an On Demand page

    This method edits the specified On Demand page. Use this method to enable preorders on the page or to publish the page.

    PATCH /ondemand/pages/{ondemand_id}

  • Write

    Create an On Demand page

    This method creates a new On Demand page for the specified user. To publish the page, use the [edit](https://developer.vimeo.com/api/reference/on-demand#edit_vod) method.

    POST /users/{user_id}/ondemand/pages

  • Destructive

    Delete an On Demand page

    This method deletes the specified On Demand page.

    DELETE /ondemand/pages/{ondemand_id}

on-demand / backgrounds

  • Read

    Get all the backgrounds on an On Demand page

    This method returns every background image on the specified On Demand page. The authenticated user must be the owner of the page.

    GET /ondemand/pages/{ondemand_id}/backgrounds

  • Read

    Get a specific background on an On Demand page

    This method returns a single background image on the specified On Demand page. The authenticated user must be the owner of the page.

    GET /ondemand/pages/{ondemand_id}/backgrounds/{background_id}

  • Write

    Add a background to an On Demand page

    This method adds a background image to the specified On Demand page. The authenticated user must be the owner of the page.

    POST /ondemand/pages/{ondemand_id}/backgrounds

  • Write

    Edit a background on an On Demand page

    This method edits the specified background image on an On Demand page. The authenticated user must be the owner of the page.

    PATCH /ondemand/pages/{ondemand_id}/backgrounds/{background_id}

  • Destructive

    Delete a background on an On Demand page

    This method deletes the specified background image on an On Demand page. The authenticated user must be the owner of the page.

    DELETE /ondemand/pages/{ondemand_id}/backgrounds/{background_id}

on-demand / genres

  • Read

    Get all On Demand genres

    This method returns every existing On Demand genre.

    GET /ondemand/genres

  • Read

    Get a specific On Demand genre

    This method returns a single On Demand genre.

    GET /ondemand/genres/{genre_id}

  • Read

    Get all the On Demand pages in a genre

    This method returns every On Demand page that belongs to the specified genre.

    GET /ondemand/genres/{genre_id}/pages

  • Read

    Get a specific On Demand page in a genre

    This method returns a single On Demand page that belongs to the specified genre.

    GET /ondemand/genres/{genre_id}/pages/{ondemand_id}

  • Read

    Get all the genres of an On Demand page

    This method returns every genre associated with the specified On Demand page.

    GET /ondemand/pages/{ondemand_id}/genres

  • Read

    Check whether an On Demand page belongs to a specific genre

    This method determines whether an On Demand page is associated with the specified genre.

    GET /ondemand/pages/{ondemand_id}/genres/{genre_id}

  • Write

    Add a genre to an On Demand page

    This method adds the specified genre designation to an On Demand page. A page can be associated with a maximum of two genres. The authenticated user must be the owner of the page.

    PUT /ondemand/pages/{ondemand_id}/genres/{genre_id}

  • Destructive

    Remove a genre from an On Demand page

    This method removes a genre association from the specified On Demand page. The authenticated user must be the owner of the page.

    DELETE /ondemand/pages/{ondemand_id}/genres/{genre_id}

on-demand / posters

  • Read

    Get all the posters on an On Demand page

    This method returns every poster on the specified On Demand page.

    GET /ondemand/pages/{ondemand_id}/pictures

  • Read

    Get a specific poster on an On Demand page

    This method returns a single poster on the specified On Demand page.

    GET /ondemand/pages/{ondemand_id}/pictures/{poster_id}

  • Write

    Add a poster to an On Demand page

    This method adds a poster image to the specified On Demand page. The authenticated user must be the owner of the page.

    POST /ondemand/pages/{ondemand_id}/pictures

  • Write

    Edit a poster on an On Demand page

    This method edits a poster image on the specified On Demand page. The authenticated user must be the owner of the page.

    PATCH /ondemand/pages/{ondemand_id}/pictures/{poster_id}

on-demand / promotions

  • Read

    Get all the promotions on an On Demand page

    This method returns every promotion on the specified On Demand page. The authenticated user must be the owner of the page.

    GET /ondemand/pages/{ondemand_id}/promotions

  • Read

    Get a specific promotion on an On Demand page

    This method returns a single promotion on the specified On Demand page. The authenticated user must be the owner of the page.

    GET /ondemand/pages/{ondemand_id}/promotions/{promotion_id}

  • Read

    Get all the codes of a promotion on an On Demand page

    This method returns every code of the specified promotion on an On Demand page. The authenticated user must be the owner of the page.

    GET /ondemand/pages/{ondemand_id}/promotions/{promotion_id}/codes

  • Write

    Add a promotion to an On Demand page

    This method adds a promotion to the specified On Demand page. The authenticated user must be the owner of the page.

    POST /ondemand/pages/{ondemand_id}/promotions

  • Destructive

    Delete a promotion on an On Demand page

    This method deletes a promotion on the specified On Demand page. The authenticated user must be the owner of the page.

    DELETE /ondemand/pages/{ondemand_id}/promotions/{promotion_id}

on-demand / purchases-and-rentals

  • Read

    Get all of the user's On Demand purchases and rentals

    This method returns every purchase and rental that the authenticated user has made across all On Demand pages.

    GET /users/{user_id}/ondemand/purchases

on-demand / regions

  • Read

    Get all the regions on an On Demand page

    This method returns every region on the specified On Demand page. The authenticated user must be the owner of the page.

    GET /ondemand/pages/{ondemand_id}/regions

  • Read

    Get a specific region on an On Demand page

    This method returns a single region on the specified On Demand page. The authenticated user must be the owner of the page.

    GET /ondemand/pages/{ondemand_id}/regions/{country}

  • Read

    Get all the On Demand regions

    This method returns every existing On Demand region.

    GET /ondemand/regions

  • Read

    Get a specific On Demand region

    This method returns a single On Demand region.

    GET /ondemand/regions/{country}

  • Write

    Add a list of regions to an On Demand page

    This method adds multiple regions to the specified On Demand page. The authenticated user must be the owner of the page.

    PUT /ondemand/pages/{ondemand_id}/regions

  • Write

    Add a specific region to an On Demand page

    This method adds a single region to the specified On Demand page. The authenticated user must be the owner of the page.

    PUT /ondemand/pages/{ondemand_id}/regions/{country}

  • Destructive

    Remove a list of regions from an On Demand page

    This method removes multiple regions from the specified On Demand page. The authenticated user must be the owner of the page.

    DELETE /ondemand/pages/{ondemand_id}/regions

  • Destructive

    Remove a specific region from an On Demand page

    This method removes a single region from the specified On Demand page. The authenticated user must be the owner of the page.

    DELETE /ondemand/pages/{ondemand_id}/regions/{country}

on-demand / seasons

  • Read

    Get all the seasons on an On Demand page

    This method returns every season on the specified On Demand page.

    GET /ondemand/pages/{ondemand_id}/seasons

  • Read

    Get a specific season on an On Demand page

    This method returns a single season on the specified On Demand page.

    GET /ondemand/pages/{ondemand_id}/seasons/{season_id}

  • Read

    Get all the videos in a season on an On Demand page

    This method returns every video in the specified season on an On Demand page.

    GET /ondemand/pages/{ondemand_id}/seasons/{season_id}/videos

on-demand / videos

  • Read

    Get all the videos on an On Demand page

    This method returns every video on the specified On Demand page.

    GET /ondemand/pages/{ondemand_id}/videos

  • Read

    Get a specific video on an On Demand page

    This method returns a single video on the specified On Demand page. Use this method to determine whether the video is on the page.

    GET /ondemand/pages/{ondemand_id}/videos/{video_id}

  • Write

    Add a video to an On Demand page

    This method adds a video to the specified On Demand page. The authenticated user must be the owner of the page.

    PUT /ondemand/pages/{ondemand_id}/videos/{video_id}

  • Destructive

    Remove a video from an On Demand page

    This method removes a video from the specified On Demand page. The authenticated user must be the owner of the page.

    DELETE /ondemand/pages/{ondemand_id}/videos/{video_id}

payments / essentials

  • Read

    Get a list of all payments service payment methods

    This method returns a list of all Vimeo payments service payment methods that are available to the authenticated user.

    GET /me/payment_methods

  • Read

    Get information about a payments service payment method

    This method returns information about the specified Vimeo payments service payment method.

    GET /me/payment_methods/{payment_method_id}

  • Read

    Get information about a payments service subscription

    This method returns information about the specified Vimeo payments service subscription.

    GET /users/{user_id}/subscriptions/{subscription_id}

  • Destructive

    Delete a payments service payment method

    This method deletes the specified Vimeo payments service payment method.

    DELETE /me/payment_methods/{payment_method_id}

person-profiles / essentials

  • Read

    Get all the person profiles of an account

    This method returns every person profile in the authenticated account's reusable speaker library, most recently modified first.

    GET /me/person_profiles

  • Read

    Get a person profile

    This method returns a single person profile from an account's reusable speaker library.

    GET /person_profiles/{person_profile_id}

  • Read

    Get all the thumbnails of a person profile

    This method returns every thumbnail upload belonging to the specified person profile.

    GET /person_profiles/{person_profile_id}/pictures

  • Write

    Create a person profile

    This method adds a person profile to the authenticated account's reusable speaker library.

    POST /me/person_profiles

  • Write

    Edit a person profile

    This method edits a person profile. Only the supplied fields are changed; `role`, `description`, and `avatar_crop` can be cleared by sending `null`.

    PATCH /person_profiles/{person_profile_id}

  • Write

    Add a thumbnail upload slot for a person profile

    This method returns a link for uploading a thumbnail image for the specified person profile.

    POST /person_profiles/{person_profile_id}/pictures

  • Write

    Activate a person profile thumbnail

    This method marks the specified uploaded image as the active thumbnail of the person profile.

    PATCH /person_profiles/{person_profile_id}/pictures/{picture_id}

  • Destructive

    Delete a person profile

    This method removes a person profile from an account's reusable speaker library. The profile is also detached from every live event that used it.

    DELETE /person_profiles/{person_profile_id}

portfolios / essentials

  • Read

    Get all the portfolios that belong to the user

    This method returns every portfolio belonging to the authenticated user.

    GET /users/{user_id}/portfolios

  • Read

    Get a specific portfolio

    This method returns a single portfolio belonging to the authenticated user.

    GET /users/{user_id}/portfolios/{portfolio_id}

portfolios / videos

  • Read

    Get all the videos in a portfolio

    This method returns every video from the specified portfolio belonging to the authenticated user.

    GET /users/{user_id}/portfolios/{portfolio_id}/videos

  • Read

    Get a specific video in a portfolio

    This method returns a single video from the specified portfolio belonging to the authenticated user.

    GET /users/{user_id}/portfolios/{portfolio_id}/videos/{video_id}

  • Write

    Add a video to a portfolio

    This method adds a video to the specified portfolio belonging to the authenticated user.

    PUT /users/{user_id}/portfolios/{portfolio_id}/videos/{video_id}

  • Destructive

    Remove a video from a portfolio

    This method removes a video from the specified portfolio belonging to the authenticated user.

    DELETE /users/{user_id}/portfolios/{portfolio_id}/videos/{video_id}

search / federated

  • Read

    Get the federated search results of the user's items

    This method returns the federated search results of the authenticated user's videos and folders according to a search query. If no query is provided, the method returns items sorted by the most recent user action.

    GET /search/{user_id}/items

showcases / essentials

  • Read

    Get all the showcases that belong to the user

    This method returns every showcase belonging to the authenticated user.

    GET /users/{user_id}/albums

  • Read

    Get a specific showcase

    This method returns the specified showcase. The authenticated user must be the owner of the showcase.

    GET /users/{user_id}/albums/{album_id}

  • Write

    Add videos and events to showcases

    This method adds videos and events to the specified showcases. The authenticated user must either be the owner of the showcase or have team permissions. The present setup permits only one event per showcase.

    PATCH /users/{user_id}/albums

  • Write

    Create a showcase

    This method creates a new showcase for the specified user.

    POST /users/{user_id}/albums

  • Write

    Add folder contents to showcases

    This method adds all videos and events from a specified folder to showcases. The authenticated user must either be the owner of the showcase or have team permissions.

    PATCH /users/{user_id}/albums/from_folder

  • Write

    Edit a showcase

    This method edits the specified showcase. The authenticated user must be the owner of the showcase.

    PATCH /users/{user_id}/albums/{album_id}

  • Write

    Copy a showcase

    This method creates a copy of the specified showcase.

    POST /users/{user_id}/albums/{album_id}/copy

  • Destructive

    Delete a showcase

    This method deletes the specified showcase. The authenticated user must be the owner of the showcase.

    DELETE /users/{user_id}/albums/{album_id}

showcases / custom-showcase-logos

  • Read

    Get all the custom logos of a showcase

    This method returns every custom logo of the specified showcase. The authenticated user must be the owner of the showcase.

    GET /users/{user_id}/albums/{album_id}/logos

showcases / custom-showcase-thumbnails

  • Read

    Get all the custom thumbnails of a showcase

    This method returns every custom thumbnail of the specified showcase.

    GET /users/{user_id}/albums/{album_id}/custom_thumbnails

  • Read

    Get a specific custom showcase thumbnail

    This method returns a single custom thumbnail of the specified showcase. The authenticated user must be the owner of the showcase.

    GET /users/{user_id}/albums/{album_id}/custom_thumbnails/{thumbnail_id}

  • Write

    Add a custom thumbnail to a showcase

    This method adds an uploaded image file as a custom thumbnail for the specified showcase. The image doesn't need to be a still from a showcase video, unlike with the [standard thumbnail method](https://developer.vimeo.com/api/reference/showcases#set_video_as_showcase_thumbnail). The authenticated user must be the owner of the showcase. For information on how to upload the thumbnail, see our [Working with Thumbnail Uploads](https://developer.vimeo.com/api/upload/thumbnails) guide, and follow the same steps.

    POST /users/{user_id}/albums/{album_id}/custom_thumbnails

  • Write

    Replace a custom showcase thumbnail

    This method replaces the specified custom showcase thumbnail with a new image file. The authenticated user must be the owner of the showcase. For information on how to upload the thumbnail, see our [Working with Thumbnail Uploads](https://developer.vimeo.com/api/upload/thumbnails) guide.

    PATCH /users/{user_id}/albums/{album_id}/custom_thumbnails/{thumbnail_id}

  • Destructive

    Delete a custom showcase thumbnail

    This method deletes the specified custom thumbnail from its showcase. The authenticated user must be the owner of the showcase.

    DELETE /users/{user_id}/albums/{album_id}/custom_thumbnails/{thumbnail_id}

showcases / showcase-videos

  • Read

    Get all the user's videos that can be added to or removed from a showcase

    This method returns every video belonging to the authenticated user that can be added to or removed from the specified showcase.

    GET /albums/{album_id}/available_videos

  • Read

    Get all the videos in a showcase

    This method returns every video in the specified showcase. The authenticated user must be the owner of the showcase.

    GET /users/{user_id}/albums/{album_id}/videos

  • Read

    Get a specific video in a showcase

    This method returns a single video belonging to the specified showcase. The authenticated user must be the owner of the showcase.

    GET /users/{user_id}/albums/{album_id}/videos/{video_id}

  • Read

    Get all the showcases to which the user can add or remove a specific video

    This method returns every showcase to which the authenticated user can add or remove the specified video. The user must be the owner of the showcase.

    GET /videos/{video_id}/available_albums

  • Write

    Replace all the videos in a showcase

    This method replaces all the videos in the specified showcase with a new set of one or more videos. The authenticated user must be the owner of the showcase.

    PUT /users/{user_id}/albums/{album_id}/videos

  • Write

    Add a specific video to a showcase

    This method adds a single video to the specified showcase. The authenticated user must be the owner of the showcase.

    PUT /users/{user_id}/albums/{album_id}/videos/{video_id}

  • Write

    Create a thumbnail for a showcase from a showcase video

    This method creates a thumbnail image for a showcase from the specified frame of a showcase video. The authenticated user must be the owner of the showcase.

    POST /users/{user_id}/albums/{album_id}/videos/{video_id}/set_album_thumbnail

  • Destructive

    Remove a video from a showcase

    This method removes the specified video from its showcase. The authenticated user must be the owner of the showcase.

    DELETE /users/{user_id}/albums/{album_id}/videos/{video_id}

subscription-plans / essentials

  • Read

    Get a single subscription plan

    This method returns the specified subscription plan.

    GET /subscription_plans/{tier}

tags / essentials

  • Read

    Get a tag

    This method returns the specified tag.

    GET /tags/{word}

teams / essentials

  • Read

    Get a team's custom metadata fields

    This method returns every custom metadata field defined for the specified team. Custom metadata fields let teams attach structured, queryable information to videos (for example, a department selector, a release date, or a freeform note). Once a field is defined here, you can assign per-video values via `PUT /videos/{video_id}/custom_metadata`. The response contains the field definitions only; per-video values are returned by the video endpoints. Use this method to populate a UI that lets users fill in metadata, or to discover the field IDs you need for backfills and value updates.

    GET /teams/{user_id}/custom_metadata

  • Read

    List videos missing mandatory custom metadata

    This method returns the team's videos that are missing one or more values for **mandatory** custom metadata fields. Use it to power dashboards that surface incomplete videos, drive curation workflows, or generate reports of catalog completeness. Each item in the response includes the video's title and identifier, a link to the video's management page, a thumbnail, the last modified timestamp, and the list of mandatory fields that still need a value (each with its `field_id` and `name`). Only fields marked `mandatory: true` (see `POST /teams/{user_id}/custom_metadata`) are considered. Teams with no mandatory fields receive an empty result set.

    GET /teams/{user_id}/custom_metadata/incomplete_videos

  • Write

    Backfill a custom metadata value across a team's videos

    This method applies a custom metadata value across every existing video owned by the team. Use it to populate a newly created field, fix a typo across a library, or align a large catalog after a workflow change. The backfill runs **asynchronously**. The response is returned as soon as the job is accepted, but the values themselves are propagated in the background and may take several minutes for large libraries. The `total_videos` count in the response is a snapshot of how many videos match the request at the moment it's accepted; videos uploaded after that point aren't included and need a separate backfill. By default, only videos that don't already have a value for the field are updated. Set `override_existing` to `true` to replace existing values as well. The value provided must match the field's data type. For example, a `date` field requires `YYYY-MM-DD`, a `select` field requires one of its allowed values, and a `multi-select` field requires a JSON-encoded array of allowed values.

    POST /teams/{user_id}/custom_metadata/backfill

  • Destructive

    Create, update, or delete a team's custom metadata fields

    This method creates, updates, or deletes custom metadata fields for a team in a single request. Each entry in the `fields` array is treated independently: - To **create** a new field, omit `id` and provide `name`, `type`, and `mandatory`. - To **update** an existing field, provide `id` along with the values you want to change. Other values are left untouched. - To **delete** an existing field, provide `id` and set `delete: true`. Deleting a field also removes every value assigned to it across the team's videos. Some constraints are worth knowing up front: - A team can have a maximum of 20 custom metadata fields. Requests that would exceed that limit after deletes are applied are rejected. - The `type` of an existing field can't be changed once the field is created. - A field that was created as optional can't be made `mandatory` later. - All operations in the request are applied as a single batch; if any one fails the whole request is rejected and no changes are saved.

    POST /teams/{user_id}/custom_metadata

  • Destructive

    Add, rename, or remove a custom metadata field's allowed values

    This method modifies the allowed value list of a `select` or `multi-select` custom metadata field. Use it to rename an option, remove an option, or add a new option without recreating the field. Each entry in the `options` array describes one atomic change, defined by combining `old_value` and `new_value`: | `old_value` | `new_value` | Operation | | --------------- | --------------- | ------------------------------ | | string | string | Rename `old_value` to `new_value` | | string | `null` / omitted | Delete `old_value` from the field | | `null` / omitted | string | Add `new_value` to the field | Renames are propagated to every existing video that uses the option, so the change is visible across the team's library. Deletes also remove the option from every video that had it set. Propagation runs in the background; the field's option list itself is updated synchronously and returned in the response. A few rules to be aware of: - The field must be of type `select` or `multi-select`. Other types reject the request. - Cascading renames (renaming `A` to `B`, then `B` to `C` in the same call) are not allowed; submit them as separate requests if you need that effect. - The resulting option list must not contain duplicates.

    PATCH /teams/{user_id}/custom_metadata/options

teams / members

  • Read

    Get membership information about a team

    This method returns information about the membership of the specified team. Usage is currently limited to the team join forms.

    GET /teammembers/{code}

  • Read

    Get information about the user's role on a team

    This method returns information about the authenticated user's role on the specified team owner's team.

    GET /users/{user_id}/team/role

  • Read

    Get membership information about a team

    This method returns information about the membership of the specified team. Usage is currently limited to the team join forms.

    GET /users/{user_id}/team_users/{team_user_id}

tutorial / essentials

  • Read

    Get started with the Vimeo API

    This method tests whether users who are working through the [Getting Started](https://developer.vimeo.com/api/guides/start) guides have set up their configurations correctly.

    GET /tutorial

users / essentials

  • Read

    Get the user

    This method returns the authenticated user.

    GET /users/{user_id}

  • Write

    Edit the user's account

    This method edits the Vimeo account of the authenticated user.

    PATCH /users/{user_id}

users / analytics

  • Read

    Get video analytics for the authenticated user

    This method returns video analytics for the authenticated user's Vimeo account.

    GET /users/{user_id}/analytics

users / feeds

  • Read

    Get all the videos in the user's feed

    This method returns every video in the authenticated user's feed.

    GET /users/{user_id}/feed

users / followers

  • Read

    Get all the followers of the user

    This method returns every follower of the authenticated user.

    GET /users/{user_id}/followers

  • Read

    Get all the users who are followed by the user

    This method returns every user who is followed by the authenticated user.

    GET /users/{user_id}/following

  • Read

    Check if the user is following another user

    This method determines whether the authenticated user is a follower of the specified user.

    GET /users/{user_id}/following/{follow_user_id}

  • Write

    Follow a list of users

    This method causes the authenticated user to become a follower of multiple users. In the body of the request, specify the list of users to follow as an array of URIs, where `user01_id`, `user02_id`, `user03_id`, and so on, are the user IDs of the users in question: ``` { [ {"uri" : "/users/{user01_id}"}, {"uri" : "/users/{user02_id}"}, {"uri" : "/users/{user03_id}"} ] } ```

    POST /users/{user_id}/following

  • Write

    Follow a specific user

    This method causes the authenticated user to become the follower of the specified user.

    PUT /users/{user_id}/following/{follow_user_id}

  • Destructive

    Unfollow a user

    This method causes the authenticated user to stop following another user.

    DELETE /users/{user_id}/following/{follow_user_id}

users / lms

  • Read

    Create and download a proxy package for upload to a learning management system

    This method creates and returns a zipped proxy package of the course associated with the specified video. This package is suitable for direct upload to a learning management system.

    GET /users/{user_id}/lms/download/{video_id}

users / pictures

  • Read

    Get all the pictures that belong to the user

    This method returns every portrait image belonging to the authenticated user.

    GET /users/{user_id}/pictures

  • Read

    Get a specific picture that belongs to the user

    This method returns a single portrait image belonging to the authenticated user.

    GET /users/{user_id}/pictures/{portraitset_id}

  • Write

    Add a picture to the user's account

    This method adds a portrait image to the authenticated user's Vimeo account. Send the binary data of the image file to the location that you receive from the **link** field in the response. For step-by-step instructions, see [Working with Thumbnail Uploads](https://developer.vimeo.com/api/upload/thumbnails#uploading-a-thumbnail-step-3).

    POST /users/{user_id}/pictures

  • Write

    Edit a picture in the user's account

    This method edits the specified portrait image belonging to the authenticated user.

    PATCH /users/{user_id}/pictures/{portraitset_id}

  • Destructive

    Delete a picture from the user's account

    This method removes the specified portrait image from the authenticated user's Vimeo account.

    DELETE /users/{user_id}/pictures/{portraitset_id}

users / search

  • Read

    Search for users

    This method returns user search results.

    GET /users

users / watch-history

  • Read

    Get all the videos that a user has watched

    This method returns every video on the authenticated user's watch history. _This endpoint is deprecated. Any request to it returns empty data with HTTP status code 200._

    GET /me/watched/videos

  • Destructive

    Delete the user's watch history

    This method deletes the entire watch history of the authenticated user.

    DELETE /me/watched/videos

  • Destructive

    Delete a specific video from the user's watch history

    This method deletes the specified video from the authenticated user's watch history.

    DELETE /me/watched/videos/{video_id}

videos / essentials

  • Read

    Get all the videos in which the user appears

    This method returns all the videos in which the authenticated user has a credited appearance.

    GET /users/{user_id}/appearances

  • Read

    Get all the videos that the user has uploaded

    This method returns all the videos that the authenticated user has uploaded.

    GET /users/{team_owner_id}/videos

  • Read

    Check if the user owns a video

    This method determines whether the authenticated user is the owner of the specified video.

    GET /users/{user_id}/videos/{video_id}

  • Read

    Search for videos

    This method returns all the videos that match custom search criteria.

    GET /videos

  • Read

    Get a specific video

    This method returns a single video.

    GET /videos/{video_id}

  • Write

    Copy a video

    This method creates a copy of the specified video. Only the source's current version is copied; prior version history is not carried over.

    POST /users/{user_id}/videos/{video_id}/copy

  • Write

    Edit a video

    This method edits the specified video.

    PATCH /videos/{video_id}

  • Write

    Set custom metadata values for a video

    This method sets, updates, or clears custom metadata values on a single video. The authenticated user must own the video or have team permission to edit it. Send each value as a `{field_id, field_value}` pair under the `fields` array. The value's data type is validated against the field's definition (set via `POST /teams/{user_id}/custom_metadata`): | Type | Accepted format | | -------------- | ------------------------------------------------------- | | `str` | A non-empty string of up to 50 characters | | `int` | An integer, optionally negative (for example, `42`) | | `date` | `YYYY-MM-DD` | | `bool` | `"true"`, `"false"`, `"1"`, or `"0"` | | `select` | One of the values defined for the field | | `multi-select` | A JSON-encoded array of allowed values | To clear an existing value, send `field_value: null`. The field will return to its default value (if one is defined) or become unset.

    PUT /videos/{video_id}/custom_metadata

  • Destructive

    Delete a user's videos

    This method deletes one or more videos belonging to the specified user. The authenticated user must have permission to delete the videos. Specify the videos to delete in a comma-separated list by URI using the **uris** query parameter.

    DELETE /users/{user_id}/videos

  • Destructive

    Delete a video

    This method deletes the specified video. The authenticated user must be the owner of the video.

    DELETE /videos/{video_id}

videos / ai

  • Read

    Get supported languages for AI features

    This method returns the list of supported languages for AI features. Use the `type` query parameter to filter by feature: `transcription` for speech-to-text languages, `subtitling` for subtitle translation languages, or `dubbing` for audio dubbing languages (includes available accents per language).

    GET /videos/ai/languages

  • Read

    Get suggested questions for a video

    This method returns pre-generated questions and answers about a video. These are automatically created when the video is processed and provide a starting point for exploring the video's content. The first request for a new video may return a `202` response while artifacts are being generated — retry until ready. Questions are available in `en`, `fr`, `es`, `de`, `it`, `pt`, `ja`, and `ko`. English is returned by default.

    GET /videos/{video_id}/ai/ask

  • Read

    Get AI-generated video metadata

    This method returns AI-generated metadata for the specified video, including a suggested title, description, and tags based on the video's content. The first request for a new video may return a `202` response while the video is being processed — retry until ready.

    GET /videos/{video_id}/ai/metadata

  • Read

    Get AI transcription status for a video

    This method returns the current transcription status for a video. The response includes the `video_id`, `status`, and `language`. When the status is `completed`, the response also includes the `texttrack_id` which can be used to read the transcript via `GET /videos/{video_id}/transcripts/{texttrack_id}`. Possible status values: `none` (no transcription requested), `not_started` (queued, awaiting processing), `in_progress`, `completed`, `failed`, `language_not_supported`, `no_speech`, `exceeds_maximum_duration`, `blocked`, `unknown`.

    GET /videos/{video_id}/ai/transcribe

  • Read

    Get AI dubbing status for a video

    This method returns the audio dubbing jobs for a video. Each entry includes the language, current status, and — when completed — the `texttrack_id` of the dubbed subtitles and the `audiotrack_uri` of the dubbed audio. Only completed jobs whose text track still exists are included; deleted tracks are omitted. Possible status values: `processing`, `completed`, `completed_with_deleted_texttrack`, `completed_with_deleted_audiotrack`, `failed`, `invalid_input` (the source content was not suitable for dubbing), `not_found`, `unknown`. Jobs where both the text track and audio track have been deleted are omitted entirely.

    GET /videos/{video_id}/ai/translate/dubbing

  • Read

    Get AI subtitle translation status for a video

    This method returns the subtitle translation jobs for a video. Each entry includes the language, current status, and — when completed — the `texttrack_id` of the resulting text track. Only completed translations whose text track still exists are included; deleted tracks are omitted. Possible status values: `processing`, `completed`, `failed`, `invalid_input` (the source content was not suitable for translation), `not_found`, `unknown`.

    GET /videos/{video_id}/ai/translate/subtitles

  • Write

    Ask a question about a video

    This method asks a question about a video and returns an AI-generated answer with relevant quotes and timecodes. Answering questions requires generating artifacts from the video, so the first request for a new video may return a `202` response — simply retry until a `200` is returned with the answer.

    POST /videos/{video_id}/ai/ask

  • Write

    Edit text track segments

    This method edits transcript segments on the specified text track and automatically triggers the appropriate downstream actions based on the track type: - **Source transcript**: saves edits, then re-translates all subtitle children for the edited text segments. Timestamp and speaker changes are synced to children directly (no re-translation for speaker-only edits). - **Dubbed track**: saves edits and triggers audio re-synthesis for the edited segments. Re-synthesis fires on text edits and on speaker reassignment (the dub is regenerated under the new speaker's voice). - **Subtitle child**: saves text edits to this track only. Timestamp and speaker changes are synced to the parent track and all sibling subtitle tracks. To retrieve the `texttrack_id`, use the GET endpoints for [transcription](#get_ai_transcribe_status), [subtitle translation](#get_ai_translate_subtitles_status), or [dubbing](#get_ai_translate_dubbing_status). To retrieve segment UUIDs and their current text and timecodes, use `GET /videos/{video_id}/transcripts/{texttrack_id}`.

    PATCH /videos/{video_id}/ai/texttracks/{texttrack_id}

  • Write

    Start AI transcription for a video

    This method generates a transcript from the video's audio using AI speech-to-text. The video must not already have a transcript — delete the existing one first if you need to regenerate. Transcription is asynchronous; use `GET /videos/{video_id}/ai/transcribe` to poll for completion. Once complete, read the transcript via `GET /videos/{video_id}/transcripts/{texttrack_id}`. When no language is provided, the system attempts to auto-detect the spoken language from the video's audio. If detection fails or confidence is too low, it falls back to the video's locale, then the user's locale preference, then English (`en`).

    POST /videos/{video_id}/ai/transcribe

  • Write

    Start AI audio dubbing for a video

    This method starts an audio dubbing job for a video. By calling this endpoint, you confirm that you, and your end users, have met all legal requirements to use the voices of the people in the source video to create synthetic audio. This may include obtaining written consent. The video must have finished transcoding, have a completed transcript, and be under 150 minutes in duration. Dubbing is asynchronous; use `GET /videos/{video_id}/ai/translate/dubbing` to poll for completion. Once complete, the dubbed audio appears as an alternate audio track and translated subtitles appear as a new text track. AI credits are deducted from the enterprise account's balance. Dubbing costs more credits than subtitling.

    POST /videos/{video_id}/ai/translate/dubbing

  • Write

    Start AI subtitle translation for a video

    This method starts a subtitle translation job for a video. The video must have finished transcoding and have a completed transcript. Translation is asynchronous; use `GET /videos/{video_id}/ai/translate/subtitles` to poll for completion. Once complete, the translated subtitles appear as a new text track accessible via `GET /videos/{video_id}/texttracks`. AI credits are deducted from the enterprise account's balance.

    POST /videos/{video_id}/ai/translate/subtitles

videos / animated-thumbnails

  • Read

    Get all the animated thumbnails of a video

    This method returns all the sets of animated thumbnails associated with the specified video. The authenticated user must be the owner of the video.

    GET /videos/{video_id}/animated_thumbsets

  • Read

    Get a specific set of animated thumbnails

    This method returns a particular set of animated thumbnails associated with the specified video. The authenticated user must be the owner of the video.

    GET /videos/{video_id}/animated_thumbsets/{picture_id}

  • Read

    Get the status of a set of animated thumbnails

    This method returns the status of a particular set of animated thumbnails associated with the specified video. The status indicates whether the thumbnails are ready to use. The authenticated user must be the owner of the video.

    GET /videos/{video_id}/animated_thumbsets/{picture_id}/status

  • Write

    Create a set of animated thumbnails for a video

    This method creates a set of animated thumbnails for the specified video. Please note that you can't create more than four sets of animated thumbnails for the same video.

    POST /videos/{video_id}/animated_thumbsets

  • Destructive

    Delete a set of animated thumbnails for a video

    This method deletes a set of animated thumbnails for the specified video.

    DELETE /videos/{video_id}/animated_thumbsets/{picture_id}

videos / chapters

  • Read

    Get all the chapters of a video

    This method returns every chapter of the specified video.

    GET /videos/{video_id}/chapters

  • Read

    Get a single chapter thumbnail associated with an unsaved video chapter

    This method returns the specified thumbnail associated with an unsaved video chapter.

    GET /videos/{video_id}/chapters/temporary/pictures/{uid}

  • Read

    Get a specific chapter

    This method returns a single chapter of the specified video.

    GET /videos/{video_id}/chapters/{chapter_id}

  • Read

    Get all the thumbnails associated with a saved video chapter

    This method returns every thumbnail associated with the specified saved video chapter.

    GET /videos/{video_id}/chapters/{chapter_id}/pictures

  • Read

    Get a single chapter thumbnail associated with a saved video chapter

    This method returns the specified thumbnail associated with a saved video chapter.

    GET /videos/{video_id}/chapters/{chapter_id}/pictures/{uid}

  • Write

    Add a chapter to a video

    This method adds a chapter to the specified video.

    POST /videos/{video_id}/chapters

  • Write

    Edit a chapter

    This method edits the specified chapter of a video. The authenticated user must be the owner of the video.

    PATCH /videos/{video_id}/chapters/{chapter_id}

  • Write

    Set a chapter thumbnail as active

    This method sets the specified chapter thumbnail for a video as active.

    PATCH /videos/{video_id}/chapters/{chapter_id}/pictures/{uid}

  • Destructive

    Delete a chapter

    This method deletes the specified chapter from a video. The authenticated user must be the owner of the video.

    DELETE /videos/{video_id}/chapters/{chapter_id}

  • Destructive

    Delete a chapter thumbnail

    This method deletes the specified chapter thumbnail from a video. The authenticated user must be the owner of the video that the chapter belongs to. This method deletes both timecode-generated and custom-uploaded thumbnails.

    DELETE /videos/{video_id}/chapters/{chapter_id}/pictures/{uid}

videos / content-ratings

  • Read

    Get all content ratings

    This method returns all available content ratings.

    GET /contentratings

videos / creative-commons

  • Read

    Get all Creative Commons licenses

    This method returns all available Creative Commons licenses.

    GET /creativecommons

videos / credits

  • Read

    Get all the credited users in a video

    This method returns every credited user in a video.

    GET /videos/{video_id}/credits

  • Read

    Get users who can be credited on a video

    This method returns the users who can be credited on the specified video.

    GET /videos/{video_id}/credits/available_users

  • Read

    Get a specific credited user in a video

    This method returns a single credited user in a video.

    GET /videos/{video_id}/credits/{credit_id}

  • Write

    Credit a user in a video

    This method adds a user credit to the specified video.

    POST /videos/{video_id}/credits

  • Write

    Edit the credit for a user in a video

    This method edits the specified user credit in a video.

    PATCH /videos/{video_id}/credits/{credit_id}

  • Destructive

    Delete the credit for a user in a video

    This method deletes the specified user credit from a video. The authenticated user must be the creator of the credit or the credited user.

    DELETE /videos/{video_id}/credits/{credit_id}

videos / embed-privacy

  • Read

    Get all the domains on a video's allowlist

    This method returns every domain on the specified video's allowlist.

    GET /videos/{video_id}/privacy/domains

  • Write

    Add a domain to a video's allowlist

    This method adds the specified domain to a video's allowlist.

    PUT /videos/{video_id}/privacy/domains/{domain}

  • Destructive

    Remove a domain from a video's allowlist

    This method removes the specified domain from a video's allowlist.

    DELETE /videos/{video_id}/privacy/domains/{domain}

videos / fragments

  • Read

    Get all the fragments for a video

    This method returns all of the fragments associated with the specified video.

    GET /videos/{video_id}/fragments

  • Write

    Update a video's fragments

    This method updates the specified video with new fragments.

    PUT /videos/{video_id}/fragments

  • Destructive

    Delete a video's fragments

    This method deletes all fragments for the specified video.

    DELETE /videos/{video_id}/fragments

videos / languages

  • Read

    Get all languages

    This method returns all available video languages.

    GET /languages

videos / live-m3u8-playback

  • Read

    Get an M3U8 playback URL for a one-time event

    This method returns an M3U8 playback URL for the specified event stream. You should use this endpoint only in conjunction with our recommended procedure for playing events via HLS. For more information, see our [HLS guide](https://developer.vimeo.com/api/live/playback).

    GET /users/{user_id}/videos/{video_id}/m3u8_playback

videos / moderation

  • Read

    Get the reasons that content can be reported

    This method returns the reasons that content of the specified type can be reported for on Vimeo.

    GET /report/reasons

  • Read

    Get the reasons that videos can be reported

    This method returns a list of valid reasons for reporting inappropriate videos on Vimeo.

    GET /report/video_report_reasons

videos / nondestructive-trimming

  • Write

    Start a trim operation for a video

    This method starts a trim operation for the specified video.

    POST /videos/{video_id}/trim

videos / recommendations

videos / showcases

  • Read

    Get all the showcases that contain a video

    This method returns all the showcases that contain the specified video.

    GET /videos/{video_id}/albums

  • Destructive

    Add or remove a video from a list of showcases

    This method adds or removes the specified video to or from multiple showcases.

    PATCH /videos/{video_id}/albums

videos / tags

  • Read

    Get all the videos with a specific tag

    This method returns all the public videos associated with the specified tag.

    GET /tags/{word}/videos

  • Read

    Get all the tags of a video

    This method returns all the tags associated with the specified video. The authenticated user must be the owner of the video.

    GET /videos/{video_id}/tags

  • Read

    Check if a tag has been added to a video

    This method determines whether the specified tag has been added to a video. The authenticated user must be the owner of the video.

    GET /videos/{video_id}/tags/{word}

  • Write

    Add a list of tags to a video

    This method adds multiple tags to the specified video. Include the tags as a JSON array as the body of the request with the **name** field, like this: `[{ "name": "funny"}, {"name": "concert" }]`. The authenticated user must have edit access to the video. For more information on batch requests like this one, see [Using Common Formats and Parameters](https://developer.vimeo.com/api/common-formats#working-with-batch-requests).

    PUT /videos/{video_id}/tags

  • Write

    Add a specific tag to a video

    This method adds a single tag to the specified video. The authenticated user must have edit access to the video.

    PUT /videos/{video_id}/tags/{word}

  • Destructive

    Remove a tag from a video

    This method removes the specified tag from a video. The authenticated user must have edit access to the video.

    DELETE /videos/{video_id}/tags/{word}

videos / text-tracks

  • Read

    Get all the text tracks of a video

    This method returns every text track of the specified video. The authenticated user must be the owner of the video.

    GET /videos/{video_id}/texttracks

  • Read

    Get a specific text track

    This method returns a single text track of the specified video. The authenticated user must be the owner of the video.

    GET /videos/{video_id}/texttracks/{texttrack_id}

  • Write

    Add a text track to a video

    This method adds a text track to the specified video. For more information, see [Working with Text Track Uploads](https://developer.vimeo.com/api/upload/texttracks).

    POST /videos/{video_id}/texttracks

  • Write

    Edit a text track

    This method edits the specified text track of a video. The authenticated user must be the owner of the video.

    PATCH /videos/{video_id}/texttracks/{texttrack_id}

  • Destructive

    Delete a text track

    This method deletes the specified text track from a video. The authenticated user must be the owner of the video.

    DELETE /videos/{video_id}/texttracks/{texttrack_id}

videos / thumbnails

  • Read

    Get all the thumbnails of a video

    This method returns all thumbnail images of the specified video. The authenticated user must have team permissions for the video.

    GET /videos/{video_id}/pictures

  • Read

    Get a specific video thumbnail

    This method returns a single thumbnail image from the specified video. The authenticated user must have team permissions for the video.

    GET /videos/{video_id}/pictures/{picture_id}

  • Write

    Add a video thumbnail

    This method adds a thumbnail image to the specified video. The authenticated user must have team permissions for the video.

    POST /videos/{video_id}/pictures

  • Write

    Edit a video thumbnail

    This method edits the specified video thumbnail image. The authenticated user must be the owner of the thumbnail.

    PATCH /videos/{video_id}/pictures/{picture_id}

  • Destructive

    Delete a video thumbnail

    This method deletes the specified thumbnail image from a video. The authenticated user must have team permissions for the video.

    DELETE /videos/{video_id}/pictures/{picture_id}

videos / transcripts

  • Read

    Get the transcript metadata of a text track

    This method returns the transcript metadata of the specified text track.

    GET /videos/{container_uuid}/transcript/{texttrack_id}/metadata

  • Read

    Get transcript segments

    This method returns the transcript segments of the specified text track.

    GET /videos/{video_id}/transcripts/{texttrack_id}

videos / unlisted-videos

  • Read

    Get the users who can access an unlisted video

    This method returns every user who has access to the specified unlisted video.

    GET /videos/{video_id}/privacy/users

  • Write

    Permit a list of users to access an unlisted video

    This method gives multiple users permission to access the specified unlisted video. The authenticated user must be the owner of the video. The body of the request should follow our [batch request format](https://developer.vimeo.com/api/common-formats#working-with-batch-requests): each object must contain a single **uri** field whose value is the URI of the user who can access the video.

    PUT /videos/{video_id}/privacy/users

  • Write

    Permit a single user to access an unlisted video

    This method gives a single user permission to access the specified unlisted video. The authenticated user must be the owner of the video.

    PUT /videos/{video_id}/privacy/users/{user_id}

  • Destructive

    Restrict a user from viewing an unlisted video

    This method prevents a user from being able to view the specified unlisted video. The authenticated user must be the owner of the video.

    DELETE /videos/{video_id}/privacy/users/{user_id}

videos / uploads

  • Write

    Upload a video

    This method begins the video upload process for the authenticated user. For more information, see our [upload documentation](https://developer.vimeo.com/api/upload/videos).

    POST /users/{user_id}/videos

videos / versions

  • Read

    Get all the versions of a video

    This method returns every version of the specified video. The authenticated user must be the owner of the video.

    GET /videos/{video_id}/versions

  • Read

    Get a specific video version

    This method returns a single version of the specified video. The authenticated user must be the owner of the video.

    GET /videos/{video_id}/versions/{version_id}

  • Read

    Get all audio tracks for a video version

    This method returns all audio tracks that are associated with the specified video version.

    GET /videos/{video_id}/versions/{version_id}/audiotracks

  • Read

    Get an audio track for a video version

    This method returns the specified audio track that is associated with a video version.

    GET /videos/{video_id}/versions/{version_id}/audiotracks/{audiotrack_id}

  • Read

    Get a list of downloadable file links for a video with an alternate audio track

    This method returns a list of downloadable file links for a version of a video that contains the specified alternate audio track.

    GET /videos/{video_id}/versions/{version_id}/downloads

  • Read

    Get the thumbnail for a video version

    This method returns the thumbnail associated with the specified version of a video.

    GET /videos/{video_id}/versions/{version_id}/picture

  • Write

    Add a version to a video

    This method adds a version to the specified video. The authenticated user must be the owner of the video.

    POST /videos/{video_id}/versions

  • Write

    Edit a video version

    This method edits the specified version of a video. The authenticated user must be the owner of the video.

    PATCH /videos/{video_id}/versions/{version_id}

  • Write

    Create an audio track for a video version

    This method creates a new audio track for a video version.

    POST /videos/{video_id}/versions/{version_id}/audiotracks

  • Write

    Edit an audio track for a video version

    This method edits the metadata for the specified audio track.

    PATCH /videos/{video_id}/versions/{version_id}/audiotracks/{audiotrack_id}

  • Destructive

    Delete a video version

    This method deletes the specified version from a video. The authenticated user must be the owner of the video.

    DELETE /videos/{video_id}/versions/{version_id}

  • Destructive

    Delete an audio track from a video version

    This method deletes an audio track from the specified video version.

    DELETE /videos/{video_id}/versions/{version_id}/audiotracks/{audiotrack_id}

videos / video-comments

  • Read

    Get all the video comments on a video

    This method returns every video comment on the specified video.

    GET /videos/{video_id}/comments

  • Read

    Get a specific video comment

    This method returns the specified video comment.

    GET /videos/{video_id}/comments/{comment_id}

  • Read

    Get all the replies to a video comment

    This method returns every reply to the specified video comment.

    GET /videos/{video_id}/comments/{comment_id}/replies

  • Write

    Add a video comment to a video

    This method adds a video comment to the specified video.

    POST /videos/{video_id}/comments

  • Write

    Edit a video comment

    This method edits the specified video comment. The authenticated user must be the owner of the comment.

    PATCH /videos/{video_id}/comments/{comment_id}

  • Write

    Add a reply to a video comment

    This method adds a reply to the specified video comment.

    POST /videos/{video_id}/comments/{comment_id}/replies

  • Destructive

    Delete a video comment

    This method deletes the specified video comment. The authenticated user must be the owner of the comment.

    DELETE /videos/{video_id}/comments/{comment_id}

watch-later-queue / essentials

  • Read

    Get all the videos in the user's Watch Later queue

    This method returns every video from the authenticated user's Watch Later queue.

    GET /users/{user_id}/watchlater

  • Read

    Check if the user has added a video to their Watch Later queue

    This method checks the authenticated user's Watch Later queue for the specified video.

    GET /users/{user_id}/watchlater/{video_id}

  • Write

    Add a video to the user's Watch Later queue

    This method adds the specified video to the authenticated user's Watch Later queue.

    PUT /users/{user_id}/watchlater/{video_id}

  • Destructive

    Remove a video from the user's Watch Later queue

    This method removes the specified video from the authenticated user's Watch Later queue.

    DELETE /users/{user_id}/watchlater/{video_id}

Preserved Type catalog mappings

  • Read

    Get the authenticated Vimeo member

    Get the authenticated Vimeo member.

    GET /me

  • Read

    List team-owner folders (unverified catalog route)

    List folders belonging to a Vimeo team owner when the connected member has permission.

    GET /users/{team_owner_id}/folders

Get started

  1. Open Space settings → Connections and search for Vimeo.
  2. Connect your account and add the connection to the Space.
  3. Ask for what you need in any thread in that Space.

See How connections work for access and permissions, or browse all integrations.