EmbedPresetsEssentialsCreateEmbedPresetRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "New preset",
"description": "The name of the embed preset."
},
"embed": {
"type": "object",
"properties": {
"color": {
"type": "string",
"example": "#1ab7ea",
"description": "The main color of the embeddable player."
},
"logos": {
"type": "object",
"properties": {
"vimeo": {
"type": "boolean",
"example": true,
"description": "Whether to show the Vimeo logo on the embeddable player."
},
"custom": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 462119,
"nullable": true,
"description": "The ID of the custom logo that appears on the embeddable player."
},
"link": {
"type": "string",
"example": "https://example.com",
"nullable": true,
"description": "The URL that loads when the user clicks the custom logo."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether to show the active custom logo on the embeddable player."
},
"sticky": {
"type": "boolean",
"example": true,
"description": "Whether the custom logo is always visible on the embeddable player (`true`) or whether the logo appears and disappears with the rest of the UI (`false`)."
}
}
}
}
},
"title": {
"type": "object",
"properties": {
"name": {
"enum": [
"hide",
"show",
"user"
],
"type": "string",
"description": "How to handle the video title in the title bar of the embeddable player.\n\nOption descriptions:\n * `hide` - Hide the video title.\n * `show` - Show the video title.\n * `user` - Enable the user to decide.\n"
},
"owner": {
"enum": [
"hide",
"show",
"user"
],
"type": "string",
"description": "How to handle the owner information in the title bar of the embeddable player.\n\nOption descriptions:\n * `hide` - Hide the owner info.\n * `show` - Show the owner info.\n * `user` - Enable the user to decide.\n"
},
"portrait": {
"enum": [
"hide",
"show",
"user"
],
"type": "string",
"description": "How to handle the owner portrait in the title bar of the embeddable player.\n\nOption descriptions:\n * `hide` - Hide the portrait.\n * `show` - Show the portrait.\n * `user` - Enable the user to decide.\n"
}
}
},
"colors": {
"type": "object",
"properties": {
"color_one": {
"type": "string",
"example": "#112233",
"description": "The hexadecimal color code of the first player color, which controls the color of the progress bar, buttons, and more."
},
"color_two": {
"type": "string",
"example": "#445566",
"description": "The hexadecimal color code of the second player color, which controls the player accent color."
},
"color_four": {
"type": "string",
"example": "#aabbcc",
"description": "The hexadecimal color code of the fourth player color, which controls the player background color."
},
"color_three": {
"type": "string",
"example": "#778899",
"description": "The hexadecimal color code of the third player color, which controls the color of text and icons."
}
}
},
"volume": {
"type": "boolean",
"example": true,
"description": "Whether to show the volume selector on the embeddable player."
},
"airplay": {
"type": "boolean",
"example": true,
"description": "Whether AirPlay is enabled in the embeddable player."
},
"buttons": {
"type": "object",
"properties": {
"hd": {
"type": "boolean",
"example": true,
"description": "Whether to show the `HD` button on the embeddable player."
},
"like": {
"type": "boolean",
"example": true,
"description": "Whether to show the `like` button on the embeddable player."
},
"embed": {
"type": "boolean",
"example": true,
"description": "Whether to show the `embed` button on the embeddable player."
},
"share": {
"type": "boolean",
"example": true,
"description": "Whether to show the `share` button on the embeddable player."
},
"scaling": {
"type": "boolean",
"example": true,
"description": "Whether to show the `scaling` button on the embeddable player in fullscreen mode."
},
"fullscreen": {
"type": "boolean",
"example": true,
"description": "Whether to show the `fullscreen` button on the embeddable player."
},
"watchlater": {
"type": "boolean",
"example": true,
"description": "Whether to show the `watch later` button on the embeddable player."
}
}
},
"playbar": {
"type": "boolean",
"example": true,
"description": "Whether to show the playbar on the embeddable player."
},
"chapters": {
"type": "boolean",
"example": true,
"description": "Whether chapters are enabled in the embeddable player."
},
"chromecast": {
"type": "boolean",
"example": true,
"description": "Whether the Chromecast button appears in the embeddable player."
},
"transcript": {
"type": "boolean",
"example": true,
"description": "Whether the transcript controls appear in the embeddable player."
},
"play_button": {
"type": "object",
"properties": {
"position": {
"enum": [
"auto",
"bottom",
"center"
],
"type": "string",
"description": "The position of the play button within the embeddable player.\n\nOption descriptions:\n * `auto` - Use Vimeo's default positioning for the play button.\n * `bottom` - The play button is positioned at the bottom of the player, except when in tiny mode.\n * `center` - The play button is positioned in the center of the player.\n"
}
},
"description": "An object representing the play button's settings."
},
"audio_tracks": {
"type": "boolean",
"example": true,
"description": "Whether multiple audio tracks can appear in the embeddable player."
},
"closed_captions": {
"type": "boolean",
"example": true,
"description": "Whether closed captions are enabled in the embeddable player."
},
"quality_selector": {
"type": "boolean",
"example": true,
"description": "Whether to show the quality selector in the embeddable player."
}
}
}
}
}
EmbedPresetsEssentialsCreatePresetRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "New preset",
"description": "The name of the embed preset."
},
"embed": {
"type": "object",
"properties": {
"color": {
"type": "string",
"example": "#1ab7ea",
"description": "The main color of the embeddable player."
},
"logos": {
"type": "object",
"properties": {
"vimeo": {
"type": "boolean",
"example": true,
"description": "Whether to show the Vimeo logo on the embeddable player."
},
"custom": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 462119,
"nullable": true,
"description": "The ID of the custom logo that appears on the embeddable player."
},
"link": {
"type": "string",
"example": "https://example.com",
"nullable": true,
"description": "The URL that loads when the user clicks the custom logo."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether to show the active custom logo on the embeddable player."
},
"sticky": {
"type": "boolean",
"example": true,
"description": "Whether the custom logo is always visible on the embeddable player (`true`) or whether the logo appears and disappears with the rest of the UI (`false`)."
}
}
}
}
},
"title": {
"type": "object",
"properties": {
"name": {
"enum": [
"hide",
"show",
"user"
],
"type": "string",
"description": "How to handle the video title in the title bar of the embeddable player.\n\nOption descriptions:\n * `hide` - Hide the video title.\n * `show` - Show the video title.\n * `user` - Enable the user to decide.\n"
},
"owner": {
"enum": [
"hide",
"show",
"user"
],
"type": "string",
"description": "How to handle the owner information in the title bar of the embeddable player.\n\nOption descriptions:\n * `hide` - Hide the owner info.\n * `show` - Show the owner info.\n * `user` - Enable the user to decide.\n"
},
"portrait": {
"enum": [
"hide",
"show",
"user"
],
"type": "string",
"description": "How to handle the owner portrait in the title bar of the embeddable player.\n\nOption descriptions:\n * `hide` - Hide the portrait.\n * `show` - Show the portrait.\n * `user` - Enable the user to decide.\n"
}
}
},
"colors": {
"type": "object",
"properties": {
"color_one": {
"type": "string",
"example": "#112233",
"description": "The hexadecimal color code of the first player color, which controls the color of the progress bar, buttons, and more."
},
"color_two": {
"type": "string",
"example": "#445566",
"description": "The hexadecimal color code of the second player color, which controls the player accent color."
},
"color_four": {
"type": "string",
"example": "#aabbcc",
"description": "The hexadecimal color code of the fourth player color, which controls the player background color."
},
"color_three": {
"type": "string",
"example": "#778899",
"description": "The hexadecimal color code of the third player color, which controls the color of text and icons."
}
}
},
"volume": {
"type": "boolean",
"example": true,
"description": "Whether to show the volume selector on the embeddable player."
},
"airplay": {
"type": "boolean",
"example": true,
"description": "Whether AirPlay is enabled in the embeddable player."
},
"buttons": {
"type": "object",
"properties": {
"hd": {
"type": "boolean",
"example": true,
"description": "Whether to show the `HD` button on the embeddable player."
},
"like": {
"type": "boolean",
"example": true,
"description": "Whether to show the `like` button on the embeddable player."
},
"embed": {
"type": "boolean",
"example": true,
"description": "Whether to show the `embed` button on the embeddable player."
},
"share": {
"type": "boolean",
"example": true,
"description": "Whether to show the `share` button on the embeddable player."
},
"scaling": {
"type": "boolean",
"example": true,
"description": "Whether to show the `scaling` button on the embeddable player in fullscreen mode."
},
"fullscreen": {
"type": "boolean",
"example": true,
"description": "Whether to show the `fullscreen` button on the embeddable player."
},
"watchlater": {
"type": "boolean",
"example": true,
"description": "Whether to show the `watch later` button on the embeddable player."
}
}
},
"playbar": {
"type": "boolean",
"example": true,
"description": "Whether to show the playbar on the embeddable player."
},
"chapters": {
"type": "boolean",
"example": true,
"description": "Whether chapters are enabled in the embeddable player."
},
"chromecast": {
"type": "boolean",
"example": true,
"description": "Whether the Chromecast button appears in the embeddable player."
},
"transcript": {
"type": "boolean",
"example": true,
"description": "Whether the transcript controls appear in the embeddable player."
},
"play_button": {
"type": "object",
"properties": {
"position": {
"enum": [
"auto",
"bottom",
"center"
],
"type": "string",
"description": "The position of the play button within the embeddable player.\n\nOption descriptions:\n * `auto` - Use Vimeo's default positioning for the play button.\n * `bottom` - The play button is positioned at the bottom of the player, except when in tiny mode.\n * `center` - The play button is positioned in the center of the player.\n"
}
},
"description": "An object representing the play button's settings."
},
"audio_tracks": {
"type": "boolean",
"example": true,
"description": "Whether multiple audio tracks can appear in the embeddable player."
},
"closed_captions": {
"type": "boolean",
"example": true,
"description": "Whether closed captions are enabled in the embeddable player."
},
"quality_selector": {
"type": "boolean",
"example": true,
"description": "Whether to show the quality selector in the embeddable player."
}
}
}
}
}
EmbedPresetsEssentialsEditPresetRequest
{
"type": "object",
"properties": {
"outro": {
"enum": [
"nothing"
],
"type": "string",
"description": "What to do with the outro.\n\nOption descriptions:\n * `nothing` - Disable the outro.\n"
}
}
}
EmbedPresetsEssentialsEditPresetRequest1
{
"type": "object",
"properties": {
"outro": {
"enum": [
"nothing"
],
"type": "string",
"description": "What to do with the outro.\n\nOption descriptions:\n * `nothing` - Disable the outro.\n"
}
}
}
EmbedPresetsEssentialsGetAllUserCreatedEmbedPresetsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/preset"
}
}
EmbedPresetsEssentialsGetUserEmbedPresetsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/preset"
}
}
EmbedPresetsVideosGetPresetVideosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
EmbedPresetsVideosGetSpecificPresetVideosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
FoldersEssentialsCreateFolderRequest
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Rough cuts",
"description": "The name of the folder."
},
"parent_folder_uri": {
"type": "string",
"example": "/users/12345/projects/6789",
"description": "The URI of the parent folder."
}
}
}
FoldersEssentialsEditFolderRequest
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Rough cuts",
"description": "The name of the folder."
}
}
}
FoldersEssentialsGetAllUserFoldersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/project"
}
}
FoldersVideosGetAllFolderVideosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
FoldersVideosGetVideosInFolderResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
FollowUsersRequest
{
"type": "object",
"required": [
"users"
],
"properties": {
"users": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of user IDs for the authenticated user to follow."
}
}
}
GetAppearancesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
GetCategoriesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/category"
}
}
GetChannelsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/channel"
}
}
GetChaptersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/chapter"
}
}
GetCommentsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/comment"
}
}
GetFeedResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/activity-3-1"
}
}
GetFollowersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/user"
}
}
GetGroupsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/group"
}
}
GetLanguagesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/language"
}
}
GetLikesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
GetPicturesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/picture"
}
}
GetPortfoliosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/portfolio"
}
}
GetProjectsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/project"
}
}
GetRegionsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/on-demand-region"
}
}
GetShowcasesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/album"
}
}
GetTranscriptResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/segment"
}
}
GetVideosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
GroupsUsersGetGroupUsersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/user"
}
}
GroupsUsersGetUserGroupsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/group"
}
}
GroupsUsersGetUserGroupsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/group"
}
}
GroupsVideosGetAllGroupVideosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
LikesEssentialsGetAllUserLikesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/user"
}
}
LikesEssentialsGetUserLikedVideosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
LikesEssentialsGetUserLikesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/user"
}
}
LikesEssentialsGetUsersWhoLikedVideoResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/user"
}
}
LiveEmbedPrivacyEmbedEventOnDomainsRequest
{
"type": "object",
"properties": {
"allowed_domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the domains on which the embedded event can appear."
}
}
}
LiveEmbedPrivacyEmbedEventOnDomainsRequest1
{
"type": "object",
"properties": {
"allowed_domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the domains on which the embedded event can appear."
}
}
}
LiveEmbedPrivacyEmbedEventOnDomainsRequest2
{
"type": "object",
"properties": {
"allowed_domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the domains on which the embedded event can appear."
}
}
}
LiveEmbedPrivacyGetWhitelistDomains200Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/domain"
}
}
LiveEmbedPrivacyGetWhitelistDomainsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/domain"
}
}
LiveEssentialsCreateEventForUserRequest
{
"type": "object",
"required": [
"title"
],
"properties": {
"dvr": {
"type": "boolean",
"example": true,
"description": "Whether the DVR feature is enabled."
},
"embed": {
"type": "object",
"properties": {
"loop": {
"type": "boolean",
"example": true,
"description": "Whether the playlist should start from the beginning again after reaching the end of the last video."
},
"color": {
"type": "string",
"example": "#00adef",
"description": "The hexadecimal color code for the main color of the embed player."
},
"logos": {
"type": "object",
"properties": {
"vimeo": {
"type": "boolean",
"example": true,
"description": "Whether to show the Vimeo logo on the embed player."
},
"custom": {
"type": "object",
"properties": {
"link": {
"type": "string",
"example": "https://example.com",
"description": "The URL that loads when the user clicks the custom logo."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether to show the custom logo on the embed player."
},
"sticky": {
"type": "boolean",
"example": true,
"description": "Whether to show the custom logo persistently (`true`) or hide it with the rest of the UI (`false`)."
}
}
}
}
},
"autoplay": {
"type": "boolean",
"example": true,
"description": "Whether playback starts automatically on load."
},
"playlist": {
"type": "boolean",
"example": true,
"description": "Whether to show the playlist controls on the embed player."
},
"schedule": {
"type": "boolean",
"example": true,
"description": "Whether to show the event schedule on the embed player."
},
"use_color": {
"type": "boolean",
"example": true,
"description": "Whether the embed player should use (`true`) or ignore (`false`) the **embed.color** value."
},
"show_latest_archived_clip": {
"type": "boolean",
"example": true,
"description": "Whether to show the latest archived video in the embed player when off-air."
}
},
"description": "The embed settings of the event and the videos generated by streaming to this event."
},
"title": {
"type": "string",
"example": "Live Content",
"description": "The title of the event. If **automatically_title_stream** is `true`, this value is the base title for videos created by streaming to this event."
},
"schedule": {
"type": "object",
"properties": {
"type": {
"enum": [
"single",
"weekly"
],
"type": "string",
"example": "weekly",
"description": "How often the event is expected to be live.\n\nOption descriptions:\n * `single` - The event is live one time only.\n * `weekly` - The event is live on a weekly basis.\n"
},
"weekdays": {
"type": "array",
"items": {
"type": "string"
},
"description": "A non-empty array of weekdays on which the event is expected to be live. Weekdays can range from 1 to 7, where 1 is Monday and 7 is Sunday. This parameter is required when **schedule.type** is `weekly`."
},
"daily_time": {
"type": "string",
"example": "14:00:00Z",
"description": "The time in ISO 8601 format when the event is expected to be live, with the zero UTC offset `Z`. This parameter is required when **schedule.type** is `weekly`."
}
},
"description": "Information about the time or times that the event is expected to be live."
},
"time_zone": {
"type": "string",
"example": "America/New_York",
"description": "The time zone used in resolving the timestamps that are included in automatically generated video titles."
},
"folder_uri": {
"type": "string",
"example": "/users/67890/projects/12345",
"description": "The URI of the event's folder."
},
"low_latency": {
"type": "boolean",
"description": "Whether the event has low-latency streaming enabled."
},
"auto_cc_lang": {
"enum": [
"de-DE",
"en-US",
"es-ES",
"fr-FR",
"pt-BR"
],
"type": "string",
"example": "en-US",
"description": "The language in which the automated closed captions appear.\n\nOption descriptions:\n * `de-DE` - The language is German.\n * `en-US` - The language is English.\n * `es-ES` - The language is Spanish.\n * `fr-FR` - The language is French.\n * `pt-BR` - The language is Portuguese.\n"
},
"chat_enabled": {
"type": "boolean",
"example": true,
"description": "Whether to display the live chat client on the Vimeo event page."
},
"rtmp_preview": {
"type": "boolean",
"description": "Whether the event has RTMP preview enabled."
},
"stream_embed": {
"type": "object",
"properties": {
"embed": {
"enum": [
"private",
"public",
"whitelist"
],
"type": "string",
"example": "public",
"description": "The embed permission level for the event.\n\nOption descriptions:\n * `private` - Only the user can embed the event.\n * `public` - Anyone can embed the event.\n * `whitelist` - Only those on the whitelist can embed the event.\n"
}
}
},
"stream_title": {
"type": "string",
"example": "Special Feature",
"description": "The title of the next video to be streamed to the event. This parameter is required when **automatically_title_stream** is `false`."
},
"playlist_sort": {
"enum": [
"added_first",
"added_last",
"alphabetical",
"arranged",
"comments",
"duration",
"likes",
"newest",
"oldest",
"plays"
],
"type": "string",
"example": "added_first",
"description": "The order in which the videos of the event appear within the event's playlist.\n\nOption descriptions:\n * `added_first` - The most recently added videos appear first.\n * `added_last` - The most recently added videos appear last.\n * `alphabetical` - The videos appear in alphabetical order.\n * `arranged` - The videos appear in the order in which the user has arranged them.\n * `comments` - The videos appear in order of number of comments.\n * `duration` - The videos appear in order of duration.\n * `likes` - The videos appear in order of number of likes.\n * `newest` - The newest videos appear first.\n * `oldest` - The oldest videos appear first.\n * `plays` - The videos appear in order of number of plays.\n"
},
"content_rating": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values describing the content in this event. To return the list of all possible content rating values, use the [`/contentratings`](https://developer.vimeo.com/api/reference/videos#get_content_ratings) endpoint."
},
"stream_privacy": {
"type": "object",
"properties": {
"view": {
"enum": [
"anybody",
"embed_only",
"nobody",
"password",
"unlisted"
],
"type": "string",
"example": "anybody",
"description": "The initial privacy of the videos generated by streaming to the event as well as the embed privacy of the entire collection.\n\nOption descriptions:\n * `anybody` - Anyone can access the event. This privacy setting appears as `Public` on the Vimeo front end.\n * `embed_only` - The event doesn't appear on Vimeo, but it can be embedded on other sites.\n * `nobody` - No one except the owner can access the event. This privacy setting appears as `Private` on the Vimeo front end.\n * `password` - Only those with the password can access the event.\n * `unlisted` - Only those with the private link can access the event.\n"
}
},
"description": "The privacy settings of the event."
},
"auto_cc_enabled": {
"type": "boolean",
"example": true,
"description": "Whether automated closed captions are enabled for the event."
},
"stream_password": {
"type": "string",
"example": "hunter1",
"description": "The password when **stream_privacy.view** is `password`. Anyone with the password can view the videos generated by streaming to the event."
},
"allow_share_link": {
"type": "boolean",
"description": "Whether the share link is usable."
},
"auto_cc_keywords": {
"type": "string",
"example": "commonly-used words,phrases,technical terms",
"description": "A comma-separated list of keywords that improve the quality of the automated closed captions."
},
"scheduled_playback": {
"type": "boolean",
"example": false,
"description": "Whether the scheduled playback feature is enabled."
},
"stream_description": {
"type": "string",
"example": "In this episode, we interview a surprise guest",
"description": "The description of the next video to be streamed to the event."
},
"automatically_title_stream": {
"type": "boolean",
"example": true,
"description": "Whether the title for the next video in the event is generated based on the time of the stream and the **title** field of the event."
},
"interaction_tools_settings": {
"type": "object",
"properties": {
"is_qna_moderated": {
"type": "boolean",
"example": true,
"description": "Whether the Q&A is moderated for the interaction tools settings."
},
"is_anonymous_questions_disabled": {
"type": "boolean",
"example": true,
"description": "Whether anonymous questions are disabled for the interaction tools settings."
}
},
"description": "The settings for the interaction tools."
}
}
}
LiveEssentialsCreateEventRequest
{
"type": "object",
"required": [
"title"
],
"properties": {
"dvr": {
"type": "boolean",
"example": true,
"description": "Whether the DVR feature is enabled."
},
"embed": {
"type": "object",
"properties": {
"loop": {
"type": "boolean",
"example": true,
"description": "Whether the playlist should start from the beginning again after reaching the end of the last video."
},
"color": {
"type": "string",
"example": "#00adef",
"description": "The hexadecimal color code for the main color of the embed player."
},
"logos": {
"type": "object",
"properties": {
"vimeo": {
"type": "boolean",
"example": true,
"description": "Whether to show the Vimeo logo on the embed player."
},
"custom": {
"type": "object",
"properties": {
"link": {
"type": "string",
"example": "https://example.com",
"description": "The URL that loads when the user clicks the custom logo."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether to show the custom logo on the embed player."
},
"sticky": {
"type": "boolean",
"example": true,
"description": "Whether to show the custom logo persistently (`true`) or hide it with the rest of the UI (`false`)."
}
}
}
}
},
"autoplay": {
"type": "boolean",
"example": true,
"description": "Whether playback starts automatically on load."
},
"playlist": {
"type": "boolean",
"example": true,
"description": "Whether to show the playlist controls on the embed player."
},
"schedule": {
"type": "boolean",
"example": true,
"description": "Whether to show the event schedule on the embed player."
},
"use_color": {
"type": "boolean",
"example": true,
"description": "Whether the embed player should use (`true`) or ignore (`false`) the **embed.color** value."
},
"show_latest_archived_clip": {
"type": "boolean",
"example": true,
"description": "Whether to show the latest archived video in the embed player when off-air."
}
},
"description": "The embed settings of the event and the videos generated by streaming to this event."
},
"title": {
"type": "string",
"example": "Live Content",
"description": "The title of the event. If **automatically_title_stream** is `true`, this value is the base title for videos created by streaming to this event."
},
"schedule": {
"type": "object",
"properties": {
"type": {
"enum": [
"single",
"weekly"
],
"type": "string",
"example": "weekly",
"description": "How often the event is expected to be live.\n\nOption descriptions:\n * `single` - The event is live one time only.\n * `weekly` - The event is live on a weekly basis.\n"
},
"weekdays": {
"type": "array",
"items": {
"type": "string"
},
"description": "A non-empty array of weekdays on which the event is expected to be live. Weekdays can range from 1 to 7, where 1 is Monday and 7 is Sunday. This parameter is required when **schedule.type** is `weekly`."
},
"daily_time": {
"type": "string",
"example": "14:00:00Z",
"description": "The time in ISO 8601 format when the event is expected to be live, with the zero UTC offset `Z`. This parameter is required when **schedule.type** is `weekly`."
}
},
"description": "Information about the time or times that the event is expected to be live."
},
"time_zone": {
"type": "string",
"example": "America/New_York",
"description": "The time zone used in resolving the timestamps that are included in automatically generated video titles."
},
"folder_uri": {
"type": "string",
"example": "/users/67890/projects/12345",
"description": "The URI of the event's folder."
},
"low_latency": {
"type": "boolean",
"description": "Whether the event has low-latency streaming enabled."
},
"auto_cc_lang": {
"enum": [
"de-DE",
"en-US",
"es-ES",
"fr-FR",
"pt-BR"
],
"type": "string",
"example": "en-US",
"description": "The language in which the automated closed captions appear.\n\nOption descriptions:\n * `de-DE` - The language is German.\n * `en-US` - The language is English.\n * `es-ES` - The language is Spanish.\n * `fr-FR` - The language is French.\n * `pt-BR` - The language is Portuguese.\n"
},
"chat_enabled": {
"type": "boolean",
"example": true,
"description": "Whether to display the live chat client on the Vimeo event page."
},
"rtmp_preview": {
"type": "boolean",
"description": "Whether the event has RTMP preview enabled."
},
"stream_embed": {
"type": "object",
"properties": {
"embed": {
"enum": [
"private",
"public",
"whitelist"
],
"type": "string",
"example": "public",
"description": "The embed permission level for the event.\n\nOption descriptions:\n * `private` - Only the user can embed the event.\n * `public` - Anyone can embed the event.\n * `whitelist` - Only those on the whitelist can embed the event.\n"
}
}
},
"stream_title": {
"type": "string",
"example": "Special Feature",
"description": "The title of the next video to be streamed to the event. This parameter is required when **automatically_title_stream** is `false`."
},
"playlist_sort": {
"enum": [
"added_first",
"added_last",
"alphabetical",
"arranged",
"comments",
"duration",
"likes",
"newest",
"oldest",
"plays"
],
"type": "string",
"example": "added_first",
"description": "The order in which the videos of the event appear within the event's playlist.\n\nOption descriptions:\n * `added_first` - The most recently added videos appear first.\n * `added_last` - The most recently added videos appear last.\n * `alphabetical` - The videos appear in alphabetical order.\n * `arranged` - The videos appear in the order in which the user has arranged them.\n * `comments` - The videos appear in order of number of comments.\n * `duration` - The videos appear in order of duration.\n * `likes` - The videos appear in order of number of likes.\n * `newest` - The newest videos appear first.\n * `oldest` - The oldest videos appear first.\n * `plays` - The videos appear in order of number of plays.\n"
},
"content_rating": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values describing the content in this event. To return the list of all possible content rating values, use the [`/contentratings`](https://developer.vimeo.com/api/reference/videos#get_content_ratings) endpoint."
},
"stream_privacy": {
"type": "object",
"properties": {
"view": {
"enum": [
"anybody",
"embed_only",
"nobody",
"password",
"unlisted"
],
"type": "string",
"example": "anybody",
"description": "The initial privacy of the videos generated by streaming to the event as well as the embed privacy of the entire collection.\n\nOption descriptions:\n * `anybody` - Anyone can access the event. This privacy setting appears as `Public` on the Vimeo front end.\n * `embed_only` - The event doesn't appear on Vimeo, but it can be embedded on other sites.\n * `nobody` - No one except the owner can access the event. This privacy setting appears as `Private` on the Vimeo front end.\n * `password` - Only those with the password can access the event.\n * `unlisted` - Only those with the private link can access the event.\n"
}
},
"description": "The privacy settings of the event."
},
"auto_cc_enabled": {
"type": "boolean",
"example": true,
"description": "Whether automated closed captions are enabled for the event."
},
"stream_password": {
"type": "string",
"example": "hunter1",
"description": "The password when **stream_privacy.view** is `password`. Anyone with the password can view the videos generated by streaming to the event."
},
"allow_share_link": {
"type": "boolean",
"description": "Whether the share link is usable."
},
"auto_cc_keywords": {
"type": "string",
"example": "commonly-used words,phrases,technical terms",
"description": "A comma-separated list of keywords that improve the quality of the automated closed captions."
},
"scheduled_playback": {
"type": "boolean",
"example": false,
"description": "Whether the scheduled playback feature is enabled."
},
"stream_description": {
"type": "string",
"example": "In this episode, we interview a surprise guest",
"description": "The description of the next video to be streamed to the event."
},
"automatically_title_stream": {
"type": "boolean",
"example": true,
"description": "Whether the title for the next video in the event is generated based on the time of the stream and the **title** field of the event."
},
"interaction_tools_settings": {
"type": "object",
"properties": {
"is_qna_moderated": {
"type": "boolean",
"example": true,
"description": "Whether the Q&A is moderated for the interaction tools settings."
},
"is_anonymous_questions_disabled": {
"type": "boolean",
"example": true,
"description": "Whether anonymous questions are disabled for the interaction tools settings."
}
},
"description": "The settings for the interaction tools."
}
}
}
LiveEssentialsCreateLiveEventRequest
{
"type": "object",
"required": [
"title"
],
"properties": {
"dvr": {
"type": "boolean",
"example": true,
"description": "Whether the DVR feature is enabled."
},
"embed": {
"type": "object",
"properties": {
"loop": {
"type": "boolean",
"example": true,
"description": "Whether the playlist should start from the beginning again after reaching the end of the last video."
},
"color": {
"type": "string",
"example": "#00adef",
"description": "The hexadecimal color code for the main color of the embed player."
},
"logos": {
"type": "object",
"properties": {
"vimeo": {
"type": "boolean",
"example": true,
"description": "Whether to show the Vimeo logo on the embed player."
},
"custom": {
"type": "object",
"properties": {
"link": {
"type": "string",
"example": "https://example.com",
"description": "The URL that loads when the user clicks the custom logo."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether to show the custom logo on the embed player."
},
"sticky": {
"type": "boolean",
"example": true,
"description": "Whether to show the custom logo persistently (`true`) or hide it with the rest of the UI (`false`)."
}
}
}
}
},
"autoplay": {
"type": "boolean",
"example": true,
"description": "Whether playback starts automatically on load."
},
"playlist": {
"type": "boolean",
"example": true,
"description": "Whether to show the playlist controls on the embed player."
},
"schedule": {
"type": "boolean",
"example": true,
"description": "Whether to show the event schedule on the embed player."
},
"use_color": {
"type": "boolean",
"example": true,
"description": "Whether the embed player should use (`true`) or ignore (`false`) the **embed.color** value."
},
"show_latest_archived_clip": {
"type": "boolean",
"example": true,
"description": "Whether to show the latest archived video in the embed player when off-air."
}
},
"description": "The embed settings of the event and the videos generated by streaming to this event."
},
"title": {
"type": "string",
"example": "Live Content",
"description": "The title of the event. If **automatically_title_stream** is `true`, this value is the base title for videos created by streaming to this event."
},
"schedule": {
"type": "object",
"properties": {
"type": {
"enum": [
"single",
"weekly"
],
"type": "string",
"example": "weekly",
"description": "How often the event is expected to be live.\n\nOption descriptions:\n * `single` - The event is live one time only.\n * `weekly` - The event is live on a weekly basis.\n"
},
"weekdays": {
"type": "array",
"items": {
"type": "string"
},
"description": "A non-empty array of weekdays on which the event is expected to be live. Weekdays can range from 1 to 7, where 1 is Monday and 7 is Sunday. This parameter is required when **schedule.type** is `weekly`."
},
"daily_time": {
"type": "string",
"example": "14:00:00Z",
"description": "The time in ISO 8601 format when the event is expected to be live, with the zero UTC offset `Z`. This parameter is required when **schedule.type** is `weekly`."
}
},
"description": "Information about the time or times that the event is expected to be live."
},
"time_zone": {
"type": "string",
"example": "America/New_York",
"description": "The time zone used in resolving the timestamps that are included in automatically generated video titles."
},
"folder_uri": {
"type": "string",
"example": "/users/67890/projects/12345",
"description": "The URI of the event's folder."
},
"low_latency": {
"type": "boolean",
"description": "Whether the event has low-latency streaming enabled."
},
"auto_cc_lang": {
"enum": [
"de-DE",
"en-US",
"es-ES",
"fr-FR",
"pt-BR"
],
"type": "string",
"example": "en-US",
"description": "The language in which the automated closed captions appear.\n\nOption descriptions:\n * `de-DE` - The language is German.\n * `en-US` - The language is English.\n * `es-ES` - The language is Spanish.\n * `fr-FR` - The language is French.\n * `pt-BR` - The language is Portuguese.\n"
},
"chat_enabled": {
"type": "boolean",
"example": true,
"description": "Whether to display the live chat client on the Vimeo event page."
},
"rtmp_preview": {
"type": "boolean",
"description": "Whether the event has RTMP preview enabled."
},
"stream_embed": {
"type": "object",
"properties": {
"embed": {
"enum": [
"private",
"public",
"whitelist"
],
"type": "string",
"example": "public",
"description": "The embed permission level for the event.\n\nOption descriptions:\n * `private` - Only the user can embed the event.\n * `public` - Anyone can embed the event.\n * `whitelist` - Only those on the whitelist can embed the event.\n"
}
}
},
"stream_title": {
"type": "string",
"example": "Special Feature",
"description": "The title of the next video to be streamed to the event. This parameter is required when **automatically_title_stream** is `false`."
},
"playlist_sort": {
"enum": [
"added_first",
"added_last",
"alphabetical",
"arranged",
"comments",
"duration",
"likes",
"newest",
"oldest",
"plays"
],
"type": "string",
"example": "added_first",
"description": "The order in which the videos of the event appear within the event's playlist.\n\nOption descriptions:\n * `added_first` - The most recently added videos appear first.\n * `added_last` - The most recently added videos appear last.\n * `alphabetical` - The videos appear in alphabetical order.\n * `arranged` - The videos appear in the order in which the user has arranged them.\n * `comments` - The videos appear in order of number of comments.\n * `duration` - The videos appear in order of duration.\n * `likes` - The videos appear in order of number of likes.\n * `newest` - The newest videos appear first.\n * `oldest` - The oldest videos appear first.\n * `plays` - The videos appear in order of number of plays.\n"
},
"content_rating": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values describing the content in this event. To return the list of all possible content rating values, use the [`/contentratings`](https://developer.vimeo.com/api/reference/videos#get_content_ratings) endpoint."
},
"stream_privacy": {
"type": "object",
"properties": {
"view": {
"enum": [
"anybody",
"embed_only",
"nobody",
"password",
"unlisted"
],
"type": "string",
"example": "anybody",
"description": "The initial privacy of the videos generated by streaming to the event as well as the embed privacy of the entire collection.\n\nOption descriptions:\n * `anybody` - Anyone can access the event. This privacy setting appears as `Public` on the Vimeo front end.\n * `embed_only` - The event doesn't appear on Vimeo, but it can be embedded on other sites.\n * `nobody` - No one except the owner can access the event. This privacy setting appears as `Private` on the Vimeo front end.\n * `password` - Only those with the password can access the event.\n * `unlisted` - Only those with the private link can access the event.\n"
}
},
"description": "The privacy settings of the event."
},
"auto_cc_enabled": {
"type": "boolean",
"example": true,
"description": "Whether automated closed captions are enabled for the event."
},
"stream_password": {
"type": "string",
"example": "hunter1",
"description": "The password when **stream_privacy.view** is `password`. Anyone with the password can view the videos generated by streaming to the event."
},
"allow_share_link": {
"type": "boolean",
"description": "Whether the share link is usable."
},
"auto_cc_keywords": {
"type": "string",
"example": "commonly-used words,phrases,technical terms",
"description": "A comma-separated list of keywords that improve the quality of the automated closed captions."
},
"scheduled_playback": {
"type": "boolean",
"example": false,
"description": "Whether the scheduled playback feature is enabled."
},
"stream_description": {
"type": "string",
"example": "In this episode, we interview a surprise guest",
"description": "The description of the next video to be streamed to the event."
},
"automatically_title_stream": {
"type": "boolean",
"example": true,
"description": "Whether the title for the next video in the event is generated based on the time of the stream and the **title** field of the event."
},
"interaction_tools_settings": {
"type": "object",
"properties": {
"is_qna_moderated": {
"type": "boolean",
"example": true,
"description": "Whether the Q&A is moderated for the interaction tools settings."
},
"is_anonymous_questions_disabled": {
"type": "boolean",
"example": true,
"description": "Whether anonymous questions are disabled for the interaction tools settings."
}
},
"description": "The settings for the interaction tools."
}
}
}
LiveEssentialsDeleteMultipleEventsRequest
{
"type": "object",
"required": [
"password"
],
"properties": {
"password": {
"type": "string",
"example": "hunter1",
"description": "The user’s password."
}
}
}
LiveEssentialsDeleteMultipleEventsRequest1
{
"type": "object",
"required": [
"password"
],
"properties": {
"password": {
"type": "string",
"example": "hunter1",
"description": "The user’s password."
}
}
}
LiveEssentialsDeleteMultipleEventsRequest2
{
"type": "object",
"required": [
"password"
],
"properties": {
"password": {
"type": "string",
"example": "hunter1",
"description": "The user’s password."
}
}
}