Vimeo provides several different developer tools to cover a wide range of use cases and implementations.
Vimeo API
The Vimeo API is used to interact with and get metadata about your account and your videos. Use the Vimeo API if you want to:
- Upload videos to your account
- Get metadata like a video’s name, description, or direct file links
- Edit a video’s privacy settings
- Delete videos on your account
- Add videos to a folder
- Set a video’s privacy settings
Full documentation for the Vimeo API is found on the Developer Site: https://developer.vimeo.com/api/guides/start
Live API
The Live API is a part of the Vimeo API that is used to interact with and control Vimeo Live events. Use the Live API if you want to:
- Create a live event
- Get an HLS/M3U8 link for a recurring live event
- Set a live event’s title, stream privacy, or embed options
Full documentation for the Live API is found on the Developer Site: https://developer.vimeo.com/api/live.
Access to the Live API is only available to Vimeo Enterprise members.
oEmbed
Vimeo’s oEmbed implementation is used to programmatically get a Vimeo Player to embed code and related metadata with parameters specified by the client. Use oEmbed if you want to:
- Get an embed code with specific height and width dimensions
- Get a thumbnail image link with specific height and width dimensions
- Get basic metadata for a video, such as its name and description
Full documentation of Vimeo’s oEmbed implementation is found on the Developer Site: https://developer.vimeo.com/api/oembed
Player SDK
The Vimeo Player SDK is used to programmatically listen to, interact with, and control an embedded Vimeo video player. Use the Player SDK if you want to:
- Trigger an action on your webpage when the viewer has finished playing a video
- Pause the video player when another action is performed on your webpage
- Enable subtitle or caption text track for a player
Full documentation of the Player SDK is found on the Developer Site: https://developer.vimeo.com/player/sdk