WebinarRegistrationsCaptureUserRegistrationListRequest
{
"type": "object",
"properties": {
"registrants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "The registrant's other submitted fields."
},
"email": {
"type": "string",
"example": "jane.doe@vimeo.com",
"description": "The registrant's email address."
},
"last_name": {
"type": "string",
"example": "Doe",
"description": "The registrant's last name."
},
"first_name": {
"type": "string",
"example": "Jane",
"description": "The registrant's first name."
}
}
},
"description": "An array of registration data for the webinar."
}
}
}
WebinarRegistrationsCaptureUserRegistrationListRequest1
{
"type": "object",
"properties": {
"registrants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "The registrant's other submitted fields."
},
"email": {
"type": "string",
"example": "jane.doe@vimeo.com",
"description": "The registrant's email address."
},
"last_name": {
"type": "string",
"example": "Doe",
"description": "The registrant's last name."
},
"first_name": {
"type": "string",
"example": "Jane",
"description": "The registrant's first name."
}
}
},
"description": "An array of registration data for the webinar."
}
}
}
WebinarRegistrationsUpdateUserRegistrationDataRequest
{
"type": "object",
"properties": {
"is_blocked": {
"type": "boolean",
"example": true,
"description": "Whether to block the webinar registrant."
}
}
}
WebinarRegistrationsUpdateUserRegistrationDataRequest1
{
"type": "object",
"properties": {
"is_blocked": {
"type": "boolean",
"example": true,
"description": "Whether to block the webinar registrant."
}
}
}
activity-3-1
{
"type": "object",
"title": "Activity 3.1",
"required": [
"clip",
"metadata",
"time",
"type"
],
"properties": {
"tag": {
"$ref": "#/components/schemas/tag"
},
"clip": {
"$ref": "#/components/schemas/video"
},
"time": {
"type": "string",
"example": "2017-05-17T17:46:09+00:00",
"description": "The time that the event occurred."
},
"type": {
"enum": [
"appearance",
"category",
"channel",
"facebook_feed",
"group",
"like",
"ondemand",
"share",
"tag",
"twitter_timeline",
"upload"
],
"type": "string",
"example": "appearance",
"description": "The activity type.\n\nOption descriptions:\n * `appearance` - The activity is an appearance action.\n * `category` - The activity is a category action.\n * `channel` - The activity is a channel action.\n * `facebook_feed` - The activity is a Facebook feed action.\n * `group` - The activity is a group action.\n * `like` - The activity is a like action.\n * `ondemand` - The activity is a Vimeo On Demand action.\n * `share` - The activity is a share action.\n * `tag` - The activity is a tag action.\n * `twitter_timeline` - The activity is a Twitter timeline action.\n * `upload` - The activity is an upload action.\n"
},
"user": {
"$ref": "#/components/schemas/user"
},
"group": {
"$ref": "#/components/schemas/group"
},
"channel": {
"$ref": "#/components/schemas/channel"
},
"category": {
"$ref": "#/components/schemas/category"
},
"metadata": {
"type": "object",
"required": [
"connections"
],
"properties": {
"connections": {
"type": "object",
"required": [
"related"
],
"properties": {
"related": {
"type": "object",
"nullable": true,
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/users/152184/activities?offset=20",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "The activity's related content."
}
},
"description": "A list of resource URIs related to the activity."
}
},
"description": "Information about the activity's metadata."
}
},
"x-konfig-properties": {
"tag": {
"description": "The tag associated with the event. This field is present only when the activity type is `tag`."
},
"clip": {
"description": "The video associated with the activity."
},
"user": {
"description": "The user associated with the event. This field is present only when the activity type is `like`, `appearance`, or `share`."
},
"group": {
"description": "The group associated with the event. This field is present only when the activity type is `group`."
},
"channel": {
"description": "The channel associated with the event. This field is present only when the activity type is `channel`."
},
"category": {
"description": "The category associated with the event. This field is present only when the activity type is `category`."
}
}
}
album
{
"type": "object",
"title": "Album",
"required": [
"allow_continuous_play",
"allow_downloads",
"allow_share",
"autoplay",
"brand_color",
"created_time",
"custom_logo",
"description",
"domain",
"domain_certificate_state",
"duration",
"embed",
"embed_brand_color",
"embed_custom_logo",
"has_chosen_thumbnail",
"hide_from_vimeo",
"hide_nav",
"hide_upcoming",
"hide_vimeo_logo",
"layout",
"link",
"loop",
"metadata",
"modified_time",
"name",
"pictures",
"privacy",
"resource_key",
"review_mode",
"seo_allow_indexed",
"seo_description",
"seo_keywords",
"seo_title",
"share_link",
"sort",
"theme",
"unlisted_hash",
"uri",
"url",
"use_custom_domain",
"user",
"web_brand_color",
"web_custom_logo"
],
"properties": {
"uri": {
"type": "string",
"example": "/users/152184/albums/3706071",
"description": "The URI of the showcase."
},
"url": {
"type": "string",
"example": "my-custom-url",
"nullable": true,
"description": "The custom Vimeo URL of the showcase."
},
"link": {
"type": "string",
"example": "https://vimeo.com/showcase/Vimeo Holiday Videos!",
"description": "The URL of the showcase."
},
"loop": {
"type": "boolean",
"example": true,
"description": "Whether automatic playback restarts at the top of the showcase's embedded playlist after reaching the end of the last video in the playlist."
},
"name": {
"type": "string",
"example": "Vimeo Holiday Videos!",
"description": "The display name of the showcase."
},
"sort": {
"enum": [
"added_first",
"added_last",
"alphabetical",
"arranged",
"comments",
"likes",
"newest",
"oldest",
"plays"
],
"type": "string",
"example": "added_first",
"description": "The sort order of the showcase.\n\nOption descriptions:\n * `added_first` - Sort the showcase videos in order of those most recently added.\n * `added_last` - Sort the showcase videos in order of those least recently added.\n * `alphabetical` - Sort the showcase videos alphabetically.\n * `arranged` - Sort the showcase videos according to their custom arrangement.\n * `comments` - Sort the showcase videos by number of comments.\n * `likes` - Sort the showcase videos by number of likes.\n * `newest` - Sort the showcase videos in order of creation date with the newest first.\n * `oldest` - Sort the showcase videos in order of creation date with the oldest first.\n * `plays` - Sort the showcase videos by number of plays.\n"
},
"user": {
"$ref": "#/components/schemas/user"
},
"embed": {
"type": "object",
"required": [
"html"
],
"properties": {
"html": {
"type": "string",
"nullable": true,
"description": "The responsive HTML code to embed the showcase's playlist on a website. This field appears only when the showcase has embeddable videos."
}
},
"description": "Embed data for the showcase."
},
"theme": {
"enum": [
"dark",
"standard"
],
"type": "string",
"example": "dark",
"description": "The color theme of the showcase.\n\nOption descriptions:\n * `dark` - The showcase uses the dark theme.\n * `standard` - The showcase uses the standard theme.\n"
},
"domain": {
"type": "string",
"example": "mycustomdomain.com",
"nullable": true,
"description": "The custom domain of the showcase."
},
"layout": {
"enum": [
"grid",
"player"
],
"type": "string",
"example": "grid",
"description": "The type of layout for presenting the showcase.\n\nOption descriptions:\n * `grid` - The showcase videos appear in a grid.\n * `player` - The showcase videos appear in the player.\n"
},
"privacy": {
"type": "object",
"required": [
"view"
],
"properties": {
"view": {
"enum": [
"anybody",
"embed_only",
"nobody",
"password",
"team",
"unlisted"
],
"type": "string",
"example": "anybody",
"description": "The access level of the showcase.\n\nOption descriptions:\n * `anybody` - Anyone can access the showcase. This privacy setting appears as `Public` on the Vimeo front end.\n * `embed_only` - The showcase doesn't appear on Vimeo, but the owner can embed it on other sites.\n * `nobody` - No one can access the showacse, including the owner. This privacy setting appears as `Private` on the Vimeo front end.\n * `password` - Only those with the password can access the showcase.\n * `team` - Only the owner and members of the owner's team can access the showcase.\n * `unlisted` - The showcase can't be accessed if the URL omits its unlisted hash.\n"
},
"password": {
"type": "string",
"example": "hunter1",
"description": "The showcase's password. This field appears only when **privacy.view** is `password`."
}
},
"description": "The privacy settings of the showcase."
},
"autoplay": {
"type": "boolean",
"example": true,
"description": "Whether to start playback of the next video in the showcase's embedded playlist immediately after the previous video finishes."
},
"duration": {
"type": "number",
"example": 1163,
"description": "The total duration in seconds of all the videos in the showcase."
},
"hide_nav": {
"type": "boolean",
"example": true,
"description": "Whether to hide Vimeo navigation when displaying the showcase."
},
"metadata": {
"type": "object",
"required": [
"connections",
"interactions"
],
"properties": {
"connections": {
"type": "object",
"required": [
"available_videos",
"requested_clip",
"videos"
],
"properties": {
"videos": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/albums/3706071/videos",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 6,
"description": "The total number of videos on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the HTTP methods permitted on this URI."
}
},
"description": "Information about the videos that belong to the showcase."
},
"requested_clip": {
"type": "object",
"nullable": true,
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "videos/1232",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the requested video."
},
"available_videos": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/albums/3706071/available_videos",
"description": "The API URI that resolves to the connection data. This data requires a bearer token with the `private` scope."
},
"total": {
"type": "number",
"example": 14,
"description": "The total number of videos on this connection. This data requires a bearer token with the `private` scope."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI. This data requires a bearer token with the `private` scope."
}
},
"description": "Information about the authenticated user's videos that can be added to or removed from this showcase. This data requires a bearer token with the `private` scope."
}
},
"description": "Information about showcase connections."
},
"interactions": {
"type": "object",
"nullable": true,
"required": [
"add_custom_thumbnails",
"add_live_events",
"add_logos",
"add_to",
"add_videos",
"delete",
"edit",
"invite",
"view_privacy"
],
"properties": {
"edit": {
"type": "object",
"nullable": true,
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about where and how to edit a showcase."
},
"add_to": {
"type": "object",
"nullable": true,
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/albums/1234/videos/5678",
"description": "The API URI that resolves to the connection data. This data requires a bearer token with the `private` scope."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI. This data requires a bearer token with the `private` scope."
}
},
"description": "Information about adding or removing a video from the showcase. This data requires a bearer token with the `private` scope."
},
"delete": {
"type": "object",
"nullable": true,
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about where and how to delete a showcase."
},
"invite": {
"type": "object",
"nullable": true,
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about where and how to invite a team member to a showcase."
},
"add_logos": {
"type": "object",
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/users/123456/albums/654321/logos",
"description": "The API URI that resolves to the connection data. This data requires a bearer token with the `private` scope."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI. This data requires a bearer token with the `private` scope."
}
},
"description": "An action indicating that the authenticated user is an administrator of the showcase and may therefore add custom logos. This data requires a bearer token with the `private` scope."
},
"add_videos": {
"type": "object",
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/users/123456/albums/654321/videos",
"description": "The API URI that resolves to the connection data. This data requires a bearer token with the `private` scope."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI. This data requires a bearer token with the `private` scope."
}
},
"description": "An action indicating that the authenticated user is an administrator of the showcase and may therefore add videos. This data requires a bearer token with the `private` scope."
},
"view_privacy": {
"type": "object",
"nullable": true,
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about whether a user has permissions to view the privacy of the showcase."
},
"add_live_events": {
"type": "object",
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/users/123456/albums/654321/live_events",
"description": "The API URI that resolves to the connection data. This data requires a bearer token with the `private` scope."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI. This data requires a bearer token with the `private` scope."
}
},
"description": "An action indicating that the authenticated user is an administrator of the showcase and may therefore add events. This data requires a bearer token with the `private` scope."
},
"add_custom_thumbnails": {
"type": "object",
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/users/123456/albums/654321/custom_thumbnails",
"description": "The API URI that resolves to the connection data. This data requires a bearer token with the `private` scope."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI. This data requires a bearer token with the `private` scope."
}
},
"description": "An action indicating that the authenticated user is an administrator of the showcase and may therefore add custom thumbnails. This data requires a bearer token with the `private` scope."
}
},
"description": "A list of resource URIs related to the showcase."
}
},
"description": "Metadata about the showcase."
},
"pictures": {
"$ref": "#/components/schemas/picture"
},
"seo_title": {
"type": "string",
"nullable": true,
"description": "The SEO title of the showcase."
},
"share_link": {
"type": "string",
"description": "The URL for sharing the showcase."
},
"allow_share": {
"type": "boolean",
"example": true,
"description": "Whether the showcase permits sharing."
},
"brand_color": {
"type": "string",
"example": "ff66ee",
"nullable": true,
"description": "The hexadecimal code for the color of the player buttons and showcase controls."
},
"custom_logo": {
"allOf": [
{
"$ref": "#/components/schemas/picture"
}
],
"nullable": true,
"description": "The custom logo of the showcase."
},
"description": {
"type": "string",
"example": "Vimeo holiday videos!",
"nullable": true,
"description": "A brief description of the showcase's content."
},
"review_mode": {
"type": "boolean",
"example": true,
"description": "Whether showcase videos use the review mode URL."
},
"created_time": {
"type": "string",
"example": "2015-12-17T21:32:44+00:00",
"description": "The time in ISO 8601 format when the showcase was created."
},
"resource_key": {
"type": "string",
"example": "e5595241643259c658ed6c85ca82985a6341edc7",
"description": "The resource key of the showcase."
},
"seo_keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "The SEO keywords of the showcase."
},
"hide_upcoming": {
"type": "boolean",
"example": false,
"description": "Whether to include the upcoming event in the showcase."
},
"modified_time": {
"type": "string",
"example": "2018-02-06T21:24:17+00:00",
"description": "The time in ISO 8601 format when the showcase was last modified."
},
"unlisted_hash": {
"type": "string",
"description": "The unlisted hash of the showcase. Omit this hash from the showcase URL to prevent access to the showcase on Vimeo."
},
"allow_downloads": {
"type": "boolean",
"example": true,
"description": "Whether the showcase permits downloads."
},
"hide_from_vimeo": {
"type": "boolean",
"example": false,
"description": "Whether the showcase should be hidden from Vimeo when unlisted."
},
"hide_vimeo_logo": {
"type": "boolean",
"example": true,
"nullable": true,
"description": "Whether to hide the Vimeo logo in the player of the showcase's embedded playlist."
},
"seo_description": {
"type": "string",
"nullable": true,
"description": "The SEO description of the showcase."
},
"web_brand_color": {
"type": "boolean",
"example": true,
"description": "Whether to use the showcase's brand color in the web layout."
},
"web_custom_logo": {
"type": "boolean",
"example": true,
"description": "Whether to use the showcase's custom logo in the web layout."
},
"embed_brand_color": {
"type": "boolean",
"example": true,
"nullable": true,
"description": "Whether to show the showcase's custom brand color in the player of the showcase's embedded playlist."
},
"embed_custom_logo": {
"type": "boolean",
"example": true,
"nullable": true,
"description": "Whether to show the showcase's custom logo in the player of the showcase's embedded playlist."
},
"seo_allow_indexed": {
"type": "boolean",
"example": false,
"description": "Whether search engines can index the showcase."
},
"use_custom_domain": {
"type": "boolean",
"example": false,
"description": "Whether the showcase uses a custom domain."
},
"has_chosen_thumbnail": {
"type": "boolean",
"example": true,
"description": "Whether the showcase has a thumbnail."
},
"allow_continuous_play": {
"type": "boolean",
"example": true,
"description": "Whether the showcase permits continuous play."
},
"domain_certificate_state": {
"enum": [
"null",
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8"
],
"type": "string",
"example": "null",
"description": "The state of the SSL certificate that is associated with the showcase's domain.\n\nOption descriptions:\n * `null` - There is no associated HTTPS domain with this showcase.\n * `0` - The new certificate has yet to be processed.\n * `1` - The new certificate is being processed in the queue.\n * `2` - The certificate is being processed for renewal in the queue.\n * `3` - The new certificate has failed to be issued in the queue.\n * `4` - The certificate has failed to be renewed in the queue.\n * `5` - The certificate has been successfully issued.\n * `6` - The certificate has been successfully renewed.\n * `7` - The certificate has failed in the polling flow.\n * `8` - The certificate has failed to be renewed in the polling flow.\n"
}
},
"x-konfig-properties": {
"user": {
"description": "The owner of the showcase."
},
"pictures": {
"description": "The active image of the showcase."
}
}
}
analytics
{
"type": "object",
"title": "Analytics",
"required": [
"average_percent_watched",
"average_time_watched",
"country",
"device_type",
"downloads",
"embed_domain",
"end_date",
"finishes",
"impressions",
"metadata",
"start_date",
"total_time_watched",
"unique_impressions",
"unique_viewers",
"views"
],
"properties": {
"views": {
"type": "number",
"example": 1,
"description": "The number of views of the corresponding Vimeo content."
},
"country": {
"type": "object",
"required": [
"code",
"name"
],
"properties": {
"code": {
"type": "string",
"example": "US",
"description": "The country code in ISO-3166 format."
},
"name": {
"type": "string",
"example": "United States",
"description": "The name of the country."
}
}
},
"end_date": {
"type": "string",
"example": "2023-11-06T21:04:47+00:00",
"description": "The end time of the time interval in ISO 8601 format."
},
"finishes": {
"type": "number",
"example": 1,
"description": "The number of finishes of the corresponding Vimeo content."
},
"metadata": {
"type": "object",
"required": [
"connections"
],
"properties": {
"connections": {
"type": "object",
"required": [
"video"
],
"properties": {
"video": {
"type": "object",
"required": [
"created_time",
"duration",
"manage_link",
"options",
"title",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/videos/152184",
"description": "The API URI that resolves to the connection data. This data requires a bearer token with the `private` scope."
},
"title": {
"type": "string",
"description": "The title of the associated video. This data requires a bearer token with the `private` scope."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI. This data requires a bearer token with the `private` scope."
},
"duration": {
"type": "number",
"description": "The duration of the associated video. This data requires a bearer token with the `private` scope."
},
"manage_link": {
"type": "string",
"example": "/manage/videos/258684937",
"description": "The link to the video management page. This data requires a bearer token with the `private` scope."
},
"created_time": {
"type": "string",
"example": "2018-03-05T21:04:47+00:00",
"description": "The time in ISO 8601 format when the video was created. This data requires a bearer token with the `private` scope."
}
},
"description": "The associated video object. This data requires a bearer token with the `private` scope."
}
}
}
}
},
"downloads": {
"type": "number",
"example": 1,
"description": "The number of downloads of the corresponding Vimeo content."
},
"start_date": {
"type": "string",
"example": "2023-11-05T21:04:47+00:00",
"description": "The start time of the time interval in ISO 8601 format."
},
"device_type": {
"type": "string",
"example": "Desktop",
"description": "The type of device."
},
"impressions": {
"type": "number",
"example": 1,
"description": "The number of impressions of the corresponding Vimeo content."
},
"embed_domain": {
"type": "string",
"example": "vimeo.com",
"description": "The domain name of the website."
},
"unique_viewers": {
"type": "number",
"example": 1,
"description": "The number of unique viewers of the corresponding Vimeo content."
},
"total_time_watched": {
"type": "number",
"example": 200,
"description": "The total time watched in seconds of the corresponding Vimeo content."
},
"unique_impressions": {
"type": "number",
"example": 1,
"description": "The number of unique impressions of the corresponding Vimeo content."
},
"average_time_watched": {
"type": "number",
"example": 200,
"description": "The average time watched in seconds of the corresponding Vimeo content."
},
"average_percent_watched": {
"type": "number",
"example": 50,
"description": "The average percent watched in seconds of the corresponding Vimeo content."
}
}
}
ancestor-path
{
"type": "object",
"title": "Ancestor Path",
"required": [
"link",
"name"
],
"properties": {
"link": {
"type": "string",
"description": "The link to the folder."
},
"name": {
"type": "string",
"description": "The name of the folder."
}
}
}
animated-thumbnail
{
"type": "object",
"title": "Animated Thumbnail",
"required": [
"duration",
"file_format",
"file_size",
"height",
"is_downloadable",
"link",
"link_with_play_button",
"profile_id",
"start_time",
"uuid",
"width"
],
"properties": {
"link": {
"type": "string",
"example": "https://videoapi-muybridge-dev.vimeocdn.com/animated-thumbnails/image/7005be96-e5ab-4c4c-9cdd-8b6dfc2b304",
"description": "The URL of the animated thumbnail file."
},
"uuid": {
"type": "string",
"example": "b2f1-711515ecf",
"description": "The ID of the animated thumbnail."
},
"width": {
"type": "number",
"example": 800,
"description": "The width of the animated thumbnail in pixels."
},
"height": {
"type": "number",
"example": 450,
"description": "The height of the animated thumbnail in pixels."
},
"duration": {
"type": "number",
"example": 4,
"description": "The duration of the animated thumbnail in seconds."
},
"file_size": {
"type": "number",
"example": 1440000,
"description": "The file size of the animated thumbnail in bytes."
},
"profile_id": {
"type": "string",
"example": "Low",
"description": "The profile ID of the animated thumbnail."
},
"start_time": {
"type": "number",
"example": 0,
"description": "The time in the video, in seconds, corresponding to the start of the animation."
},
"file_format": {
"type": "string",
"example": "gif",
"description": "The file format of the animated thumbnail."
},
"is_downloadable": {
"type": "boolean",
"example": true,
"description": "Whether the animated thumbnail can be downloaded."
},
"link_with_play_button": {
"type": "string",
"example": "https://videoapi-muybridge-dev.vimeocdn.com/animated-thumbnails/image/7005be96-e5ab-4c4c-9cdd-8b6dfc2b304",
"description": "The URL of the animated thumbnail file with a play button overlay."
}
}
}
animated-thumbset
{
"type": "object",
"title": "Animated Thumbset",
"required": [
"clip_uri",
"created_on",
"sizes",
"status",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/videos/234/animated_thumbsets/ww-4c4c-9cdd",
"description": "The URI of the set of animated thumbnails."
},
"sizes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/animated-thumbnail"
},
"description": "An array of all the animated thumbnails in the set."
},
"status": {
"enum": [
"cancelled",
"completed",
"failed",
"started"
],
"type": "string",
"example": "cancelled",
"description": "The availability of the animated thumbnail.\n\nOption descriptions:\n * `cancelled` - The animated thumbnail's creation has been cancelled.\n * `completed` - The animated thumbnail has been created.\n * `failed` - The animated thumbnail's creation has failed.\n * `started` - The animated thumbnail's creation has started.\n"
},
"clip_uri": {
"type": "string",
"example": "/videos/23456",
"description": "The URI of the video from which the sets of animated thumbnails were created."
},
"created_on": {
"type": "string",
"example": "1494888499",
"description": "The time in ISO 8601 format when the GIF was created."
}
}
}
api-app
{
"type": "object",
"title": "API App",
"required": [
"capabilities",
"name",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/apps/12345",
"description": "The canonical URI of the API app."
},
"name": {
"type": "string",
"example": "Vimeo Android",
"description": "The name of the API app."
},
"capabilities": {
"type": "object",
"description": "The app's capabilities list."
}
}
}
auth
{
"type": "object",
"title": "Auth",
"required": [
"access_token",
"app",
"scope",
"token_type"
],
"properties": {
"app": {
"$ref": "#/components/schemas/api-app"
},
"user": {
"$ref": "#/components/schemas/user"
},
"scope": {
"type": "string",
"example": "private create edit upload public",
"description": "The scope or scopes that the token supports."
},
"expires_on": {
"type": "string",
"example": "1495048954",
"description": "The token's expiration date."
},
"token_type": {
"enum": [
"bearer"
],
"type": "string",
"example": "bearer",
"description": "The token type.\n\nOption descriptions:\n * `bearer` - The token is of the `bearer` type.\n"
},
"access_token": {
"type": "string",
"example": "01019a4a62aec63db077317ab7bb429db75652401e",
"description": "The access token string."
},
"refresh_token": {
"type": "string",
"example": "3d3bc8a9cb7debfd01b270e419b2d265983362f9",
"description": "The refresh token string. The Vimeo API doesn't currently support refresh tokens, but we plan to add this support in the future."
}
},
"x-konfig-properties": {
"app": {
"description": "The API application associated with the token."
},
"user": {
"description": "The user associated with the token."
}
}
}
auth-error
{
"type": "object",
"title": "Auth Error",
"required": [
"error",
"error_description"
],
"properties": {
"error": {
"type": "string",
"example": "server_error",
"description": "The name of the error."
},
"error_description": {
"type": "string",
"example": "An error has occurred on Vimeo's servers. Please try again.",
"description": "The description of the error."
}
}
}
category
{
"type": "object",
"title": "Category",
"required": [
"is_deprecated",
"last_video_featured_time",
"link",
"metadata",
"name",
"parent",
"pictures",
"resource_key",
"top_level",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/categories/animation",
"description": "The unique identifier to access the category resource."
},
"icon": {
"$ref": "#/components/schemas/picture"
},
"link": {
"type": "string",
"example": "https://vimeo.com/categories/animation",
"description": "The URL to access the category in a browser."
},
"name": {
"type": "string",
"example": "Animation",
"description": "The display name that identifies the category."
},
"parent": {
"type": "object",
"nullable": true,
"required": [
"link",
"name",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/categories/animation",
"description": "The unique identifier to access the parent of the category resource."
},
"link": {
"type": "string",
"example": "https://vimeo.com/categories/animation",
"description": "The URL to access the parent category in a browser."
},
"name": {
"type": "string",
"example": "Animation",
"description": "The display name that identifies the parent category."
}
},
"description": "The container of the category's parent category, if the current category is a subcategory."
},
"metadata": {
"type": "object",
"required": [
"connections",
"interactions"
],
"properties": {
"connections": {
"type": "object",
"required": [
"channels",
"groups",
"users",
"videos"
],
"properties": {
"users": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/categories/animation/videos",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 140,
"description": "The total number of users on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the users related to this category."
},
"groups": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/categories/animation/groups",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 15,
"description": "The total number of groups on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the groups related to this category."
},
"videos": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/categories/animation/videos",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 960,
"description": "The total number of videos on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the videos related to this category."
},
"channels": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/categories/animation/channels",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 90,
"description": "The total number of channels on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the channels related to this category."
}
},
"description": "A collection of information that is connected to this resource."
},
"interactions": {
"type": "object",
"required": [
"follow"
],
"properties": {
"follow": {
"type": "object",
"required": [
"added",
"added_time",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/users/152184/categories/animation",
"description": "The URI for following or unfollowing the category: PUT to this URI to follow the category, or DELETE to this URI to unfollow the category."
},
"added": {
"type": "boolean",
"example": true,
"description": "Whether the authenticated user has followed the category."
},
"added_time": {
"type": "string",
"example": "2017-05-17T17:46:09+00:00",
"nullable": true,
"description": "The time in ISO 8601 format when the user followed the category, or the null value if the user hasn't followed the category."
}
},
"description": "An action indicating if the authenticated user has followed the category."
}
},
"description": "The permissible actions related to the category."
}
},
"description": "Metadata about the category."
},
"pictures": {
"$ref": "#/components/schemas/picture"
},
"top_level": {
"type": "boolean",
"example": true,
"description": "Whether the category isn't a subcategory of another category."
},
"resource_key": {
"type": "string",
"example": "e5595241643259c658ed6c85ca82985a6341edc7",
"description": "The resource key of the category."
},
"is_deprecated": {
"type": "boolean",
"example": false,
"description": "Whether the category is deprecated and should not be used for new categorization."
},
"subcategories": {
"type": "array",
"items": {
"type": "object",
"required": [
"link",
"name",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/categories/animation/subcategories/2d",
"description": "The unique identifier to access the subcategory. resource."
},
"link": {
"type": "string",
"example": "https://vimeo.com/categories/animation/2d/videos",
"description": "The URL to access the subcategory in a browser."
},
"name": {
"type": "string",
"example": "2D",
"description": "The display name that identifies the subcategory."
}
}
},
"description": "All the subcategories that belong to the category, if the current category is a top-level parent."
},
"last_video_featured_time": {
"type": "string",
"example": "2017-05-17T17:46:09+00:00",
"description": "The most recent time in ISO 8601 format when the video was featured."
}
},
"x-konfig-properties": {
"icon": {
"description": "The active icon for the category."
},
"pictures": {
"description": "The active picture for this category. The default shows vertical color bars."
}
}
}
channel
{
"type": "object",
"title": "Channel",
"required": [
"categories",
"created_time",
"description",
"header",
"link",
"metadata",
"modified_time",
"name",
"pictures",
"privacy",
"resource_key",
"tags",
"uri",
"user"
],
"properties": {
"uri": {
"type": "string",
"example": "/channels/927",
"description": "The unique identifier to access the channel resource."
},
"link": {
"type": "string",
"example": "https://vimeo.com/channels/staffpicks",
"description": "The URL to access the channel in a browser."
},
"name": {
"type": "string",
"example": "Vimeo Staff Picks",
"description": "The display name that identifies the channel."
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tag"
},
"description": "An array of all tags assigned to the channel."
},
"user": {
"$ref": "#/components/schemas/user"
},
"header": {
"$ref": "#/components/schemas/picture"
},
"privacy": {
"type": "object",
"required": [
"view"
],
"properties": {
"view": {
"enum": [
"anybody",
"moderators",
"users"
],
"type": "string",
"example": "anybody",
"description": "The privacy setting of the channel.\n\nOption descriptions:\n * `anybody` - Anyone can access the channel. This privacy setting appears as `Public` on the Vimeo front end.\n * `moderators` - Only moderators can access the channel.\n * `users` - Only registered users can access the channel. _This field is deprecated._\n"
}
},
"description": "The privacy settings of the channel."
},
"metadata": {
"type": "object",
"required": [
"connections",
"interactions"
],
"properties": {
"connections": {
"type": "object",
"required": [
"privacy_users",
"users",
"videos"
],
"properties": {
"users": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/channels/927/users",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 794634,
"description": "The total number of users on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the users following or moderating this channel."
},
"videos": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/channels/927/videos",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 12448,
"description": "The total number of videos on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the videos that belong to this channel."
},
"privacy_users": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/channels/927/privacy/users",
"description": "The API URI that resolves to the connection data. This data requires a bearer token with the `private` scope."
},
"total": {
"type": "number",
"example": 36,
"description": "The total number of users on this connection. This data requires a bearer token with the `private` scope."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI. This data requires a bearer token with the `private` scope."
}
},
"description": "Information provided to channel moderators about which users they have specifically permitted to access this private channel. This data requires a bearer token with the `private` scope."
}
},
"description": "A collection of information that is connected to this resource."
},
"interactions": {
"type": "object",
"nullable": true,
"required": [
"add_moderators",
"add_to",
"follow",
"moderate_videos"
],
"properties": {
"add_to": {
"type": "object",
"nullable": true,
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/channels/1234/videos/5678",
"description": "The API URI that resolves to the connection data. This data requires a bearer token with the `private` scope."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI. This data requires a bearer token with the `private` scope."
}
},
"description": "When a channel appears in the context of adding or removing a video from it (`/videos/{video_id}/available_channels`), include information about adding or removing the video. This data requires a bearer token with the `private` scope."
},
"follow": {
"type": "object",
"required": [
"added",
"added_time",
"type",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/users/1234/channels/927",
"description": "The URI for following or unfollowing this channel. PUT to this URI to follow the channel, or DELETE to this URI to unfollow the channel. This data requires a bearer token with the `private` scope."
},
"type": {
"enum": [
"moderator",
"subscriber"
],
"type": "string",
"example": "moderator",
"nullable": true,
"description": "Whether the authenticated user is a moderator or subscriber. This data requires a bearer token with the `private` scope.\n\nOption descriptions:\n * `moderator` - The authenticated user is a moderator.\n * `subscriber` - The authenticated user is a subscriber.\n"
},
"added": {
"type": "boolean",
"example": true,
"description": "Whether the authenticated user has followed this channel. This data requires a bearer token with the `private` scope."
},
"added_time": {
"type": "string",
"example": "2017-05-22T17:50:11+00:00",
"nullable": true,
"description": "The time in ISO 8601 format that the user followed this channel, or the null value if the user hasn't followed the channel. This data requires a bearer token with the `private` scope."
}
},
"description": "An action indicating if the authenticated user has followed this channel. This data requires a bearer token with the `private` scope."
},
"add_moderators": {
"type": "object",
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/channels/1234/moderators",
"description": "The API URI that resolves to the connection data. This data requires a bearer token with the `private` scope."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI. This data requires a bearer token with the `private` scope."
}
},
"description": "An action indicating that the authenticated user is the owner of the channel and may therefore add other users as channel moderators. This data requires a bearer token with the `private` scope."
},
"moderate_videos": {
"type": "object",
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/channels/1234/videos",
"description": "The API URI that resolves to the connection data. This data requires a bearer token with the `private` scope."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods allowed on this URI. This data requires a bearer token with the `private` scope."
}
},
"description": "An action indicating that the authenticated user is a moderator of the channel and may therefore add or remove videos from the channel. This data requires a bearer token with the `private` scope."
}
},
"description": "A list of resource URIs related to the channel."
}
},
"description": "Metadata about the channel."
},
"pictures": {
"$ref": "#/components/schemas/picture"
},
"categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/category"
},
"description": "The categories to which the channel belongs as specified by the channel moderators."
},
"description": {
"type": "string",
"example": "We really love videos, and these are the videos we really, really love.",
"nullable": true,
"description": "A brief explanation of the channel's content."
},
"created_time": {
"type": "string",
"example": "2007-10-23T17:00:43+00:00",
"description": "The time in ISO 8601 format when the channel was created."
},
"resource_key": {
"type": "string",
"example": "e5595241643259c658ed6c85ca82985a6341edc7",
"description": "The channel resource key."
},
"modified_time": {
"type": "string",
"example": "2018-03-21T22:52:29+00:00",
"description": "The time in ISO 8601 format when the channel was last modified."
}
},
"x-konfig-properties": {
"user": {
"description": "The Vimeo user who owns the channel."
},
"header": {
"description": "The banner that appears by default at the top of the channel page."
},
"pictures": {
"description": "The active image for the channel. The default is the thumbnail of the last video added to the channel."
}
}
}
chapter
{
"type": "object",
"title": "Chapter",
"required": [
"thumbnails",
"timecode",
"title",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/videos/258684937/chapters/12345",
"description": "The relative URI of the chapter."
},
"title": {
"type": "string",
"example": "Chapter 1",
"nullable": true,
"description": "The title of the chapter."
},
"timecode": {
"type": "number",
"example": 140,
"nullable": true,
"description": "The timecode of the chapter in seconds from the start of the video."
},
"thumbnails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/picture"
},
"description": "The thumbnails associated with the video chapter."
},
"active_thumbnail_uri": {
"type": "string",
"example": "/videos/12345678/chapters/12345/pictures/24kjh4h4g38175db9f59fae9f7g9ekhg",
"description": "The URI of the active thumbnail."
}
}
}
comment
{
"type": "object",
"title": "Comment",
"required": [
"created_on",
"link",
"metadata",
"replies",
"resource_key",
"text",
"type",
"uri",
"user"
],
"properties": {
"uri": {
"type": "string",
"example": "/videos/258684937/comments/12345",
"description": "The unique identifier to access the comment resource."
},
"link": {
"type": "string",
"example": "https://vimeo.com/258684937#comment_12345",
"description": "The permalink to the comment."
},
"text": {
"type": "string",
"example": "I love this!",
"description": "The content of the comment."
},
"type": {
"enum": [
"video"
],
"type": "string",
"example": "video",
"description": "The Vimeo content to which the comment relates.\n\nOption descriptions:\n * `video` - The comment is about a video.\n"
},
"user": {
"allOf": [
{
"$ref": "#/components/schemas/user"
}
],
"nullable": true,
"description": "The user who posted the comment. _This field is deprecated. Use the `metadata.connections.user` field instead._"
},
"replies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/reply"
},
"description": "The list of replies to the comment."
},
"metadata": {
"type": "object",
"required": [
"connections"
],
"properties": {
"connections": {
"type": "object",
"required": [
"replies",
"user"
],
"properties": {
"user": {
"type": "object",
"required": [
"link",
"name",
"pictures",
"uri"
],
"properties": {
"uri": {
"type": "string",
"description": "The unique identifier to access the user resource."
},
"link": {
"type": "string",
"description": "The absolute URL of the authenticated users's profile page."
},
"name": {
"type": "string",
"description": "The display name of the user who posted the reply."
},
"pictures": {
"$ref": "#/components/schemas/picture"
}
},
"description": "Information about the user who posted the reply.",
"x-konfig-properties": {
"pictures": {
"description": "Information about the user's portraits."
}
}
},
"replies": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/videos/258684937/comments/12345/replies",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 42,
"description": "The total number of replies on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the replies to the comment."
}
}
}
}
},
"created_on": {
"type": "string",
"example": "2018-03-05T21:04:47+00:00",
"description": "The time in ISO 8601 format when the comment was posted."
},
"resource_key": {
"type": "string",
"example": "bac1033deba2310ebba2caec33c23e4beea67aba",
"description": "The comment's resource key string."
}
}
}
content-rating
{
"type": "object",
"title": "Content Rating",
"required": [
"code",
"name",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/contentrating/violence",
"nullable": true,
"description": "The canonical relative URI of the content rating."
},
"code": {
"enum": [
"advertisement",
"drugs",
"language",
"nudity",
"safe",
"unrated",
"violence"
],
"type": "string",
"example": "violence",
"description": "The reason for the content rating.\n\nOption descriptions:\n * `advertisement` - The content contains an advertisement.\n * `drugs` - The content contains drug or alcohol use.\n * `language` - The content contains profanity or sexually suggestive language.\n * `nudity` - The content contains nudity.\n * `safe` - The content is suitable for all audiences.\n * `unrated` - The content hasn't been rated.\n * `violence` - The content contains violence or is graphic.\n"
},
"name": {
"type": "string",
"example": "Violence",
"description": "The name of the content rating."
}
}
}
creative-commons
{
"type": "object",
"title": "Creative Commons",
"required": [
"code",
"name",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/creativecommons/by-sa",
"nullable": true,
"description": "The canonical relative URI of the Creative Commons license."
},
"code": {
"enum": [
"by",
"by-nc",
"by-nc-nd",
"by-nc-sa",
"by-nd",
"by-sa",
"cc0"
],
"type": "string",
"example": "by-sa",
"description": "The type of Creative Commons license.\n\nOption descriptions:\n * `by` - Attribution.\n * `by-nc` - Attribution Non-Commercial.\n * `by-nc-nd` - Attribution Non-Commercial No Derivatives.\n * `by-nc-sa` - Attribution Non-Commercial Share Alike.\n * `by-nd` - Attribution No Derivatives.\n * `by-sa` - Attribution Share Alike.\n * `cc0` - Public Domain Dedication.\n"
},
"name": {
"type": "string",
"example": "Attribution Share Alike",
"description": "The description of the Creative Commons license."
}
}
}
credit
{
"type": "object",
"title": "Credit",
"required": [
"name",
"role",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/videos/258684937/credits/1234",
"description": "The unique identifier to access the credit resource."
},
"name": {
"type": "string",
"example": "Sam Doe",
"description": "The name of the person credited."
},
"role": {
"type": "string",
"example": "Themselves",
"description": "The character that the person portrayed, or the job that the person performed."
},
"user": {
"$ref": "#/components/schemas/user"
},
"video": {
"$ref": "#/components/schemas/video"
}
},
"x-konfig-properties": {
"user": {
"description": "The Vimeo user associated with the credit."
},
"video": {
"description": "The video associated with the credit."
}
}
}
domain
{
"type": "object",
"title": "Domain",
"required": [
"allow_hd",
"domain",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/videos/258684937/privacy/domains/example.com",
"description": "The URI of the domain."
},
"domain": {
"type": "string",
"example": "example.com",
"description": "The domain name."
},
"allow_hd": {
"type": "boolean",
"example": true,
"description": "Whether to permit HD embeds on this domain."
}
}
}
editing-session
{
"type": "object",
"title": "Editing Session",
"required": [
"has_watermark",
"is_edited_by_tve",
"is_max_resolution",
"is_music_licensed",
"is_rated",
"min_tier_for_movie",
"result_video_hash",
"status",
"vsid"
],
"properties": {
"vsid": {
"type": "number",
"description": "The ID of the video's editing session."
},
"status": {
"enum": [
"done",
"processing"
],
"type": "string",
"example": "done",
"description": "The status of the video.\n\nOption descriptions:\n * `done` - The video is finished processing.\n * `processing` - The video is still being processed.\n"
},
"is_rated": {
"type": "boolean",
"example": false,
"description": "Whether the video has been rated."
},
"version_uri": {
"type": "string",
"example": "/videos/258684937/versions/12345",
"description": "The version's canonical relative URI."
},
"has_watermark": {
"type": "boolean",
"description": "Whether the video has a watermark."
},
"is_edited_by_tve": {
"type": "boolean",
"description": "Whether the video has been edited by Transcript Video Editing."
},
"is_max_resolution": {
"type": "boolean",
"description": "Whether the current version of the video is at the maximum resolution."
},
"is_music_licensed": {
"type": "boolean",
"description": "Whether the video has licensed music."
},
"result_video_hash": {
"type": "string",
"description": "The result video hash for the created video."
},
"min_tier_for_movie": {
"type": "string",
"description": "The minimum required Vimeo membership for the user to be able to share the video."
}
}
}
email-capture-form
{
"type": "object",
"title": "Email Capture Form",
"required": [
"clip_id",
"created_time",
"custom_fields",
"custom_logo",
"custom_message",
"email_lists",
"hidden_fields",
"id",
"position",
"privacy_policy",
"skippable",
"timecode",
"uri"
],
"properties": {
"id": {
"type": "number",
"example": 52845,
"description": "The ID of the email capture form."
},
"uri": {
"type": "string",
"example": "/clip_email_capture_form/52845",
"description": "The canonical relative URI of the video's email capture form."
},
"clip_id": {
"type": "number",
"example": 76979871,
"description": "The ID of the video associated with the form. If there is no associated video, the value of this field is `-1`."
},
"position": {
"enum": [
"after-video",
"before-video",
"during-video"
],
"type": "string",
"example": "before-video",
"description": "When the form appears relative to the video playback.\n\nOption descriptions:\n * `after-video` - The form appears immediately after the video ends.\n * `before-video` - The form appears before the video begins.\n * `during-video` - The form appears during the video at the time specified by the **timecode** field.\n"
},
"timecode": {
"type": "string",
"example": "00:00",
"description": "The timecode for when the form appears. This field is used when the value of **position** is `during-video`."
},
"skippable": {
"type": "boolean",
"example": true,
"description": "Whether the user can skip the form."
},
"custom_logo": {
"type": "number",
"example": 532603,
"description": "The ID of the logo image to display on the form."
},
"email_lists": {
"type": "array",
"items": {
"type": "object",
"required": [
"form_id",
"list_id",
"provider_id"
],
"properties": {
"form_id": {
"type": "number",
"description": "The ID of the email capture form."
},
"list_id": {
"type": "string",
"description": "The ID of the mailing list in the third-party email service provider's system."
},
"list_name": {
"type": "string",
"description": "The name of the mailing list in the third-party email service provider's system."
},
"provider_id": {
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"example": 1,
"description": "A third-party email service provider.\n\nOption descriptions:\n * `1` - The provider is Mailchimp.\n * `2` - The provider is Campaign Monitor.\n * `3` - The provider is Constant Contact.\n * `4` - The provider is Infusionsoft.\n * `5` - The provider is HubSpot.\n * `6` - The provider is Constant Contact V3.\n * `7` - The provider is Marketo.\n"
}
}
},
"description": "The mailing lists on a third-party email service provider that submissions should get synced to."
},
"created_time": {
"type": "string",
"example": "2016-11-03T09:24:56+00:00",
"description": "The time in ISO 8601 format when the form was created."
},
"custom_fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"connected_fields",
"field_metadata",
"field_name",
"field_type",
"locked",
"required",
"static_field"
],
"properties": {
"locked": {
"type": "boolean",
"description": "Whether the field's **required** property is editable but **field_name** isn't. If the value is `true`, the field can't be deleted."
},
"required": {
"type": "boolean",
"description": "Whether the field is required."
},
"field_name": {
"type": "string",
"description": "The name of a field in the form."
},
"field_type": {
"enum": [
"dropdown",
"text"
],
"type": "string",
"example": "dropdown",
"description": "The type of custom field.\n\nOption descriptions:\n * `dropdown` - The custom field used for dropdown item selection.\n * `text` - The custom field used for text input.\n"
},
"static_field": {
"type": "boolean",
"description": "Whether the field's **required** and **field_name** properties are both uneditable. If the value is `true`, the field can't be deleted."
},
"field_metadata": {
"type": "object",
"required": [
"options"
],
"properties": {
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"option_label",
"option_position"
],
"properties": {
"option_label": {
"type": "string",
"description": "The label for the field option."
},
"option_position": {
"type": "number",
"description": "The position of the option in the dropdown relative to the others."
}
}
},
"description": "An array of options associated with the field."
}
},
"description": "The metadata object that is associated with the field in the form."
},
"connected_fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"email_service_provider_field_id",
"form_field_id",
"provider_id"
],
"properties": {
"provider_id": {
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"example": 1,
"description": "A third-party email service provider.\n\nOption descriptions:\n * `1` - The provider is Mailchimp.\n * `2` - The provider is Campaign Monitor.\n * `3` - The provider is Constant Contact.\n * `4` - The provider is Infusionsoft.\n * `5` - The provider is HubSpot.\n * `6` - The provider is Constant Contact V3.\n * `7` - The provider is Marketo.\n"
},
"form_field_id": {
"type": "number",
"description": "The ID of the field in the form associated with the connected field."
},
"email_service_provider_field_id": {
"type": "string",
"description": "The ID of the provider field."
}
}
},
"description": "The email provider fields associated with the field in the form."
}
}
},
"description": "The fields to show in the form."
},
"hidden_fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"connected_fields",
"field_metadata",
"field_name",
"field_type",
"locked",
"required",
"static_field"
],
"properties": {
"locked": {
"type": "boolean",
"description": "Whether the field's **required** property is editable but **field_name** isn't. If the value is `true`, the field can't be deleted."
},
"required": {
"type": "boolean",
"description": "Whether the field is required."
},
"field_name": {
"type": "string",
"description": "The name of a field in the form."
},
"field_type": {
"enum": [
"dropdown",
"text"
],
"type": "string",
"example": "dropdown",
"description": "The type of custom field.\n\nOption descriptions:\n * `dropdown` - The custom field used for dropdown item selection.\n * `text` - The custom field used for text input.\n"
},
"static_field": {
"type": "boolean",
"description": "Whether the field's **required** and **field_name** properties are both uneditable. If the value is `true`, the field can't be deleted."
},
"field_metadata": {
"type": "object",
"required": [
"options"
],
"properties": {
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"option_label",
"option_position"
],
"properties": {
"option_label": {
"type": "string",
"description": "The label for the field option."
},
"option_position": {
"type": "number",
"description": "The position of the option in the dropdown relative to the others."
}
}
},
"description": "An array of options associated with the field."
}
},
"description": "The metadata object that is associated with the field in the form."
},
"connected_fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"email_service_provider_field_id",
"form_field_id",
"provider_id"
],
"properties": {
"provider_id": {
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"example": 1,
"description": "A third-party email service provider.\n\nOption descriptions:\n * `1` - The provider is Mailchimp.\n * `2` - The provider is Campaign Monitor.\n * `3` - The provider is Constant Contact.\n * `4` - The provider is Infusionsoft.\n * `5` - The provider is HubSpot.\n * `6` - The provider is Constant Contact V3.\n * `7` - The provider is Marketo.\n"
},
"form_field_id": {
"type": "number",
"description": "The ID of the field in the form associated with the connected field."
},
"email_service_provider_field_id": {
"type": "string",
"description": "The ID of the provider field."
}
}
},
"description": "The email provider fields associated with the field in the form."
}
}
},
"description": "The hidden fields to show only in the webinar management page. These fields are hidden in the player registration form."
},
"custom_message": {
"type": "string",
"example": "Sign up for our mailing list",
"description": "The message to display on the form."
},
"privacy_policy": {
"type": "string",
"example": "https://mywebsite.com/privacy-policy",
"description": "The URL of the privacy policy related to the form."
}
}
}
embed-settings
{
"type": "object",
"title": "Embed Settings",
"required": [
"airplay",
"ask_ai",
"audio_tracks",
"autopip",
"badges",
"buttons",
"cards",
"chapters",
"chromecast",
"closed_captions",
"color",
"colors",
"email_capture_form",
"end_screen",
"event_schedule",
"has_cards",
"interactive",
"logos",
"outro_type",
"pip",
"play_button",
"playbar",
"quality_selector",
"show_timezone",
"speed",
"title",
"transcript",
"volume"
],
"properties": {
"pip": {
"type": "boolean",
"example": true,
"description": "Whether picture-in-picture is enabled and the button appears in the embeddable player."
},
"uri": {
"type": "string",
"example": "/videos/258684937/presets/12345",
"description": "The URI of the embed preset."
},
"html": {
"type": "string",
"description": "The HTML code for embedding the video on a web page."
},
"cards": {
"type": "array",
"items": {
"type": "object",
"required": [
"display_time",
"headline",
"id",
"image_url",
"teaser",
"timecode",
"url"
],
"properties": {
"id": {
"type": "string",
"description": "The UUID of the card."
},
"url": {
"type": "string",
"description": "The URL of the card."
},
"teaser": {
"type": "string",
"description": "The description of the card."
},
"headline": {
"type": "string",
"description": "The title of the card."
},
"timecode": {
"type": "number",
"description": "The playback timestamp, given in seconds, when the card appears."
},
"image_url": {
"type": "string",
"description": "The URL of the thumbnail for the card."
},
"display_time": {
"type": "number",
"description": "The number of seconds for which the card appears."
}
}
},
"description": "A collection of cards associated with the selected video."
},
"color": {
"type": "string",
"example": "#0a0808",
"description": "The first player color, which controls the color of the progress bar, buttons, and more."
},
"logos": {
"type": "object",
"required": [
"custom",
"vimeo"
],
"properties": {
"vimeo": {
"type": "boolean",
"example": true,
"description": "Whether the Vimeo logo appears in the embeddable player."
},
"custom": {
"type": "object",
"required": [
"active",
"link",
"sticky",
"url",
"use_link"
],
"properties": {
"url": {
"type": "string",
"example": "http://example.com",
"nullable": true,
"description": "The URL of the selected custom logo."
},
"link": {
"type": "string",
"example": "http://example.com",
"nullable": true,
"description": "The URL that loads upon clicking the custom logo."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether the custom logo appears in the embeddable player."
},
"sticky": {
"type": "boolean",
"example": true,
"description": "Whether the custom logo appears even when the player interface is hidden."
},
"use_link": {
"type": "boolean",
"example": true,
"description": "Whether the custom logo should use the URL link."
}
},
"description": "A collection of information relating to custom logos in the embeddable player."
}
},
"description": "A collection of information about the logo in the corner of the embeddable player."
},
"speed": {
"type": "boolean",
"example": true,
"description": "Whether the speed controls appear in the embeddable player."
},
"title": {
"type": "object",
"required": [
"name",
"owner",
"portrait"
],
"properties": {
"name": {
"enum": [
"hide",
"show",
"user"
],
"type": "string",
"example": "hide",
"description": "How the embeddable player handles the video title.\n\nOption descriptions:\n * `hide` - The title is hidden.\n * `show` - The title is shown.\n * `user` - The title can be toggled to `show` or `hide` by the user.\n"
},
"owner": {
"enum": [
"hide",
"show",
"user"
],
"type": "string",
"example": "hide",
"description": "How the embeddable player handles the video owner's information.\n\nOption descriptions:\n * `hide` - The owner's information is hidden.\n * `show` - The owner's information is shown.\n * `user` - The owner's information can be toggled to `show` or `hide` by the user.\n"
},
"portrait": {
"enum": [
"hide",
"show",
"user"
],
"type": "string",
"example": "hide",
"description": "How the embeddable player handles the video owner's portrait.\n\nOption descriptions:\n * `hide` - The owner's portrait is hidden\n * `show` - The owner's portrait is shown.\n * `user` - The owner's portrait can be toggled to `show` or `hide` by the user.\n"
}
},
"description": "A collection of information about the embeddable player's title bar."
},
"ask_ai": {
"type": "boolean",
"example": true,
"description": "Whether Ask AI is enabled in the embeddable player."
},
"badges": {
"type": "object",
"required": [
"hdr",
"live",
"staff_pick",
"vod",
"weekend_challenge"
],
"properties": {
"hdr": {
"type": "boolean",
"example": true,
"description": "Whether the video has an HDR-compatible transcode."
},
"vod": {
"type": "boolean",
"example": false,
"description": "Whether the video is a Vimeo On Demand video."
},
"live": {
"type": "object",
"required": [
"archived",
"streaming"
],
"properties": {
"archived": {
"type": "boolean",
"example": false,
"description": "Whether the video was streamed live."
},
"streaming": {
"type": "boolean",
"example": true,
"description": "Whether the video is currently streaming live."
}
}
},
"hdr_10": {
"type": "boolean",
"description": "Whether the video was filmed using HDR10."
},
"staff_pick": {
"type": "object",
"required": [
"best_of_the_month",
"best_of_the_year",
"normal",
"premiere"
],
"properties": {
"normal": {
"type": "boolean",
"example": true,
"description": "Whether the video is a Vimeo Staff Pick."
},
"premiere": {
"type": "boolean",
"example": false,
"description": "Whether the video is a Vimeo Staff Pick Premiere."
},
"best_of_the_year": {
"type": "boolean",
"example": false,
"description": "Whether the video is a Vimeo Staff Pick Best of the Year."
},
"best_of_the_month": {
"type": "boolean",
"example": false,
"description": "Whether the video is a Vimeo Staff Pick Best of the Month."
}
}
},
"hdr_10_plus": {
"type": "boolean",
"description": "Whether the video was filmed using HDR10 Plus."
},
"dolby_vision": {
"type": "boolean",
"description": "Whether the video was filmed using Dolby Vision."
},
"weekend_challenge": {
"type": "boolean",
"example": false,
"description": "Whether the video is a Vimeo Weekend Challenge."
}
},
"description": "A collection of the video's badges."
},
"colors": {
"type": "object",
"required": [
"color_four",
"color_one",
"color_three",
"color_two"
],
"properties": {
"color_one": {
"type": "string",
"example": "#112233",
"description": "The first player color, which controls the color of the progress bar, buttons, and more."
},
"color_two": {
"type": "string",
"example": "#445566",
"description": "The second player color, which controls the player accent color."
},
"color_four": {
"type": "string",
"example": "#aabbcc",
"description": "The fourth player color, which controls the player background color."
},
"color_three": {
"type": "string",
"example": "#778899",
"description": "The third player color, which controls the color of text and icons."
}
},
"description": "A collection of information about player colors."
},
"volume": {
"type": "boolean",
"example": true,
"description": "Whether the volume controls appear in the embeddable player."
},
"airplay": {
"type": "boolean",
"example": true,
"description": "Whether AirPlay is enabled in the embeddable player."
},
"autopip": {
"type": "boolean",
"example": true,
"description": "Whether automatic picture-in-picture is enabled."
},
"buttons": {
"type": "object",
"required": [
"embed",
"fullscreen",
"hd",
"like",
"reaction",
"scaling",
"share",
"watchlater"
],
"properties": {
"hd": {
"type": "boolean",
"example": true,
"description": "Whether the `HD` button appears in the embeddable player."
},
"like": {
"type": "boolean",
"example": true,
"description": "Whether the `like` button appears in the embeddable player."
},
"embed": {
"type": "boolean",
"example": true,
"description": "Whether the `embed` button appears in the embeddable player."
},
"share": {
"type": "boolean",
"example": true,
"description": "Whether the `share` button appears in the embeddable player."
},
"scaling": {
"type": "boolean",
"example": true,
"description": "Whether the `scaling` button appears in the embeddable player."
},
"reaction": {
"type": "boolean",
"example": true,
"nullable": true,
"description": "Whether the reaction button appears in the embeddable player."
},
"fullscreen": {
"type": "boolean",
"example": true,
"description": "Whether the `fullscreen` button appears in the embeddable player."
},
"watchlater": {
"type": "boolean",
"example": true,
"description": "Whether the `watch later` button appears in the embeddable player."
}
},
"description": "A collection of information about the buttons that appear on the interface of the embeddable player."
},
"playbar": {
"type": "boolean",
"example": true,
"description": "Whether the playbar appears in the embeddable player."
},
"chapters": {
"type": "boolean",
"example": true,
"description": "Whether chapters are enabled in the embeddable player."
},
"has_cards": {
"type": "boolean",
"example": true,
"description": "Whether the video has cards."
},
"chromecast": {
"type": "boolean",
"example": true,
"description": "Whether the Chromecast button appears in the embeddable player."
},
"end_screen": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"empty",
"loop",
"share",
"thumbnail"
],
"type": "string",
"example": "empty",
"description": "How the embeddable player handles the end screen.\n\nOption descriptions:\n * `empty` - The end screen is empty.\n * `loop` - The end screen loops the video playback.\n * `share` - The end screen includes sharing options.\n * `thumbnail` - The end screen includes the thumbnail of the video.\n"
}
},
"description": "A collection of information about the embeddable player's end screen."
},
"outro_type": {
"enum": [
"beginning",
"custom",
"email",
"image",
"link",
"loop",
"nothing",
"share",
"text",
"threevideos",
"videos"
],
"type": "string",
"example": "link",
"description": "The type of the video outro.\n\nOption descriptions:\n * `beginning` - The outro is a thumbnail.\n * `custom` - The outro is custom.\n * `email` - The outro is an email form.\n * `image` - The outro is an image.\n * `link` - The outro is a link.\n * `loop` - The outro is a loop.\n * `nothing` - There is no outro.\n * `share` - The outro is a share button.\n * `text` - The outro is text.\n * `threevideos` - The outro is three video suggestions.\n * `videos` - The outro is video suggestions.\n"
},
"transcript": {
"type": "boolean",
"example": true,
"description": "Whether the transcript controls appear in the embeddable player."
},
"interactive": {
"type": "boolean",
"example": true,
"description": "Whether the video is an interactive video."
},
"play_button": {
"type": "object",
"required": [
"position"
],
"properties": {
"position": {
"enum": [
"auto",
"bottom",
"center"
],
"type": "string",
"example": "auto",
"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": "A representation of the play button's settings."
},
"audio_tracks": {
"type": "boolean",
"example": true,
"description": "Whether multiple audio tracks can appear in the embeddable player."
},
"show_timezone": {
"type": "boolean",
"example": false,
"description": "Whether the embedded player should display the schedule timezone."
},
"event_schedule": {
"type": "boolean",
"example": true,
"description": "Whether the embedded player should display the event schedule."
},
"closed_captions": {
"type": "boolean",
"example": true,
"description": "Whether closed captions are enabled in the embeddable player."
},
"quality_selector": {
"type": "boolean",
"example": true,
"description": "Whether the quality selector appears in the embeddable player."
},
"email_capture_form": {
"$ref": "#/components/schemas/email-capture-form"
}
},
"x-konfig-properties": {
"email_capture_form": {
"description": "The email capture form settings associated with the video."
}
}
}
endpoint
{
"type": "object",
"title": "Endpoint",
"required": [
"methods",
"path"
],
"properties": {
"path": {
"type": "string",
"example": "/me",
"description": "The path section of the URL, which, when appended to the API host `https:///api.vimeo.com`, builds a full API endpoint."
},
"methods": {
"type": "array",
"items": {
"type": "string"
},
"description": "All HTTP methods permitted on this endpoint."
}
}
}
error
{
"type": "object",
"title": "Error",
"required": [
"developer_message",
"error",
"error_code",
"link"
],
"properties": {
"link": {
"type": "string",
"description": "A link to more information about the error."
},
"error": {
"type": "string",
"example": "Something strange occurred. Please try again.",
"description": "The error message that general users receive."
},
"error_code": {
"type": "number",
"example": 5000,
"description": "The error code."
},
"developer_message": {
"type": "string",
"example": "The specified resource does not exist.",
"description": "The error message that technical users receive."
}
}
}
fragments
{
"type": "object",
"title": "Fragments",
"required": [
"created_on",
"metadata",
"modified_on",
"timecode",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/videos/!clip_id/fragments",
"description": "The URI of the video fragment."
},
"metadata": {
"type": "object",
"required": [
"connections"
],
"properties": {
"connections": {
"type": "object",
"required": [
"clip"
],
"properties": {
"clip": {
"type": "object",
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/videos/710320868",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the videos that belong to this channel."
}
},
"description": "A collection of information that is connected to this resource."
}
},
"description": "Metadata about the fragments."
},
"timecode": {
"type": "number",
"example": 11145,
"description": "The time in milliseconds of the fragment's _inpoint_, or the time from the start of the video that marks the beginning of the fragment."
},
"created_on": {
"type": "string",
"example": "2022-05-23T15:24:31+00:00",
"description": "The time in ISO 8601 format when the fragment was created."
},
"modified_on": {
"type": "string",
"example": "2022-05-23T15:24:31+00:00",
"description": "The time in ISO 8601 format when the fragment was last updated."
}
}
}
group
{
"type": "object",
"title": "Group",
"required": [
"created_time",
"description",
"link",
"metadata",
"modified_time",
"name",
"pictures",
"privacy",
"resource_key",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/groups/1108",
"description": "The canonical relative URI of the group."
},
"link": {
"type": "string",
"example": "https://vimeo.com/groups/weekendchallenge",
"description": "The link to the group."
},
"name": {
"type": "string",
"example": "Vimeo Weekend Challenge",
"description": "The group's display name."
},
"user": {
"allOf": [
{
"$ref": "#/components/schemas/user"
}
],
"nullable": true,
"description": "The owner of the group."
},
"privacy": {
"type": "object",
"required": [
"comment",
"invite",
"join",
"videos",
"view"
],
"properties": {
"join": {
"enum": [
"anybody",
"members"
],
"type": "string",
"example": "anybody",
"description": "Who can join the group.\n\nOption descriptions:\n * `anybody` - Anyone can join the group.\n * `members` - Only people with a Vimeo account can join the group.\n"
},
"view": {
"enum": [
"anybody",
"members"
],
"type": "string",
"example": "anybody",
"description": "Who can access the group.\n\nOption descriptions:\n * `anybody` - Anyone can access the group. This privacy setting appears as `Public` on the Vimeo front end.\n * `members` - Only group members can access the group.\n"
},
"invite": {
"enum": [
"all",
"members"
],
"type": "string",
"example": "all",
"description": "Who can invite new members to the group.\n\nOption descriptions:\n * `all` - Anyone can invite new members to the group.\n * `members` - Only group members can invite new members to the group.\n"
},
"videos": {
"enum": [
"all",
"members"
],
"type": "string",
"example": "all",
"description": "Who can add videos to the group.\n\nOption descriptions:\n * `all` - Anyone can add videos to the group.\n * `members` - Only group members can add videos to the group.\n"
},
"comment": {
"enum": [
"all",
"members"
],
"type": "string",
"example": "all",
"description": "Who can comment on the group.\n\nOption descriptions:\n * `all` - Anyone can comment on the group.\n * `members` - Only group members can comment on the group.\n"
}
},
"description": "The group's privacy settings."
},
"metadata": {
"type": "object",
"required": [
"connections",
"interactions"
],
"properties": {
"connections": {
"type": "object",
"required": [
"users",
"videos"
],
"properties": {
"users": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/groups/1108/users",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 25798,
"description": "The total number of users on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the members or moderators of the group."
},
"videos": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/groups/1108/videos",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 7252,
"description": "The total number of videos on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the videos contained within the group."
}
},
"description": "A collection of information that is connected to this resource."
},
"interactions": {
"type": "object",
"required": [
"join"
],
"properties": {
"join": {
"type": "object",
"required": [
"added",
"added_time",
"title",
"type",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/users/152184/groups/1108",
"description": "The URI for following the group. PUT to this URI to follow the group, or DELETE to this URI to unfollow the group. This data requires a bearer token with the `private` scope."
},
"type": {
"enum": [
"member",
"moderator"
],
"type": "string",
"example": "member",
"nullable": true,
"description": "Whether the user is a moderator or subscriber. This data requires a bearer token with the `private` scope.\n\nOption descriptions:\n * `member` - The user is a member.\n * `moderator` - The user is a moderator.\n"
},
"added": {
"type": "boolean",
"example": true,
"description": "Whether the user has followed the group. This data requires a bearer token with the `private` scope."
},
"title": {
"type": "string",
"example": "Vimeo Staff",
"nullable": true,
"description": "The user's title. If this field isn't applicable, it takes the null value. This data requires a bearer token with the `private` scope."
},
"added_time": {
"type": "string",
"nullable": true,
"description": "The time in ISO 8601 format when the user joined the group. This data requires a bearer token with the `private` scope."
}
},
"description": "An action indicating that someone has joined the group. This data requires a bearer token with the `private` scope."
}
},
"description": "User actions that have involved the group. This data requires a bearer token with the `private` scope."
}
},
"description": "Metadata about the group."
},
"pictures": {
"$ref": "#/components/schemas/picture"
},
"description": {
"type": "string",
"example": "Want to participate in our weekly challenges? Join the group to receive messages and new challenges!",
"nullable": true,
"description": "The group's description."
},
"created_time": {
"type": "string",
"example": "2008-07-05T14:52:43+00:00",
"description": "The time in ISO 8601 format when the group was created."
},
"resource_key": {
"type": "string",
"example": "dc724af18fbdd4e59189f5fe768a5f8311527050",
"description": "The resource key of the group."
},
"modified_time": {
"type": "string",
"example": "2018-09-16T15:41:45+00:00",
"description": "The time in ISO 8601 format when the group was last modified."
}
},
"x-konfig-properties": {
"pictures": {
"description": "The active picture for the group."
}
}
}
hls-dash-video-file
{
"type": "object",
"title": "HLS/DASH Video File",
"required": [
"link",
"link_expiration_time"
],
"properties": {
"log": {
"type": "string",
"example": "https:/api.vimeo.com/videos/258684937/log/12337123/76af42bfd",
"nullable": true,
"description": "The URL for logging events."
},
"link": {
"type": "string",
"example": "https://player.vimeo.com/play/965853365?s=258684937_1537",
"nullable": true,
"description": "The direct link to the video file."
},
"link_expiration_time": {
"type": "string",
"example": "2017-05-16T17:21:51+00:00",
"description": "The time in ISO 8601 format when the link to the video file expires."
}
}
}
language
{
"type": "object",
"title": "Language",
"required": [
"code",
"name"
],
"properties": {
"code": {
"type": "string",
"example": "en-US",
"description": "The standard ISO 639-1 code for the language."
},
"name": {
"type": "string",
"example": "English (United States)",
"description": "The name of the language."
}
}
}
legacy-error
{
"type": "object",
"title": "Legacy Error",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"example": "Something strange occurred. Please try again.",
"description": "The error message."
}
}
}
live-event
{
"type": "object",
"title": "Live Event",
"required": [
"album",
"allow_share_link",
"allowed_privacies",
"auto_cc_enabled",
"auto_cc_keywords",
"auto_cc_language",
"auto_cc_remaining",
"automatically_title_stream",
"chat_enabled",
"completed_on",
"content_rating",
"created_time",
"dvr",
"email_quota",
"embed",
"from_showcase",
"head_clip",
"interaction_tools_settings",
"latency",
"lead_uuid",
"link",
"live_clips",
"live_destinations",
"low_latency",
"metadata",
"next_occurrence_time",
"parent_folder",
"pictures",
"playlist_sort",
"preferred_stream_method",
"rtmp_link",
"rtmp_preview",
"rtmps_link",
"schedule",
"scheduled_playback",
"status",
"stream_description",
"stream_key",
"stream_mode",
"stream_password",
"stream_privacy",
"stream_title",
"streamable_clip",
"time_zone",
"title",
"unlimited_auto_cc",
"unlimited_duration",
"uri",
"user",
"view_link",
"webinar",
"whitelisted_domains"
],
"properties": {
"dvr": {
"type": "boolean",
"example": true,
"description": "Whether the DVR feature is enabled."
},
"uri": {
"type": "string",
"example": "/live_events/12345",
"description": "The event's canonical relative URI."
},
"link": {
"type": "string",
"example": "/events/12345",
"description": "The URI to access the event on Vimeo."
},
"user": {
"$ref": "#/components/schemas/user"
},
"album": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true,
"description": "Information about the associated showcase."
},
"embed": {
"type": "object",
"required": [
"airplay",
"autoplay",
"available_player_logos",
"byline",
"chat_embed_source",
"chromecast",
"closed_captions",
"color",
"colors",
"embed_chat",
"embed_properties",
"event_schedule",
"fullscreen_button",
"hide_live_label",
"hide_viewer_count",
"html",
"like_button",
"logos",
"loop",
"pip",
"play_button_position",
"playbar",
"playlist",
"portrait",
"responsive_html",
"schedule",
"show_latest_archived_clip",
"show_timezone",
"title",
"use_color",
"volume"
],
"properties": {
"pip": {
"type": "boolean",
"example": true,
"description": "Whether picture-in-picture is enabled and the button appears in the embeddable player."
},
"html": {
"type": "string",
"nullable": true,
"description": "The fixed HTML code to embed the event's playlist on a website."
},
"loop": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should loop back to the first video once content is exhausted."
},
"color": {
"type": "string",
"example": "#0a0808",
"description": "The first player color, which controls the color of the progress bar, buttons, and more."
},
"logos": {
"type": "object",
"required": [
"custom",
"vimeo"
],
"properties": {
"vimeo": {
"type": "boolean",
"example": true,
"description": "Whether the Vimeo logo appears in the embeddable player for the video."
},
"custom": {
"type": "object",
"required": [
"active",
"link",
"sticky",
"url",
"use_link"
],
"properties": {
"url": {
"type": "string",
"example": "http://example.com",
"description": "The URL source of the custom player logo."
},
"link": {
"type": "string",
"example": "http://example.com",
"description": "The URL that loads upon clicking the custom logo."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether the custom logo appears in the embeddable player."
},
"sticky": {
"type": "boolean",
"example": true,
"description": "Whether the custom logo appears even when the player interface is hidden."
},
"use_link": {
"type": "boolean",
"example": true,
"description": "Whether the custom logo should use the URL link."
}
},
"description": "A collection of information relating to custom logos in the embeddable player."
}
},
"description": "A collection of information about the logo in the corner of the embeddable player."
},
"title": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should display the video title."
},
"byline": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should display the author's name."
},
"colors": {
"type": "object",
"required": [
"color_four",
"color_one",
"color_three",
"color_two"
],
"properties": {
"color_one": {
"type": "string",
"example": "#112233",
"description": "The first player color, which controls the color of the progress bar, buttons, and more."
},
"color_two": {
"type": "string",
"example": "#445566",
"description": "The second player color, which controls the player accent color."
},
"color_four": {
"type": "string",
"example": "#aabbcc",
"description": "The fourth player color, which controls the player background color."
},
"color_three": {
"type": "string",
"example": "#778899",
"description": "The third player color, which controls the color of text and icons."
}
},
"description": "A collection of information about player colors."
},
"volume": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should include the volume controls."
},
"airplay": {
"type": "boolean",
"example": true,
"description": "Whether AirPlay is enabled in the embeddable player."
},
"playbar": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should include the playbar."
},
"autoplay": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should autoplay the RLE content."
},
"playlist": {
"type": "boolean",
"example": true,
"description": "Whether the playlist component appears in the embeddable player for this RLE."
},
"portrait": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should display the author's portrait."
},
"schedule": {
"type": "boolean",
"example": true,
"description": "Whether the schedule component appears in the embeddable player for this RLE."
},
"use_color": {
"type": "string",
"example": "true",
"description": "Whether the embedded RLE player should use a custom color or the default Vimeo blue."
},
"chromecast": {
"type": "boolean",
"example": true,
"description": "Whether the Chromecast button appears in the embeddable player."
},
"embed_chat": {
"type": "string",
"nullable": true,
"description": "The embed code for RLE chat."
},
"like_button": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should include the `like` button."
},
"show_timezone": {
"type": "boolean",
"example": false,
"description": "Whether the embedded RLE player should display the schedule timezone."
},
"event_schedule": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should display the event schedule."
},
"closed_captions": {
"type": "boolean",
"example": true,
"description": "Whether closed captions are enabled in the embeddable player."
},
"hide_live_label": {
"type": "boolean",
"example": false,
"description": "Whether the Live label should be visible over the player."
},
"responsive_html": {
"type": "string",
"nullable": true,
"description": "The responsive HTML code to embed the event's playlist on a website."
},
"embed_properties": {
"type": "object",
"nullable": true,
"required": [
"height",
"source_url",
"width"
],
"properties": {
"width": {
"type": "string",
"description": "The width used to generate the fixed HTML embed code."
},
"height": {
"type": "string",
"description": "The height used to generate the fixed HTML embed code."
},
"source_url": {
"type": "string",
"description": "The source URL used to generate the fixed HTML embed code."
}
},
"description": "The height, width, and source URL properties used to generate the fixed HTML embed code."
},
"chat_embed_source": {
"type": "string",
"nullable": true,
"description": "The chat's iFrame source URL."
},
"fullscreen_button": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should include the fullscreen controls."
},
"hide_viewer_count": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should hide the viewer counter."
},
"play_button_position": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "The position of the player's play button.\n\nOption descriptions:\n * `0` - The play button has the default position.\n * `1` - The play button appears at the bottom of the interface.\n * `2` - The play button appears in the center of the interface.\n"
},
"available_player_logos": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of user-uploaded logos for configuration of the embed player."
},
"show_latest_archived_clip": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should display the latest video placeholder."
}
},
"description": "The event's embed data."
},
"title": {
"type": "string",
"example": "Live Content",
"description": "The title of the event. This field is also optionally used as the base title for videos created by streaming to the event."
},
"status": {
"enum": [
"ended",
"started"
],
"type": "string",
"example": "started",
"nullable": true,
"description": "The status of the event.\n\nOption descriptions:\n * `ended` - The user ended the event.\n * `started` - The user started the event.\n"
},
"latency": {
"enum": [
"fail-safe",
"low",
"standard"
],
"type": "string",
"example": "standard",
"description": "The type of latency.\n\nOption descriptions:\n * `fail-safe` - The latency is in the failsafe range, with a delay of 60-75 seconds.\n * `low` - The latency is low, with a delay of 5-7 seconds.\n * `standard` - The latency is standard, with a delay of 15-20 seconds.\n"
},
"webinar": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true,
"description": "Information about the associated webinar."
},
"metadata": {
"type": "object",
"required": [
"connections",
"interactions"
],
"properties": {
"connections": {
"type": "object",
"required": [
"live_video",
"pictures",
"pre_live_video",
"team_member",
"videos"
],
"properties": {
"videos": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/live_events/12345/videos",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 6,
"description": "The total number of videos on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the HTTP methods permitted on this URI."
}
},
"description": "Information about the videos that belong to the event."
},
"pictures": {
"type": "object",
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/live_events/12345/pictures",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the HTTP methods permitted on this URI."
}
},
"description": "Information about the event's thumbnails."
},
"live_video": {
"type": "object",
"nullable": true,
"required": [
"options",
"status",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/live_events/12345/videos/12345",
"description": "The API URI that resolves to the connection data."
},
"status": {
"enum": [
"streaming"
],
"type": "string",
"example": "streaming",
"description": "The status of the live video's RTMP link.\n\nOption descriptions:\n * `streaming` - The stream is open and receiving content.\n"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the HTTP methods permitted on this URI."
}
},
"description": "Information about the event's live video, where applicable."
},
"team_member": {
"type": "object",
"nullable": true,
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/users/123456789/team_users/123456",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the HTTP methods permitted on this URI."
}
},
"description": "Information about the team member who owns the event."
},
"pre_live_video": {
"type": "object",
"nullable": true,
"required": [
"options",
"status",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/live_events/12345/videos/12345",
"description": "The API URI that resolves to the connection data."
},
"status": {
"enum": [
"pending",
"ready",
"streaming",
"unavailable"
],
"type": "string",
"example": "pending",
"description": "The status of the pre-live video's RTMP link.\n\nOption descriptions:\n * `pending` - Vimeo is working on setting up the connection.\n * `ready` - Resources have been provisioned for the event.\n * `streaming` - Live video is currently streaming to the RTMP link.\n * `unavailable` - The connection is ready, but streaming to the RTMP link has not yet begun.\n"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the HTTP methods permitted on this URI."
}
},
"description": "Information about the event's pre-live video, where applicable. A pre-live video is either activated or in the process of being activated."
}
},
"description": "A collection of information that is connected to this resource."
},
"interactions": {
"type": "object",
"required": [
"activate",
"delete",
"edit"
],
"properties": {
"edit": {
"type": "object",
"nullable": true,
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about where and how to edit an item."
},
"delete": {
"type": "object",
"nullable": true,
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about where and how to delete an item."
},
"activate": {
"type": "object",
"nullable": true,
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about where and how to activate the event."
}
},
"description": "A list of resource URIs related to the event."
}
},
"description": "Metadata about the event."
},
"pictures": {
"$ref": "#/components/schemas/picture"
},
"schedule": {
"$ref": "#/components/schemas/live-event-schedule"
},
"head_clip": {
"type": "object",
"nullable": true,
"description": "The first video to be played in the playlist."
},
"lead_uuid": {
"type": "string",
"description": "The unique ID for the registered viewer."
},
"rtmp_link": {
"type": "string",
"example": "rtmp://rtmp.cloud.vimeo.com/live",
"nullable": true,
"description": "The upstream RTMP link. Send your live content to this link to create a live video on the event."
},
"time_zone": {
"type": "string",
"example": "America/New_York",
"description": "The time zone used in resolving the timestamps included in auto-generated video titles."
},
"view_link": {
"type": "string",
"example": "/events/12345",
"description": "The URI to access the event on Vimeo with or without an unlisted hash."
},
"live_clips": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of videos belonging to the event, including their video IDs and dates streamed."
},
"rtmps_link": {
"type": "string",
"example": "rtmps://rtmp.cloud.vimeo.com/live",
"nullable": true,
"description": "The upstream RTMPS link. Send your live content to this link to create a live video on the event."
},
"stream_key": {
"type": "string",
"example": "ab9c8def-7a65-4321-b098-c7dd65e43f21",
"nullable": true,
"description": "The stream key used in conjunction with the RTMP and RTMPS links."
},
"email_quota": {
"type": "object",
"required": [
"capping",
"total"
],
"properties": {
"total": {
"type": "number",
"example": 300,
"description": "The current number of entity emails that the user has sent."
},
"capping": {
"type": "number",
"example": 400,
"description": "The maximum number of entity emails that the user can send."
}
},
"description": "Information about the event owner's email quota."
},
"low_latency": {
"type": "boolean",
"example": false,
"description": "Whether the low-latency feature is enabled."
},
"stream_mode": {
"enum": [
"live",
"record",
"simulive"
],
"type": "string",
"example": "live",
"description": "The stream mode of the event.\n\nOption descriptions:\n * `live` - The stream is live playback.\n * `record` - The stream is in record mode.\n * `simulive` - The stream is scheduled media playback.\n"
},
"chat_enabled": {
"type": "boolean",
"example": true,
"description": "Whether to display live chat on the event page on Vimeo."
},
"completed_on": {
"type": "string",
"example": "2021-11-11T11:24:56+00:00",
"description": "The time in ISO 8601 format when the event was completed."
},
"created_time": {
"type": "string",
"example": "2016-11-03T09:24:56+00:00",
"description": "The time in ISO 8601 format when the event was created."
},
"from_webinar": {
"type": "boolean",
"description": "Whether the event was created from a webinar."
},
"rtmp_preview": {
"type": "boolean",
"example": true,
"description": "Whether to preview the RTMP stream before the event goes live."
},
"stream_title": {
"type": "string",
"example": "Special Feature",
"description": "The title of the next video streamed to the event. This field applies only when **automatically_title_stream** is `false`."
},
"from_showcase": {
"type": "boolean",
"description": "Whether the event was created from a showcase."
},
"parent_folder": {
"allOf": [
{
"$ref": "#/components/schemas/project"
}
],
"nullable": true,
"description": "Information about the folder that contains the event."
},
"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 inside the event appear in the playlist.\n\nOption descriptions:\n * `added_first` - The videos appear according to when they were added to the event, with the most recently added first.\n * `added_last` - The videos appear according to when they were added to the event, with the most recently added last.\n * `alphabetical` - The videos appear alphabetically by their title.\n * `arranged` - The videos appear as arranged by the owner of the event.\n * `comments` - The videos appear according to their number of comments.\n * `duration` - The videos appear in order of duration.\n * `likes` - The videos appear according to their number of likes.\n * `newest` - The videos appear in chronological order, with the newest first.\n * `oldest` - The videos appear in chronological order, with the oldest first.\n * `plays` - The videos appear according to their number of plays.\n"
},
"content_rating": {
"enum": [
"advertisement",
"drugs",
"language",
"nudity",
"safe",
"unrated",
"violence"
],
"type": "array",
"items": {
"type": "string",
"example": "advertisement"
},
"description": "The event's granular content ratings.\n\nOption descriptions:\n * `advertisement` - The event contains advertisements.\n * `drugs` - The event contains drug or alcohol use.\n * `language` - The event contains profanity or sexually suggestive content.\n * `nudity` - The event contains nudity.\n * `safe` - The event is safe for all audiences.\n * `unrated` - The event hasn't been rated.\n * `violence` - The event contains violence.\n"
},
"stream_privacy": {
"type": "object",
"required": [
"embed",
"unlisted_hash",
"view"
],
"properties": {
"view": {
"enum": [
"anybody",
"embed_only",
"nobody",
"password",
"unlisted"
],
"type": "string",
"example": "anybody",
"description": "The general privacy setting for generated videos and the embed privacy of the entire collection.\n\nOption descriptions:\n * `anybody` - Anyone can access the videos. This privacy setting appears as `Public` on the Vimeo front end.\n * `embed_only` - The videos don't appear on Vimeo, but they can be embedded elsewhere.\n * `nobody` - Only the event owner can access the videos. This privacy setting appears as `Private` on the Vimeo front end.\n * `password` - Only those with the password can access the videos.\n * `unlisted` - Only those with the private link can access the videos.\n"
},
"embed": {
"enum": [
"private",
"public",
"whitelist"
],
"type": "string",
"example": "public",
"description": "The event's embed permission setting.\n\nOption descriptions:\n * `private` - The event can't be embedded on any domain.\n * `public` - The event can be embedded on any domain.\n * `whitelist` - The event can be embedded on whitelisted domains only.\n"
},
"unlisted_hash": {
"type": "string",
"example": "1a2b3c4d5e",
"nullable": true,
"description": "The hash for unlisted events."
}
},
"description": "The initial privacy settings of videos generated by streaming to the event as well as the embed privacy of the entire collection."
},
"auto_cc_enabled": {
"type": "boolean",
"nullable": true,
"description": "Whether the automated closed captions feature is enabled."
},
"stream_password": {
"type": "string",
"example": "hunter1",
"nullable": true,
"description": "The password that anyone can use to access the videos generated by streaming to the event."
},
"streamable_clip": {
"type": "object",
"nullable": true,
"description": "The event's video. An event always has a video, which is either in a pre-live state (ready to be streamed to) or in a live state (which is currently being streamed to)."
},
"allow_share_link": {
"type": "boolean",
"example": true,
"description": "Whether the share link for the videos generated by streaming to the event is usable."
},
"auto_cc_keywords": {
"type": "string",
"nullable": true,
"description": "A comma-separated list of keywords for enhancing the speech detection of automated closed captions."
},
"auto_cc_language": {
"enum": [
"de-DE",
"en-US",
"es-ES",
"fr-FR",
"pt-BR"
],
"type": "string",
"example": "en-US",
"nullable": true,
"description": "The language of the automated closed captions.\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"
},
"allowed_privacies": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of privacy settings supported for this event and the requesting user."
},
"auto_cc_remaining": {
"type": "number",
"nullable": true,
"description": "The amount of time remaining to the user to access the automated closed captions feature."
},
"live_destinations": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true,
"description": "_This field is deprecated in favor of the following method:_ [Get all the destinations of a one-time live event](https://developer.vimeo.com/api/reference/live#get_one_time_event_destinations)."
},
"unlimited_auto_cc": {
"type": "boolean",
"nullable": true,
"description": "Whether to ignore the time limit of the automated closed captions feature."
},
"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",
"nullable": true,
"description": "The description of the next video streamed to the event."
},
"unlimited_duration": {
"type": "boolean",
"example": true,
"description": "Whether 24/7 streaming is enabled for the event."
},
"whitelisted_domains": {
"type": "array",
"items": {
"type": "object",
"required": [
"allow_hd",
"domain",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/videos/258684937/privacy/domains/example.com",
"description": "The URI of the domain."
},
"domain": {
"type": "string",
"example": "example.com",
"description": "The domain name."
},
"allow_hd": {
"type": "boolean",
"example": true,
"description": "Whether to permit HD embeds on this domain."
}
}
},
"nullable": true,
"description": "The domains on a video's whitelist."
},
"next_occurrence_time": {
"type": "string",
"example": "2018-07-30T14:00:00+00:00",
"nullable": true,
"description": "The date in ISO 8601 format on which the next occurrence of the event is expected to be live."
},
"preferred_stream_method": {
"enum": [
"browser",
"encoder"
],
"type": "string",
"example": "encoder",
"description": "The preferred streaming method.\n\nOption descriptions:\n * `browser` - Stream in the browser.\n * `encoder` - Stream by the encoder.\n"
},
"automatically_title_stream": {
"type": "boolean",
"example": true,
"description": "When the value of this field is `true`, 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": "array",
"items": {
"type": "object",
"required": [
"is_anonymous_questions_disabled",
"is_qna_moderated"
],
"properties": {
"is_qna_moderated": {
"type": "boolean",
"description": "Whether the Q&A is moderated for the interaction tools settings."
},
"is_anonymous_questions_disabled": {
"type": "boolean",
"description": "Whether anonymous questions are disabled for the interaction tools settings."
}
}
},
"nullable": true,
"description": "The settings for the interaction tools."
}
},
"x-konfig-properties": {
"user": {
"description": "The owner of the event."
},
"pictures": {
"description": "The active thumbnail image of the event."
},
"schedule": {
"description": "The description of the time or times that the event is expected to be live."
}
}
}
live-event-automated-closed-captions
{
"type": "object",
"title": "Live Event Automated Closed Captions",
"required": [
"auto_cc_can_be_enabled",
"auto_cc_enabled",
"auto_cc_is_unlimited",
"auto_cc_keywords",
"auto_cc_language",
"auto_cc_remaining",
"event_id"
],
"properties": {
"event_id": {
"type": "number",
"example": 1111,
"description": "The ID of the event."
},
"auto_cc_enabled": {
"type": "boolean",
"example": true,
"description": "Whether the option for automated closed captions is enabled."
},
"auto_cc_keywords": {
"type": "string",
"example": "sun,water,wind",
"description": "A comma-separated list of keywords for enhancing the speech detection of automated closed captions."
},
"auto_cc_language": {
"type": "string",
"example": "en",
"nullable": true,
"description": "The language of the automated closed captions."
},
"auto_cc_remaining": {
"type": "number",
"example": 300,
"description": "The number of minutes remaining for automated closed captions in the user's current period."
},
"auto_cc_is_unlimited": {
"type": "boolean",
"example": false,
"description": "Whether automated closed captions are unlimited for the user."
},
"auto_cc_can_be_enabled": {
"type": "boolean",
"example": false,
"description": "Whether automated closed captions can be enabled."
}
}
}
live-event-destination
{
"type": "object",
"title": "Live Event Destination",
"required": [
"display_name",
"id",
"is_enabled",
"live_clip_id",
"privacy",
"provider_broadcast_id",
"provider_destination_id",
"provider_user_id",
"provider_video_id",
"scheduled_at",
"service_name",
"state",
"state_message",
"stream_key",
"stream_url",
"type",
"user_id"
],
"properties": {
"id": {
"type": "number",
"example": 1234,
"description": "The ID of the destination."
},
"type": {
"enum": [
"channel",
"custom",
"organization",
"page",
"profile"
],
"type": "string",
"example": "channel",
"description": "The type of the simulcast destination.\n\nOption descriptions:\n * `channel` - The destination is a YouTube channel.\n * `custom` - The destination is custom.\n * `organization` - The destination is a LinkedIn organization.\n * `page` - The destination is a Facebook page.\n * `profile` - The destination is a Facebook or LinkedIn profile.\n"
},
"state": {
"enum": [
0,
1
],
"type": "integer",
"description": "The status of the destination.\n\nOption descriptions:\n * `0` - The status is OK.\n * `1` - An error occurred. Check the `state_message` field for details.\n"
},
"privacy": {
"enum": [
"CONNECTIONS",
"PUBLIC",
"all_friends",
"everyone",
"private",
"public",
"self",
"unlisted"
],
"type": "string",
"example": "public",
"nullable": true,
"description": "The privacy setting of the destination.\n\nOption descriptions:\n * `CONNECTIONS` - The privacy setting is `CONNECTIONS` for LinkedIn.\n * `PUBLIC` - The privacy setting is `PUBLIC` for LinkedIn.\n * `all_friends` - The privacy setting is `all_friends` for Facebook.\n * `everyone` - The privacy setting is `everyone` for Facebook.\n * `private` - The privacy setting is `private` for YouTube.\n * `public` - The privacy setting is `public` for YouTube.\n * `self` - The privacy setting is `self` for Facebook.\n * `unlisted` - The privacy setting is `unlisted` for YouTube.\n"
},
"user_id": {
"type": "number",
"example": 123456,
"description": "The ID of the destination's owner."
},
"is_enabled": {
"type": "boolean",
"example": true,
"description": "Whether the destination is enabled."
},
"stream_key": {
"type": "string",
"example": "b624fa1e-23d8-4d27-90f9-fe7d0ad700ed",
"nullable": true,
"description": "The stream key for the simulcast destination."
},
"stream_url": {
"type": "string",
"example": "rtmp://cooldomain.com/live",
"nullable": true,
"description": "The RTMP URL to stream to."
},
"display_name": {
"type": "string",
"example": "Test page",
"description": "The name of the destination target, whether a page, profile name, or the like."
},
"live_clip_id": {
"type": "number",
"example": 123456,
"description": "The ID of the live video."
},
"scheduled_at": {
"type": "number",
"example": 1625754461,
"nullable": true,
"description": "The time in Unix timestamp format when live streaming is scheduled to start."
},
"service_name": {
"enum": [
"custom_rtmp",
"facebook",
"linkedin",
"youtube"
],
"type": "string",
"example": "facebook",
"description": "The name of the destination service.\n\nOption descriptions:\n * `custom_rtmp` - The destination service is custom RTMP.\n * `facebook` - The destination service is Facebook Live.\n * `linkedin` - The destination service is LinkedIn Live.\n * `youtube` - The destination service is YouTube Live.\n"
},
"state_message": {
"type": "string",
"example": "\"Couldn't connect to rtmp://1.2.3.4/live\"",
"nullable": true,
"description": "The message that describes the state of the destination."
},
"provider_user_id": {
"type": "string",
"example": "a6378de4995a",
"nullable": true,
"description": "The user ID of the destination service."
},
"provider_video_id": {
"type": "string",
"example": "6817807391346708000",
"nullable": true,
"description": "The ID of the scheduled live video."
},
"provider_broadcast_id": {
"type": "string",
"example": "9fe254b7d55e7542da9fbd46a5deb947",
"nullable": true,
"description": "The destination ID of the destination service."
},
"provider_destination_id": {
"type": "string",
"example": "fm4m34gm5oirbkjfkfnkkdhgfi45v3df34oz",
"nullable": true,
"description": "The broadcast ID of the destination service."
}
}
}
live-event-recurring
{
"type": "object",
"title": "Live Event Recurring",
"required": [
"album",
"allow_share_link",
"allowed_privacies",
"auto_cc_enabled",
"auto_cc_keywords",
"auto_cc_language",
"auto_cc_remaining",
"automatically_title_stream",
"chat_enabled",
"completed_on",
"content_rating",
"created_time",
"dvr",
"email_quota",
"embed",
"from_showcase",
"head_clip",
"interaction_tools_settings",
"latency",
"lead_uuid",
"link",
"live_clips",
"live_destinations",
"low_latency",
"metadata",
"next_occurrence_time",
"parent_folder",
"pictures",
"playlist_sort",
"preferred_stream_method",
"rtmp_link",
"rtmp_preview",
"rtmps_link",
"schedule",
"scheduled_playback",
"status",
"stream_description",
"stream_key",
"stream_mode",
"stream_password",
"stream_privacy",
"stream_title",
"streamable_clip",
"time_zone",
"title",
"unlimited_auto_cc",
"unlimited_duration",
"uri",
"user",
"view_link",
"webinar",
"whitelisted_domains"
],
"properties": {
"dvr": {
"type": "boolean",
"example": true,
"description": "Whether the DVR feature is enabled."
},
"uri": {
"type": "string",
"example": "/live_events/12345",
"description": "The event's canonical relative URI."
},
"link": {
"type": "string",
"example": "/events/12345",
"description": "The URI to access the event on Vimeo."
},
"user": {
"$ref": "#/components/schemas/user"
},
"album": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true,
"description": "Information about the associated showcase."
},
"embed": {
"type": "object",
"required": [
"airplay",
"autoplay",
"available_player_logos",
"byline",
"chat_embed_source",
"chromecast",
"closed_captions",
"color",
"colors",
"embed_chat",
"embed_properties",
"event_schedule",
"fullscreen_button",
"hide_live_label",
"hide_viewer_count",
"html",
"like_button",
"logos",
"loop",
"pip",
"play_button_position",
"playbar",
"playlist",
"portrait",
"responsive_html",
"schedule",
"show_latest_archived_clip",
"show_timezone",
"title",
"use_color",
"volume"
],
"properties": {
"pip": {
"type": "boolean",
"example": true,
"description": "Whether picture-in-picture is enabled and the button appears in the embeddable player."
},
"html": {
"type": "string",
"nullable": true,
"description": "The fixed HTML code to embed the event's playlist on a website."
},
"loop": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should loop back to the first video once content is exhausted."
},
"color": {
"type": "string",
"example": "#0a0808",
"description": "The first player color, which controls the color of the progress bar, buttons, and more."
},
"logos": {
"type": "object",
"required": [
"custom",
"vimeo"
],
"properties": {
"vimeo": {
"type": "boolean",
"example": true,
"description": "Whether the Vimeo logo appears in the embeddable player for the video."
},
"custom": {
"type": "object",
"required": [
"active",
"link",
"sticky",
"url",
"use_link"
],
"properties": {
"url": {
"type": "string",
"example": "http://example.com",
"description": "The URL source of the custom player logo."
},
"link": {
"type": "string",
"example": "http://example.com",
"description": "The URL that loads upon clicking the custom logo."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether the custom logo appears in the embeddable player."
},
"sticky": {
"type": "boolean",
"example": true,
"description": "Whether the custom logo appears even when the player interface is hidden."
},
"use_link": {
"type": "boolean",
"example": true,
"description": "Whether the custom logo should use the URL link."
}
},
"description": "A collection of information relating to custom logos in the embeddable player."
}
},
"description": "A collection of information about the logo in the corner of the embeddable player."
},
"title": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should display the video title."
},
"byline": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should display the author's name."
},
"colors": {
"type": "object",
"required": [
"color_four",
"color_one",
"color_three",
"color_two"
],
"properties": {
"color_one": {
"type": "string",
"example": "#112233",
"description": "The first player color, which controls the color of the progress bar, buttons, and more."
},
"color_two": {
"type": "string",
"example": "#445566",
"description": "The second player color, which controls the player accent color."
},
"color_four": {
"type": "string",
"example": "#aabbcc",
"description": "The fourth player color, which controls the player background color."
},
"color_three": {
"type": "string",
"example": "#778899",
"description": "The third player color, which controls the color of text and icons."
}
},
"description": "A collection of information about player colors."
},
"volume": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should include the volume controls."
},
"airplay": {
"type": "boolean",
"example": true,
"description": "Whether AirPlay is enabled in the embeddable player."
},
"playbar": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should include the playbar."
},
"autoplay": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should autoplay the RLE content."
},
"playlist": {
"type": "boolean",
"example": true,
"description": "Whether the playlist component appears in the embeddable player for this RLE."
},
"portrait": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should display the author's portrait."
},
"schedule": {
"type": "boolean",
"example": true,
"description": "Whether the schedule component appears in the embeddable player for this RLE."
},
"use_color": {
"type": "string",
"example": "true",
"description": "Whether the embedded RLE player should use a custom color or the default Vimeo blue."
},
"chromecast": {
"type": "boolean",
"example": true,
"description": "Whether the Chromecast button appears in the embeddable player."
},
"embed_chat": {
"type": "string",
"nullable": true,
"description": "The embed code for RLE chat."
},
"like_button": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should include the `like` button."
},
"show_timezone": {
"type": "boolean",
"example": false,
"description": "Whether the embedded RLE player should display the schedule timezone."
},
"event_schedule": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should display the event schedule."
},
"closed_captions": {
"type": "boolean",
"example": true,
"description": "Whether closed captions are enabled in the embeddable player."
},
"hide_live_label": {
"type": "boolean",
"example": false,
"description": "Whether the Live label should be visible over the player."
},
"responsive_html": {
"type": "string",
"nullable": true,
"description": "The responsive HTML code to embed the event's playlist on a website."
},
"embed_properties": {
"type": "object",
"nullable": true,
"required": [
"height",
"source_url",
"width"
],
"properties": {
"width": {
"type": "string",
"description": "The width used to generate the fixed HTML embed code."
},
"height": {
"type": "string",
"description": "The height used to generate the fixed HTML embed code."
},
"source_url": {
"type": "string",
"description": "The source URL used to generate the fixed HTML embed code."
}
},
"description": "The height, width, and source URL properties used to generate the fixed HTML embed code."
},
"chat_embed_source": {
"type": "string",
"nullable": true,
"description": "The chat's iFrame source URL."
},
"fullscreen_button": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should include the fullscreen controls."
},
"hide_viewer_count": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should hide the viewer counter."
},
"play_button_position": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "The position of the player's play button.\n\nOption descriptions:\n * `0` - The play button has the default position.\n * `1` - The play button appears at the bottom of the interface.\n * `2` - The play button appears in the center of the interface.\n"
},
"available_player_logos": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of user-uploaded logos for configuration of the embed player."
},
"show_latest_archived_clip": {
"type": "boolean",
"example": true,
"description": "Whether the embedded RLE player should display the latest video placeholder."
}
},
"description": "The event's embed data."
},
"title": {
"type": "string",
"example": "Live Content",
"description": "The title of the event. This field is also optionally used as the base title for videos created by streaming to the event."
},
"status": {
"enum": [
"ended",
"started"
],
"type": "string",
"example": "started",
"nullable": true,
"description": "The status of the event.\n\nOption descriptions:\n * `ended` - The user ended the event.\n * `started` - The user started the event.\n"
},
"latency": {
"enum": [
"fail-safe",
"low",
"standard"
],
"type": "string",
"example": "standard",
"description": "The type of latency.\n\nOption descriptions:\n * `fail-safe` - The latency is in the failsafe range, with a delay of 60-75 seconds.\n * `low` - The latency is low, with a delay of 5-7 seconds.\n * `standard` - The latency is standard, with a delay of 15-20 seconds.\n"
},
"webinar": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true,
"description": "Information about the associated webinar."
},
"metadata": {
"type": "object",
"required": [
"connections",
"interactions"
],
"properties": {
"connections": {
"type": "object",
"required": [
"live_video",
"pictures",
"pre_live_video",
"team_member",
"videos"
],
"properties": {
"videos": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/live_events/12345/videos",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 6,
"description": "The total number of videos on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the HTTP methods permitted on this URI."
}
},
"description": "Information about the videos that belong to the event."
},
"pictures": {
"type": "object",
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/live_events/12345/pictures",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the HTTP methods permitted on this URI."
}
},
"description": "Information about the event's thumbnails."
},
"live_video": {
"type": "object",
"nullable": true,
"required": [
"options",
"status",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/live_events/12345/videos/12345",
"description": "The API URI that resolves to the connection data."
},
"status": {
"enum": [
"streaming"
],
"type": "string",
"example": "streaming",
"description": "The status of the live video's RTMP link.\n\nOption descriptions:\n * `streaming` - The stream is open and receiving content.\n"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the HTTP methods permitted on this URI."
}
},
"description": "Information about the event's live video, where applicable."
},
"team_member": {
"type": "object",
"nullable": true,
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/users/123456789/team_users/123456",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the HTTP methods permitted on this URI."
}
},
"description": "Information about the team member who owns the event."
},
"pre_live_video": {
"type": "object",
"nullable": true,
"required": [
"options",
"status",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/live_events/12345/videos/12345",
"description": "The API URI that resolves to the connection data."
},
"status": {
"enum": [
"pending",
"ready",
"streaming",
"unavailable"
],
"type": "string",
"example": "pending",
"description": "The status of the pre-live video's RTMP link.\n\nOption descriptions:\n * `pending` - Vimeo is working on setting up the connection.\n * `ready` - Resources have been provisioned for the event.\n * `streaming` - Live video is currently streaming to the RTMP link.\n * `unavailable` - The connection is ready, but streaming to the RTMP link has not yet begun.\n"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the HTTP methods permitted on this URI."
}
},
"description": "Information about the event's pre-live video, where applicable. A pre-live video is either activated or in the process of being activated."
}
},
"description": "A collection of information that is connected to this resource."
},
"interactions": {
"type": "object",
"required": [
"activate",
"delete",
"edit"
],
"properties": {
"edit": {
"type": "object",
"nullable": true,
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about where and how to edit an item."
},
"delete": {
"type": "object",
"nullable": true,
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about where and how to delete an item."
},
"activate": {
"type": "object",
"nullable": true,
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about where and how to activate the event."
}
},
"description": "A list of resource URIs related to the event."
}
},
"description": "Metadata about the event."
},
"pictures": {
"$ref": "#/components/schemas/picture"
},
"schedule": {
"$ref": "#/components/schemas/live-event-schedule"
},
"head_clip": {
"type": "object",
"nullable": true,
"description": "The first video to be played in the playlist."
},
"lead_uuid": {
"type": "string",
"description": "The unique ID for the registered viewer."
},
"rtmp_link": {
"type": "string",
"example": "rtmp://rtmp.cloud.vimeo.com/live",
"nullable": true,
"description": "The upstream RTMP link. Send your live content to this link to create a live video on the event."
},
"time_zone": {
"type": "string",
"example": "America/New_York",
"description": "The time zone used in resolving the timestamps included in auto-generated video titles."
},
"view_link": {
"type": "string",
"example": "/events/12345",
"description": "The URI to access the event on Vimeo with or without an unlisted hash."
},
"live_clips": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of videos belonging to the event, including their video IDs and dates streamed."
},
"rtmps_link": {
"type": "string",
"example": "rtmps://rtmp.cloud.vimeo.com/live",
"nullable": true,
"description": "The upstream RTMPS link. Send your live content to this link to create a live video on the event."
},
"stream_key": {
"type": "string",
"example": "ab9c8def-7a65-4321-b098-c7dd65e43f21",
"nullable": true,
"description": "The stream key used in conjunction with the RTMP and RTMPS links."
},
"email_quota": {
"type": "object",
"required": [
"capping",
"total"
],
"properties": {
"total": {
"type": "number",
"example": 300,
"description": "The current number of entity emails that the user has sent."
},
"capping": {
"type": "number",
"example": 400,
"description": "The maximum number of entity emails that the user can send."
}
},
"description": "Information about the event owner's email quota."
},
"low_latency": {
"type": "boolean",
"example": false,
"description": "Whether the low-latency feature is enabled."
},
"stream_mode": {
"enum": [
"live",
"record",
"simulive"
],
"type": "string",
"example": "live",
"description": "The stream mode of the event.\n\nOption descriptions:\n * `live` - The stream is live playback.\n * `record` - The stream is in record mode.\n * `simulive` - The stream is scheduled media playback.\n"
},
"chat_enabled": {
"type": "boolean",
"example": true,
"description": "Whether to display live chat on the event page on Vimeo."
},
"completed_on": {
"type": "string",
"example": "2021-11-11T11:24:56+00:00",
"description": "The time in ISO 8601 format when the event was completed."
},
"created_time": {
"type": "string",
"example": "2016-11-03T09:24:56+00:00",
"description": "The time in ISO 8601 format when the event was created."
},
"from_webinar": {
"type": "boolean",
"description": "Whether the event was created from a webinar."
},
"rtmp_preview": {
"type": "boolean",
"example": true,
"description": "Whether to preview the RTMP stream before the event goes live."
},
"stream_title": {
"type": "string",
"example": "Special Feature",
"description": "The title of the next video streamed to the event. This field applies only when **automatically_title_stream** is `false`."
},
"from_showcase": {
"type": "boolean",
"description": "Whether the event was created from a showcase."
},
"parent_folder": {
"allOf": [
{
"$ref": "#/components/schemas/project"
}
],
"nullable": true,
"description": "Information about the folder that contains the event."
},
"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 inside the event appear in the playlist.\n\nOption descriptions:\n * `added_first` - The videos appear according to when they were added to the event, with the most recently added first.\n * `added_last` - The videos appear according to when they were added to the event, with the most recently added last.\n * `alphabetical` - The videos appear alphabetically by their title.\n * `arranged` - The videos appear as arranged by the owner of the event.\n * `comments` - The videos appear according to their number of comments.\n * `duration` - The videos appear in order of duration.\n * `likes` - The videos appear according to their number of likes.\n * `newest` - The videos appear in chronological order, with the newest first.\n * `oldest` - The videos appear in chronological order, with the oldest first.\n * `plays` - The videos appear according to their number of plays.\n"
},
"content_rating": {
"enum": [
"advertisement",
"drugs",
"language",
"nudity",
"safe",
"unrated",
"violence"
],
"type": "array",
"items": {
"type": "string",
"example": "advertisement"
},
"description": "The event's granular content ratings.\n\nOption descriptions:\n * `advertisement` - The event contains advertisements.\n * `drugs` - The event contains drug or alcohol use.\n * `language` - The event contains profanity or sexually suggestive content.\n * `nudity` - The event contains nudity.\n * `safe` - The event is safe for all audiences.\n * `unrated` - The event hasn't been rated.\n * `violence` - The event contains violence.\n"
},
"stream_privacy": {
"type": "object",
"required": [
"embed",
"unlisted_hash",
"view"
],
"properties": {
"view": {
"enum": [
"anybody",
"embed_only",
"nobody",
"password",
"unlisted"
],
"type": "string",
"example": "anybody",
"description": "The general privacy setting for generated videos and the embed privacy of the entire collection.\n\nOption descriptions:\n * `anybody` - Anyone can access the videos. This privacy setting appears as `Public` on the Vimeo front end.\n * `embed_only` - The videos don't appear on Vimeo, but they can be embedded elsewhere.\n * `nobody` - Only the event owner can access the videos. This privacy setting appears as `Private` on the Vimeo front end.\n * `password` - Only those with the password can access the videos.\n * `unlisted` - Only those with the private link can access the videos.\n"
},
"embed": {
"enum": [
"private",
"public",
"whitelist"
],
"type": "string",
"example": "public",
"description": "The event's embed permission setting.\n\nOption descriptions:\n * `private` - The event can't be embedded on any domain.\n * `public` - The event can be embedded on any domain.\n * `whitelist` - The event can be embedded on whitelisted domains only.\n"
},
"unlisted_hash": {
"type": "string",
"example": "1a2b3c4d5e",
"nullable": true,
"description": "The hash for unlisted events."
}
},
"description": "The initial privacy settings of videos generated by streaming to the event as well as the embed privacy of the entire collection."
},
"auto_cc_enabled": {
"type": "boolean",
"nullable": true,
"description": "Whether the automated closed captions feature is enabled."
},
"stream_password": {
"type": "string",
"example": "hunter1",
"nullable": true,
"description": "The password that anyone can use to access the videos generated by streaming to the event."
},
"streamable_clip": {
"type": "object",
"nullable": true,
"description": "The event's video. An event always has a video, which is either in a pre-live state (ready to be streamed to) or in a live state (which is currently being streamed to)."
},
"allow_share_link": {
"type": "boolean",
"example": true,
"description": "Whether the share link for the videos generated by streaming to the event is usable."
},
"auto_cc_keywords": {
"type": "string",
"nullable": true,
"description": "A comma-separated list of keywords for enhancing the speech detection of automated closed captions."
},
"auto_cc_language": {
"enum": [
"de-DE",
"en-US",
"es-ES",
"fr-FR",
"pt-BR"
],
"type": "string",
"example": "en-US",
"nullable": true,
"description": "The language of the automated closed captions.\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"
},
"allowed_privacies": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of privacy settings supported for this event and the requesting user."
},
"auto_cc_remaining": {
"type": "number",
"nullable": true,
"description": "The amount of time remaining to the user to access the automated closed captions feature."
},
"live_destinations": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true,
"description": "_This field is deprecated in favor of the following method:_ [Get all the destinations of a one-time live event](https://developer.vimeo.com/api/reference/live#get_one_time_event_destinations)."
},
"unlimited_auto_cc": {
"type": "boolean",
"nullable": true,
"description": "Whether to ignore the time limit of the automated closed captions feature."
},
"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",
"nullable": true,
"description": "The description of the next video streamed to the event."
},
"unlimited_duration": {
"type": "boolean",
"example": true,
"description": "Whether 24/7 streaming is enabled for the event."
},
"whitelisted_domains": {
"type": "array",
"items": {
"type": "object",
"required": [
"allow_hd",
"domain",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/videos/258684937/privacy/domains/example.com",
"description": "The URI of the domain."
},
"domain": {
"type": "string",
"example": "example.com",
"description": "The domain name."
},
"allow_hd": {
"type": "boolean",
"example": true,
"description": "Whether to permit HD embeds on this domain."
}
}
},
"nullable": true,
"description": "The domains on a video's whitelist."
},
"next_occurrence_time": {
"type": "string",
"example": "2018-07-30T14:00:00+00:00",
"nullable": true,
"description": "The date in ISO 8601 format on which the next occurrence of the event is expected to be live."
},
"preferred_stream_method": {
"enum": [
"browser",
"encoder"
],
"type": "string",
"example": "encoder",
"description": "The preferred streaming method.\n\nOption descriptions:\n * `browser` - Stream in the browser.\n * `encoder` - Stream by the encoder.\n"
},
"automatically_title_stream": {
"type": "boolean",
"example": true,
"description": "When the value of this field is `true`, 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": "array",
"items": {
"type": "object",
"required": [
"is_anonymous_questions_disabled",
"is_qna_moderated"
],
"properties": {
"is_qna_moderated": {
"type": "boolean",
"description": "Whether the Q&A is moderated for the interaction tools settings."
},
"is_anonymous_questions_disabled": {
"type": "boolean",
"description": "Whether anonymous questions are disabled for the interaction tools settings."
}
}
},
"nullable": true,
"description": "The settings for the interaction tools."
}
},
"x-konfig-properties": {
"user": {
"description": "The owner of the event."
},
"pictures": {
"description": "The active thumbnail image of the event."
},
"schedule": {
"description": "The description of the time or times that the event is expected to be live."
}
}
}
live-event-schedule
{
"type": "object",
"title": "Live Event Schedule",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"single",
"weekly"
],
"type": "string",
"example": "weekly",
"description": "The schedule of the live event.\n\nOption descriptions:\n * `single` - The event is live only once.\n * `weekly` - The event is live on a recurring weekly basis.\n"
},
"rrule": {
"type": "string",
"description": "The recurrence rule for the event's schedule according to [RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545)."
},
"end_time": {
"type": "string",
"example": "2018-06-21T14:00:00+00:00",
"description": "The time in ISO 8601 format when the live event is expected to end."
},
"weekdays": {
"type": "array",
"items": {
"type": "string"
},
"description": "When **schedule.type** is `weekly`, the weekdays in UTC when the event is expected to be live. The value of this field ranges from `1` to `7`, where `1` is Monday and `7` is Sunday."
},
"time_zone": {
"type": "string",
"description": "The time zone of the live event."
},
"daily_time": {
"type": "string",
"example": "14:00:00Z",
"description": "When **schedule.type** is `weekly`, the time in ISO 8601 format when the event is expected to be live."
},
"start_time": {
"type": "string",
"example": "2018-06-21T14:00:00+00:00",
"description": "The time in ISO 8601 format when the live event is expected to be live."
},
"scheduled_time": {
"type": "string",
"example": "2018-06-21T14:00:00+00:00",
"description": "When **schedule.type** is `weekly`, the time in ISO 8601 format when the first occurrence of the event is expected to be live."
}
}
}
live-event-session-status
{
"type": "object",
"title": "Live Event Session Status",
"required": [
"archive",
"can_manage",
"id",
"ingest",
"metering",
"status",
"stream_mode"
],
"properties": {
"id": {
"type": "number",
"example": 1111,
"description": "The ID of the live video."
},
"ingest": {
"type": "object",
"required": [
"encoder_type",
"end_time",
"height",
"is_rtmp_session",
"is_scheduled_playback",
"rtmp_expires_at",
"rtmp_link",
"rtmps_link",
"scheduled_start_time",
"session_id",
"start_time",
"status",
"stream_ended_reason",
"stream_key",
"width"
],
"properties": {
"width": {
"type": "number",
"example": 100,
"nullable": true,
"description": "The width of the live video in pixels."
},
"height": {
"type": "number",
"example": 100,
"nullable": true,
"description": "The height of the live video in pixels."
},
"status": {
"enum": [
0,
1,
2,
3,
4,
5
],
"type": "integer",
"example": "1",
"nullable": true,
"description": "The ingest status of the live video.\n\nOption descriptions:\n * `0` - There’s a live video, but no RMTP URL or key.\n * `1` - There’s an RMTP URL and key, but the machine is provisioning.\n * `2` - There’s an RMTP URL and key, and the machine is provisioned, but the stream hasn’t started yet.\n * `3` - There’s an RMTP URL and key, and the machine is provisioned, but the stream didn’t start before the machine timed out.\n * `4` - The stream has started and is currently underway.\n * `5` - The stream has ended.\n"
},
"end_time": {
"type": "number",
"example": 1612451704,
"nullable": true,
"description": "The timestamp in UTC format when the live stream ended."
},
"rtmp_link": {
"type": "string",
"example": "rtmp://rtmp.cloud.vimeo.com/live",
"nullable": true,
"description": "The upstream RTMP link. Send your live content to this link to create a live video on the event."
},
"rtmps_link": {
"type": "string",
"example": "rtmps://rtmp.cloud.vimeo.com/live",
"nullable": true,
"description": "The upstream RTMPS link. Send your live content to this secure link to create a live video on the event."
},
"session_id": {
"type": "string",
"nullable": true,
"description": "The session ID."
},
"start_time": {
"type": "number",
"example": 1612451704,
"nullable": true,
"description": "The timestamp in UTC format when the live video started."
},
"stream_key": {
"type": "string",
"example": "ab9c8def-7a65-4321-b098-c7dd65e43f21",
"nullable": true,
"description": "The stream key used in conjunction with the RTMP and RTMPS links."
},
"encoder_type": {
"enum": [
"dash",
"rtmp",
"simple_live",
"studio_cloud",
"unknown",
"webrtc"
],
"type": "string",
"example": "rtmp",
"description": "The protocol used for this session.\n\nOption descriptions:\n * `dash` - The protocol is DASH.\n * `rtmp` - The protocol is RTMP.\n * `simple_live` - The protocol is Simplelive.\n * `studio_cloud` - The protocol is StudioCloud.\n * `unknown` - The protocol is unknown or not set.\n * `webrtc` - The protocol is WebRTC.\n"
},
"is_rtmp_session": {
"type": "boolean",
"example": true,
"description": "Whether the session is using RTMP."
},
"rtmp_expires_at": {
"type": "string",
"example": "2018-07-30T14:00:00+00:00",
"nullable": true,
"description": "The time in ISO 8601 format when the RTMP expires."
},
"stream_ended_reason": {
"type": "number",
"nullable": true,
"description": "The reason why the stream ended. If the stream hasn't ended, this field is empty."
},
"scheduled_start_time": {
"type": "string",
"example": "2018-07-30T14:00:00+00:00",
"nullable": true,
"description": "The scheduled start time of the live video in ISO 8601 format."
},
"is_scheduled_playback": {
"type": "boolean",
"example": true,
"nullable": true,
"description": "Whether the stream is scheduled media playback."
}
},
"description": "The ingest of the video."
},
"status": {
"enum": [
"ended",
"started"
],
"type": "string",
"example": "started",
"nullable": true,
"description": "The status of the live event.\n\nOption descriptions:\n * `ended` - The live event has ended.\n * `started` - The live event has started.\n"
},
"archive": {
"type": "object",
"required": [
"clip_id",
"status"
],
"properties": {
"status": {
"type": "number",
"example": 0,
"nullable": true,
"description": "The status of the archive data."
},
"clip_id": {
"type": "number",
"example": 1111,
"description": "The ID of the archived video."
}
},
"description": "Information about the archive data."
},
"metering": {
"type": "object",
"required": [
"seconds_max",
"seconds_remaining"
],
"properties": {
"seconds_max": {
"type": "number",
"example": 0,
"description": "The maximum number of seconds."
},
"seconds_remaining": {
"type": "number",
"example": 0,
"description": "The number of seconds remaining."
}
},
"description": "The metering status of the live video."
},
"can_manage": {
"type": "boolean",
"example": true,
"description": "Whether the current user can manage the event."
},
"stream_mode": {
"enum": [
"live",
"record",
"simulive"
],
"type": "string",
"example": "live",
"description": "The stream mode of the event.\n\nOption descriptions:\n * `live` - The stream is live playback.\n * `record` - The stream is in record mode.\n * `simulive` - The stream is scheduled media playback.\n"
}
}
}
location
{
"type": "object",
"title": "Location",
"required": [
"city",
"country",
"country_iso_code",
"formatted_address",
"latitude",
"longitude",
"neighborhood",
"state",
"state_iso_code",
"sub_locality"
],
"properties": {
"city": {
"type": "string",
"example": "New York City",
"nullable": true,
"description": "The authenticated user's city."
},
"state": {
"type": "string",
"example": "New York",
"nullable": true,
"description": "The authenticated user's state."
},
"country": {
"type": "string",
"example": "United States",
"nullable": true,
"description": "The authenticated user's country."
},
"latitude": {
"type": "number",
"example": 20.2960586,
"description": "The authenticated user's latitude."
},
"longitude": {
"type": "number",
"example": 185.8245392,
"description": "The authenticated user's longitude."
},
"neighborhood": {
"type": "string",
"example": "Brooklyn",
"nullable": true,
"description": "The authenticated user's neighborhood."
},
"sub_locality": {
"type": "string",
"example": "Brooklyn",
"nullable": true,
"description": "The authenticated user's sub-locality."
},
"state_iso_code": {
"type": "string",
"example": "NY",
"nullable": true,
"description": "The ISO code of the authenticated user's state."
},
"country_iso_code": {
"type": "string",
"example": "US",
"description": "The ISO code of the authenticated user's country."
},
"formatted_address": {
"type": "string",
"example": "123 Street, NY",
"description": "The authenticated user's formatted address string."
}
}
}
money
{
"type": "object",
"title": "Money",
"required": [
"amount",
"currency",
"formatted",
"unit"
],
"properties": {
"unit": {
"type": "number",
"example": 1200,
"description": "The amount expressed as a numeral in the lowest denomination. For example, 12 USD is expressed as 1200."
},
"amount": {
"type": "number",
"example": 12,
"description": "The amount expressed as a numeral without currency formatting."
},
"currency": {
"type": "string",
"example": "USD",
"description": "The currency in which the amount is expressed."
},
"formatted": {
"type": "string",
"example": "$12",
"description": "The amount expressed as a numeral with currency formatting."
}
}
}
on-demand-genre
{
"type": "object",
"title": "On Demand Genre",
"required": [
"canonical",
"interactions",
"link",
"metadata",
"name",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/ondemand/genres/horror",
"description": "The relative URI of the On Demand genre."
},
"link": {
"type": "string",
"example": "http://vimeo.com/ondemand/browse/horror",
"description": "The Vimeo URL for the genre."
},
"name": {
"type": "string",
"example": "Horror",
"description": "The descriptive name of the genre."
},
"metadata": {
"type": "object",
"required": [
"connections"
],
"properties": {
"connections": {
"type": "object",
"required": [
"pages"
],
"properties": {
"pages": {
"type": "object",
"required": [
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/ondemand/genres/horror/pages",
"description": "The API URI that resolves to the connection data."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the On Demand pages related to this group."
}
},
"description": "A collection of information connected to this resource."
}
}
},
"canonical": {
"type": "string",
"example": "horror",
"description": "The canonical name or URL slug of the genre."
},
"interactions": {
"type": "object",
"required": [
"page"
],
"properties": {
"page": {
"type": "object",
"required": [
"added",
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/ondemand/genres/horror/pages/12345",
"description": "The URI to access the On Demand page."
},
"added": {
"type": "boolean",
"example": true,
"description": "Whether the On Demand genre was added."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Interactions for On Demand pages that belong to the genre."
}
}
}
}
}
on-demand-page
{
"type": "object",
"title": "On Demand Page",
"required": [
"background",
"colors",
"content_rating",
"description",
"domain_link",
"episodes",
"genres",
"link",
"metadata",
"name",
"pictures",
"preorder",
"published",
"rating",
"resource_key",
"subscription",
"theme",
"thumbnail",
"trailer",
"type",
"uri",
"user"
],
"properties": {
"sku": {
"type": "string",
"example": "VIME0001",
"nullable": true,
"description": "The creator-designated SKU for the On Demand page."
},
"uri": {
"type": "string",
"example": "/ondemand/pages/61326",
"description": "The relative URI of the On Demand page."
},
"film": {
"$ref": "#/components/schemas/video"
},
"link": {
"type": "string",
"example": "https://vimeo.com/ondemand/darbyforever",
"description": "The link to the On Demand page."
},
"name": {
"type": "string",
"example": "Darby Forever",
"description": "The descriptive title of the On Demand page."
},
"type": {
"enum": [
"film",
"series"
],
"type": "string",
"example": "film",
"description": "Whether the On Demand page is for a film or a series.\n\nOption descriptions:\n * `film` - The On Demand page is for a film.\n * `series` - The On Demand page is for a series.\n"
},
"user": {
"allOf": [
{
"$ref": "#/components/schemas/user"
}
],
"nullable": true,
"description": "The user who created the On Demand page."
},
"theme": {
"type": "string",
"example": "vader",
"description": "The graphical theme for the On Demand page."
},
"colors": {
"type": "object",
"required": [
"primary",
"secondary"
],
"properties": {
"primary": {
"type": "string",
"example": "#0a0808",
"description": "The hexadecimal color code for the On Demand page's first color."
},
"secondary": {
"type": "string",
"example": "#ba4a17",
"description": "The hexadecimal color code for the On Demand page's second color."
}
},
"description": "The first and second colors of the On Demand page."
},
"genres": {
"type": "array",
"items": {
"$ref": "#/components/schemas/on-demand-genre"
},
"description": "An array of the genres assigned to the On Demand page."
},
"rating": {
"type": "number",
"example": 7,
"nullable": true,
"description": "The rating of the On Demand page."
},
"trailer": {
"allOf": [
{
"$ref": "#/components/schemas/video"
}
],
"nullable": true,
"description": "The trailer for the On Demand page."
},
"episodes": {
"type": "object",
"required": [
"buy",
"rent"
],
"properties": {
"buy": {
"type": "object",
"required": [
"active",
"price"
],
"properties": {
"price": {
"type": "number",
"example": 9.99,
"nullable": true,
"description": "The default price to buy an episode."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether all the videos on the On Demand page can be purchased as a whole."
}
}
},
"rent": {
"type": "object",
"required": [
"active",
"period",
"price"
],
"properties": {
"price": {
"type": "number",
"example": 2.99,
"nullable": true,
"description": "The default price to rent an episode."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether all the videos on the On Demand page can be rented as a whole."
},
"period": {
"enum": [
"1 day",
"1 month",
"1 week",
"1 year",
"2 day",
"24 hour",
"3 day",
"3 month",
"30 day",
"48 hour",
"6 month",
"60 day",
"7 day",
"72 hour"
],
"type": "string",
"example": "1 day",
"nullable": true,
"description": "The rental period for the video.\n\nOption descriptions:\n * `1 day` - The rental period is one day.\n * `1 month` - The rental period is one month.\n * `1 week` - The rental period is one week.\n * `1 year` - The rental period is one year.\n * `2 day` - The rental period is two days.\n * `24 hour` - The rental period is 24 hours.\n * `3 day` - The rental period is three days.\n * `3 month` - The rental period is three months.\n * `30 day` - The rental period is 30 days.\n * `48 hour` - The rental period is 48 hours.\n * `6 month` - The rental period is six months.\n * `60 day` - The rental period is 60 days.\n * `7 day` - The rental period is 7 days.\n * `72 hour` - The rental period is 72 hours.\n"
}
}
}
},
"description": "Information about the On Demand page's episodes, if the page is for a series."
},
"metadata": {
"type": "object",
"required": [
"connections",
"interactions"
],
"properties": {
"connections": {
"type": "object",
"required": [
"metadata"
],
"properties": {
"metadata": {
"type": "object",
"required": [
"connections"
],
"properties": {
"connections": {
"type": "object",
"required": [
"comments",
"genres",
"likes",
"pictures",
"seasons",
"videos"
],
"properties": {
"likes": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/ondemand/pages/61326/likes",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 15,
"description": "The total number of likes on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the likes associated with the On Demand page."
},
"genres": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/ondemand/pages/61326/genres",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 9,
"description": "The total number of genres on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the genres associated with the On Demand page."
},
"videos": {
"type": "object",
"required": [
"extra_total",
"main_total",
"options",
"total",
"uri",
"viewable_total"
],
"properties": {
"uri": {
"type": "string",
"example": "/ondemand/pages/61326/videos",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 50,
"description": "The total number of videos on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
},
"main_total": {
"type": "number",
"example": 36,
"description": "The total number of main videos on the On Demand page."
},
"extra_total": {
"type": "number",
"example": 14,
"description": "The total number of extra videos on the On Demand page."
},
"viewable_total": {
"type": "number",
"example": 50,
"description": "The total number of viewable videos on the On Demand page."
}
},
"description": "Information about the videos associated with the On Demand page."
},
"seasons": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/ondemand/pages/61326/seasons",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 3,
"description": "The total number of seasons on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the seasons associated with the On Demand page."
},
"comments": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/ondemand/pages/61326/comments",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 4,
"description": "The total number of comments on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the comments associated with the On Demand page."
},
"pictures": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/ondemand/pages/61326/pictures",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 3,
"description": "The total number of pictures on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the pictures associated with the On Demand page."
}
}
}
}
}
},
"description": "A collection of information that is connected to this resource, including videos, genres, and pictures connections."
},
"interactions": {
"$ref": "#/components/schemas/purchase-interaction"
}
},
"description": "Metadata about the On Demand page.",
"x-konfig-properties": {
"interactions": {
"description": "The user's available purchase interactions."
}
}
},
"pictures": {
"allOf": [
{
"$ref": "#/components/schemas/picture"
}
],
"nullable": true,
"description": "The active poster for the On Demand page."
},
"preorder": {
"type": "object",
"required": [
"active",
"cancel_time",
"publish_time",
"time"
],
"properties": {
"time": {
"type": "string",
"example": "2017-05-15T13:13:31+00:00",
"description": "The time in ISO 8601 format when the preorder started."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether the On Demand page is available for preorder."
},
"cancel_time": {
"type": "string",
"example": "2017-05-16T13:13:46+00:00",
"description": "The time in ISO 8601 format when the preorder was cancelled."
},
"publish_time": {
"type": "string",
"example": "2017-05-15T13:12:52+00:00",
"description": "The time in ISO 8601 format when the preorder was released to the public."
}
}
},
"published": {
"type": "object",
"required": [
"enabled",
"time"
],
"properties": {
"time": {
"type": "string",
"example": "2017-05-15T13:12:52+00:00",
"description": "The time in ISO 8601 format when this page was published."
},
"enabled": {
"type": "boolean",
"example": true,
"description": "Whether the On Demand page has been published."
}
}
},
"thumbnail": {
"allOf": [
{
"$ref": "#/components/schemas/picture"
}
],
"nullable": true,
"description": "The thumbnail image for the On Demand page."
},
"background": {
"allOf": [
{
"$ref": "#/components/schemas/picture"
}
],
"nullable": true,
"description": "The background image for the On Demand page."
},
"description": {
"type": "string",
"example": "DARBY FOREVER follows the fantasies of Darby, a shopgirl at \"Bobbins & Notions\"",
"nullable": true,
"description": "The description of the On Demand page."
},
"domain_link": {
"type": "string",
"example": "https://example.com",
"nullable": true,
"description": "The link to the On Demand page on its own domain."
},
"created_time": {
"type": "string",
"example": "2017-05-15T13:42:25+00:00",
"description": "The time in ISO 8601 format when the On Demand page was created."
},
"resource_key": {
"type": "string",
"example": "bac1033deba2310ebba2caec33c23e4beea67aba",
"description": "The On Demand resource key."
},
"subscription": {
"type": "object",
"nullable": true,
"required": [
"active",
"link",
"price"
],
"properties": {
"link": {
"type": "string",
"example": "https://vimeo.com/ondemand/darbyforever",
"nullable": true,
"description": "The link to the On Demand product."
},
"price": {
"type": "object",
"description": "The accepted currencies and respective pricing for the On Demand product."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether the On Demand product is active."
},
"period": {
"type": "string",
"description": "The On Demand product's rental period."
}
},
"description": "Information about subscribing to the On Demand page, if subscription is enabled."
},
"modified_time": {
"type": "string",
"example": "2017-05-15T13:42:25+00:00",
"description": "The time in ISO 8601 format when the On Demand page was last modified."
},
"content_rating": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the On Demand page's content ratings."
}
},
"x-konfig-properties": {
"film": {
"description": "The On Demand page's film, if the page is for a film."
}
}
}
on-demand-promotion
{
"type": "object",
"title": "On Demand Promotion",
"required": [
"access_type",
"discount_type",
"download",
"label",
"metadata",
"percent_off",
"product_type",
"stream_period",
"total",
"type",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/ondemand/pages/61326/promotions/12345",
"description": "The promotion's canonical relative URI."
},
"type": {
"enum": [
"batch",
"batch_prefix",
"single"
],
"type": "string",
"example": "batch",
"description": "The way in which the promotion generates promo codes.\n\nOption descriptions:\n * `batch` - The promotion provides a unique promo code for each user.\n * `batch_prefix` - Like `batch`, except that all codes have a similar prefix string. _This option is deprecated, yet it may still appear for some users._\n * `single` - The promotion provides a single promo code for all users.\n"
},
"label": {
"type": "string",
"example": "8jgaieumbzstujhn8k304iwwezawkvwm",
"nullable": true,
"description": "The prefix string for batch codes, or the null value for single codes."
},
"total": {
"type": "number",
"example": 1,
"description": "When **type** is `single`, the total number of times that the promotion can be used. When **type** is `batch` or `batch_prefix`, the total number of promo codes that have been generated."
},
"download": {
"type": "boolean",
"example": true,
"description": "Whether the promotion grants download access to On Demand content."
},
"metadata": {
"type": "object",
"required": [
"connections"
],
"properties": {
"connections": {
"type": "object",
"required": [
"codes"
],
"properties": {
"codes": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/ondemand/pages/61326/promotion/12345/codes",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 1,
"description": "The total number of uses on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the codes associated with the promotion."
}
},
"description": "A list of resource URIs related to the promotion."
}
},
"description": "The video's metadata."
},
"access_type": {
"enum": [
"default",
"vip"
],
"type": "string",
"example": "default",
"description": "The type of access that the promotion grants.\n\nOption descriptions:\n * `default` - The promotion grants discounts on existing product offerings.\n * `vip` - The promotion grants free access to On Demand content before it's released, or to access types that aren't part of the existing product offerings.\n"
},
"percent_off": {
"type": "number",
"example": 100,
"description": "When **discount_type** is `percent`, the percentage amount that is deducted from the product price."
},
"product_type": {
"enum": [
"any",
"buy",
"buy_episode",
"rent",
"rent_episode",
"subscribe"
],
"type": "string",
"example": "any",
"description": "The type of product to which the promotion can be applied. Only the `buy` and `rent` options are available when **access_type** is `vip`.\n\nOption descriptions:\n * `any` - The promotion can be applied to any product.\n * `buy` - The promotion can be applied to a buyable single video.\n * `buy_episode` - The promotion can be applied to a buyable single episode.\n * `rent` - The promotion can be applied to a rentable single video.\n * `rent_episode` - The promotion can be applied to a rentable single episode.\n * `subscribe` - The promotion can be applied to a subscription.\n"
},
"discount_type": {
"enum": [
"dollars",
"free",
"percent"
],
"type": "string",
"example": "free",
"description": "The type of discount that the promotion provides.\n\nOption descriptions:\n * `dollars` - The promotion discounts a fixed amount from the full purchase price.\n * `free` - The promotion discounts the full purchase price. When **access_type** is `vip`, **discount_type** is always `free`.\n * `percent` - The promotion discounts a percentage of the full purchase price.\n"
},
"stream_period": {
"enum": [
"1_week",
"1_year",
"24_hour",
"30_days",
"3_month",
"48_hour",
"6_month",
"72_hour"
],
"type": "string",
"example": "1_week",
"nullable": true,
"description": "The amount of time that the user has access to the On Demand content after redeeming a promo code.\n\nOption descriptions:\n * `1_week` - Access lasts for one week.\n * `1_year` - Access lasts for one year.\n * `24_hour` - Access lasts for 24 hours.\n * `30_days` - Access lasts for 30 days.\n * `3_month` - Access lasts for three months.\n * `48_hour` - Access lasts for 48 hours.\n * `6_month` - Access lasts for six months.\n * `72_hour` - Access lasts for 72 hours.\n"
}
}
}
on-demand-promotion-code
{
"type": "object",
"title": "On Demand Promotion Code",
"required": [
"code",
"link",
"max_uses",
"uses"
],
"properties": {
"code": {
"type": "string",
"example": "8jgaieumbzstujhn8k304iwwezawkvwm",
"description": "The Vimeo promotion code."
},
"link": {
"type": "string",
"example": "https://vimeo.com/r/0trBLg/OGpnYWlldW",
"description": "The link to redeem the promotion code."
},
"uses": {
"type": "number",
"example": 0,
"description": "The current number of times that this code has been used."
},
"max_uses": {
"type": "number",
"example": 1,
"description": "The total number of times that this code can be used."
}
}
}
on-demand-region
{
"type": "object",
"title": "On Demand Region",
"required": [
"country_code",
"country_name",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/ondemand/pages/61326/regions/US",
"description": "The region container's relative URI."
},
"country_code": {
"type": "string",
"example": "US",
"description": "The ISO 3166-1 alpha-2 code for this country."
},
"country_name": {
"type": "string",
"example": "United States",
"description": "The descriptive name of this country."
}
}
}
on-demand-season
{
"type": "object",
"title": "On Demand Season",
"required": [
"description",
"metadata",
"name",
"position",
"resource_key",
"type",
"uri",
"user"
],
"properties": {
"uri": {
"type": "string",
"example": "/ondemand/pages/61326/seasons/12345",
"description": "The season container's relative URI."
},
"name": {
"type": "string",
"example": "Season 1",
"description": "The name of the season."
},
"type": {
"type": "string",
"example": "main",
"description": "The type of the season."
},
"user": {
"allOf": [
{
"$ref": "#/components/schemas/user"
}
],
"nullable": true,
"description": "The creator of the season's On Demand page."
},
"metadata": {
"type": "object",
"required": [
"connections"
],
"properties": {
"connections": {
"type": "object",
"required": [
"videos"
],
"properties": {
"videos": {
"type": "object",
"required": [
"options",
"total",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/ondemand/pages/61326/season/12345/videos",
"description": "The API URI that resolves to the connection data."
},
"total": {
"type": "number",
"example": 13,
"description": "The total number of videos on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "The connection to the associated videos."
}
}
}
}
},
"position": {
"type": "number",
"example": 1,
"description": "The position of the season relative to other seasons in the series."
},
"description": {
"type": "string",
"example": "Season 1",
"description": "The description of the season."
},
"resource_key": {
"type": "string",
"example": "bac1033deba2310ebba2caec33c23e4beea67aba",
"description": "The unique identifier of the On Demand season."
}
}
}
on-demand-video
{
"type": "object",
"title": "On Demand Video",
"required": [
"buy",
"interactions",
"link",
"metadata",
"play_progress",
"release_year",
"rent",
"type",
"uri"
],
"properties": {
"buy": {
"type": "object",
"nullable": true,
"required": [
"active",
"price"
],
"properties": {
"price": {
"type": "object",
"description": "A map of currency type to price."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether the video can be purchased."
},
"purchased": {
"type": "boolean",
"example": true,
"description": "Whether the video has been purchased."
}
},
"description": "Information about purchasing the video."
},
"uri": {
"type": "string",
"example": "/ondemand/pages/61326/videos/12345",
"description": "The video container's relative URI."
},
"link": {
"type": "string",
"example": "https://vimeo.com/ondemand/darbyforever/12345",
"description": "The link to the video on Vimeo."
},
"name": {
"type": "string",
"example": "Darby Forever",
"description": "The title of the video."
},
"rent": {
"type": "object",
"nullable": true,
"required": [
"active",
"price"
],
"properties": {
"price": {
"type": "object",
"description": "A map of currency type to price."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether the video can be rented."
},
"purchased": {
"type": "boolean",
"example": true,
"description": "Whether the video has been rented."
}
},
"description": "Information about renting the video."
},
"type": {
"enum": [
"extra",
"main",
"trailer"
],
"type": "string",
"example": "main",
"description": "The type of video.\n\nOption descriptions:\n * `extra` - The video is an extra feature.\n * `main` - The video is a main feature.\n * `trailer` - The video is a trailer.\n"
},
"user": {
"$ref": "#/components/schemas/user"
},
"episode": {
"type": "number",
"example": 1,
"description": "The episode number of the video."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
},
"duration": {
"type": "string",
"example": "1197",
"description": "The duration of the video."
},
"metadata": {
"type": "object",
"required": [
"connections",
"interactions"
],
"properties": {
"connections": {
"type": "object",
"required": [
"season"
],
"properties": {
"season": {
"type": "object",
"required": [
"name",
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/ondemand/pages/61326/seasons/12345",
"description": "The API URI that resolves to the connection data."
},
"name": {
"type": "string",
"example": "Season 1",
"description": "The name of the season on this connection."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about the video's season."
}
}
},
"interactions": {
"type": "object",
"required": [
"likes",
"watchlater"
],
"properties": {
"likes": {
"type": "object",
"required": [
"added",
"added_time",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/users/152184/likes/12345",
"description": "The URI for the authenticated user to like the video."
},
"added": {
"type": "boolean",
"example": true,
"description": "Whether the authenticated user has liked the video."
},
"added_time": {
"type": "string",
"example": "2017-05-12T21:42:42+00:00",
"description": "The time in ISO 8601 format when the authenticated user liked the video."
}
},
"description": "Information about the authenticated user's interaction to like the video."
},
"watchlater": {
"type": "object",
"required": [
"added",
"added_time",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/users/152184/watchlater/12345",
"description": "The URI for the authenticated user to add the video to their Watch Later queue."
},
"added": {
"type": "boolean",
"example": true,
"description": "Whether the authenticated user has added the video to their Watch Later queue."
},
"added_time": {
"type": "string",
"example": "2017-05-12T21:42:42+00:00",
"description": "The time in ISO 8601 format when the authenticated user added the video to their Watch Later queue."
}
},
"description": "Information about the authenticated user's interaction to watch the video later."
}
}
}
},
"description": "Metadata information about the video."
},
"pictures": {
"$ref": "#/components/schemas/picture"
},
"position": {
"type": "number",
"example": 1,
"description": "The position of the video relative to the other videos on the On Demand page."
},
"description": {
"type": "string",
"example": "This video provides in-depth instruction in the use of the Vimeo API.",
"description": "The description of the video."
},
"interactions": {
"type": "object",
"required": [
"page"
],
"properties": {
"page": {
"type": "object",
"required": [
"added",
"options",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/ondemand/pages/61326",
"description": "The URI to access the On Demand page."
},
"added": {
"type": "boolean",
"example": true,
"description": "Whether the On Demand page was added."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of HTTP methods permitted on this URI."
}
},
"description": "Information about how the authenticated user can interact with the connection to the video's On Demand page."
}
},
"description": "An object containing information about how the authenticated user can interact with the video's On Demand page."
},
"release_date": {
"type": "string",
"example": "2017-05-12T21:06:42+00:00",
"description": "The time in ISO 8601 format when the video was created or published."
},
"release_year": {
"type": "number",
"example": 2016,
"nullable": true,
"description": "The year that the video was released."
},
"play_progress": {
"type": "number",
"example": 30,
"description": "The authenticated user's most recent play position in the video, in seconds."
}
},
"x-konfig-properties": {
"user": {
"description": "The owner of the video."
},
"pictures": {
"description": "The active picture of the video."
}
}
}
ott-destination
{
"type": "object",
"title": "OTT Destination",
"required": [
"id",
"ott_channel_id",
"ott_channel_name",
"ott_channel_subdomain",
"ott_event_id",
"recurring_live_event_id"
],
"properties": {
"id": {
"type": "string",
"example": "/ott/destination/1111",
"description": "The OTT destination's canonical relative URI."
},
"ott_event_id": {
"type": "number",
"example": 1111,
"description": "The ID of the OTT event."
},
"ott_channel_id": {
"type": "number",
"example": 1111,
"description": "The ID of the OTT channel."
},
"ott_channel_name": {
"type": "string",
"example": "Channel One",
"description": "The name of the OTT channel."
},
"ott_channel_subdomain": {
"type": "string",
"example": "subdomain",
"description": "The subdomain of the OTT channel."
},
"recurring_live_event_id": {
"type": "number",
"example": 1111,
"description": "The ID of the current recurring live event."
}
}
}
payment-method
{
"type": "object",
"title": "Payment Method",
"required": [
"account_id",
"created_at",
"disabled_at",
"id",
"is_default",
"type",
"updated_at"
],
"properties": {
"id": {
"type": "string",
"example": "abc12345",
"description": "The ID of the payment method."
},
"card": {
"type": "object",
"properties": {
"bin": {
"type": "string",
"example": "123456",
"description": "The bank identification number of the card."
},
"brand": {
"type": "string",
"example": "Visa",
"description": "The brand of the card."
},
"billing_address": {
"type": "object",
"properties": {
"city": {
"type": "string",
"example": "New York",
"description": "The city of the billing address."
},
"state": {
"type": "string",
"example": "NY",
"description": "The state of the billing address."
},
"address": {
"type": "string",
"example": "123 Main St.",
"description": "The street address of the billing address."
},
"country": {
"type": "string",
"example": "US",
"description": "The country of the billing address."
},
"postal_code": {
"type": "string",
"example": "10001",
"description": "The postal code of the billing address."
}
},
"description": "The billing address of the card."
},
"cardholder_name": {
"type": "string",
"example": "John Doe",
"description": "The name of the cardholder."
},
"expiration_year": {
"type": "number",
"example": 2020,
"description": "The expiration year of the card."
},
"expiration_month": {
"type": "number",
"example": 1,
"description": "The expiration month of the card."
},
"last_four_digits": {
"type": "string",
"example": "1234",
"description": "The last four digits of the card."
}
},
"description": "Information about the card used to make the payment."
},
"type": {
"enum": [
"PAYMENT_METHOD_TYPES_APPLEPAY",
"PAYMENT_METHOD_TYPES_BANK_ACCOUNT",
"PAYMENT_METHOD_TYPES_CARD",
"PAYMENT_METHOD_TYPES_GOOGLEPAY",
"PAYMENT_METHOD_TYPES_PAYPAL",
"PAYMENT_METHOD_TYPES_TYPES_UNSPECIFIED"
],
"type": "string",
"example": "PAYMENT_METHOD_TYPES_CARD",
"description": "The type of payment method.\n\nOption descriptions:\n * `PAYMENT_METHOD_TYPES_APPLEPAY` - The payment method is Apple Pay.\n * `PAYMENT_METHOD_TYPES_BANK_ACCOUNT` - The payment method is a bank account.\n * `PAYMENT_METHOD_TYPES_CARD` - The payment method is a card.\n * `PAYMENT_METHOD_TYPES_GOOGLEPAY` - The payment method is Google Pay.\n * `PAYMENT_METHOD_TYPES_PAYPAL` - The payment method is a PayPal account.\n * `PAYMENT_METHOD_TYPES_TYPES_UNSPECIFIED` - The payment method type is unspecified.\n"
},
"account_id": {
"type": "string",
"example": "abc12345",
"description": "The ID of the account."
},
"created_at": {
"type": "string",
"example": "2019-01-01T00:00:00+00:00",
"description": "The time when the payment method was created."
},
"is_default": {
"type": "boolean",
"example": true,
"description": "Whether the payment method is the default payment method for the account."
},
"updated_at": {
"type": "string",
"example": "2019-01-01T00:00:00+00:00",
"description": "The time when the payment method was last updated."
},
"disabled_at": {
"type": "string",
"example": "2019-01-01T00:00:00+00:00",
"description": "The time when the payment method was disabled."
}
}
}
permission-policy
{
"type": "object",
"title": "Permission Policy",
"required": [
"created_on",
"display_description",
"display_name",
"modified_on",
"name",
"permission_actions",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/users/12345/permission_policies/56789",
"description": "The URI of the permission policy."
},
"name": {
"type": "string",
"description": "The name of the permission policy."
},
"created_on": {
"type": "string",
"description": "The time at which the permission policy was created."
},
"modified_on": {
"type": "string",
"nullable": true,
"description": "The time at which the permission policy was last modified."
},
"display_name": {
"type": "string",
"description": "The display name of the permission policy, translated where applicable."
},
"permission_actions": {
"type": "object",
"description": "The permission actions associated with the policy."
},
"display_description": {
"type": "string",
"description": "The display description of the permission policy, translated where applicable."
}
}
}
picture
{
"type": "object",
"title": "Picture",
"required": [
"active",
"base_link",
"default_picture",
"resource_key",
"sizes",
"type",
"uri"
],
"properties": {
"uri": {
"type": "string",
"example": "/users/152184/pictures/12345",
"description": "The URI of the picture."
},
"link": {
"type": "string",
"description": "The upload URL of the picture. This field appears upon the initial creation of a picture resource."
},
"type": {
"enum": [
"caution",
"custom",
"default"
],
"type": "string",
"example": "caution",
"description": "The type of picture.\n\nOption descriptions:\n * `caution` - The picture isn't appropriate for all ages.\n * `custom` - The picture is a custom video image.\n * `default` - The picture is the default video image.\n"
},
"sizes": {
"type": "array",
"items": {
"type": "object",
"required": [
"height",
"link",
"width"
],
"properties": {
"link": {
"type": "string",
"example": "https://i.vimeocdn.com/video/581495283_1280x720?r=pad&subrect=0,12,21,22&r=cover",
"description": "The direct link to the image file. For information about the format of the image file, see our [Working with Thumbnail Uploads](https://developer.vimeo.com/api/upload/thumbnails#returning-the-link-to-a-thumbnail) guide."
},
"width": {
"type": "number",
"example": 1280,
"description": "The width of the picture."
},
"height": {
"type": "number",
"example": 720,
"nullable": true,
"description": "The height of the picture."
},
"link_with_play_button": {
"type": "string",
"example": "https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F581495283_1280x720&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png",
"description": "The direct link to the image file with a play button overlay. For information about the format of the image file, see our [Working with Thumbnail Uploads](https://developer.vimeo.com/api/upload/thumbnails#returning-the-link-to-a-thumbnail) guide."
}
}
},
"description": "An array containing reference information about all available image files."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether the picture is currently active."
},
"base_link": {
"type": "string",
"example": "https://i.vimeocdn.com/video/1130929417-276se668248611ce41e6f7d438196e3412863bad9a5c3bcaf1a14453454cc5-d",
"description": "The base link to the image file, without any parameters."
},
"resource_key": {
"type": "string",
"example": "dc724af18fbdd4e59189f5fe768a5f8311527050",
"description": "The resource key string of the picture."
},
"default_picture": {
"type": "boolean",
"example": false,
"description": "Whether the picture is Vimeo's default."
}
}
}