LiveEssentialsGetAllUserLiveEventsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/live-event"
}
}
LiveEssentialsGetUserLiveEvents200Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/live-event"
}
}
LiveEssentialsGetUserLiveEventsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/live-event"
}
}
LiveEssentialsUpdateEventBelongingToAuthenticatedUserRequest
{
"type": "object",
"properties": {
"dvr": {
"type": "boolean",
"example": true,
"description": "Whether the DVR feature is enabled."
},
"embed": {
"type": "object",
"properties": {
"loop": {
"type": "boolean",
"example": true,
"description": "Whether the playlist should start from the beginning again after reaching the end of the last video."
},
"color": {
"type": "string",
"example": "#00adef",
"description": "The hexadecimal color code for the main color of the embed player."
},
"logos": {
"type": "object",
"properties": {
"vimeo": {
"type": "boolean",
"example": true,
"description": "Whether to show the Vimeo logo on the embed player."
},
"custom": {
"type": "object",
"properties": {
"link": {
"type": "string",
"example": "https://example.com",
"description": "The URL that loads when the user clicks the custom logo."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether to show the custom logo on the embed player."
},
"sticky": {
"type": "boolean",
"example": true,
"description": "Whether to show the custom logo persistently (`true`) or hide it with the rest of the UI (`false`)."
}
}
}
}
},
"autoplay": {
"type": "boolean",
"example": true,
"description": "Whether playback starts automatically on load."
},
"playlist": {
"type": "boolean",
"example": true,
"description": "Whether to show the playlist controls on the embed player."
},
"schedule": {
"type": "boolean",
"example": true,
"description": "Whether to show the event schedule on the embed player."
},
"use_color": {
"type": "boolean",
"example": true,
"description": "Whether the embed player should use (`true`) or ignore (`false`) the **embed.color** value."
}
},
"description": "The embed settings of the event and the videos generated by streaming to this event."
},
"title": {
"type": "string",
"example": "Live Content",
"description": "The title of the event. If **automatically_title_stream** is `true`, this value is the base title for videos created by streaming to this event."
},
"schedule": {
"type": "object",
"properties": {
"type": {
"enum": [
"single",
"weekly"
],
"type": "string",
"example": "weekly",
"description": "How often the event is expected to be live.\n\nOption descriptions:\n * `single` - The event is live one time only.\n * `weekly` - The event is live on a weekly basis.\n"
},
"weekdays": {
"type": "array",
"items": {
"type": "string"
},
"description": "A non-empty array of weekdays on which the event is expected to be live. Weekdays can range from 1 to 7, where 1 is Monday and 7 is Sunday. This parameter is required when **schedule.type** is `weekly`."
},
"daily_time": {
"type": "string",
"example": "14:00:00Z",
"description": "The time in ISO 8601 format when the event is expected to be live, with the zero UTC offset `Z`. This parameter is required when **schedule.type** is `weekly`."
}
},
"description": "Information about the time or times that the event is expected to be live."
},
"time_zone": {
"type": "string",
"example": "America/New_York",
"description": "The time zone used in resolving the timestamps that are included in automatically generated video titles."
},
"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 the live chat client on the Vimeo event page."
},
"stream_embed": {
"type": "object",
"properties": {
"embed": {
"enum": [
"private",
"public",
"whitelist"
],
"type": "string",
"example": "public",
"description": "The embed permission level for the event.\n\nOption descriptions:\n * `private` - Only the user can embed the event.\n * `public` - Anyone can embed the event.\n * `whitelist` - Only those on the whitelist can embed the event.\n"
}
}
},
"stream_title": {
"type": "string",
"example": "Special Feature",
"description": "The title of the next video to be streamed to the event. This parameter is required when **automatically_title_stream** is `false`."
},
"playlist_sort": {
"enum": [
"added_first",
"added_last",
"alphabetical",
"arranged",
"comments",
"duration",
"likes",
"newest",
"oldest",
"plays"
],
"type": "string",
"example": "added_first",
"description": "The order in which the videos of the event appear within the event's playlist.\n\nOption descriptions:\n * `added_first` - The most recently added videos appear first.\n * `added_last` - The most recently added videos appear last.\n * `alphabetical` - The videos appear in alphabetical order.\n * `arranged` - The videos appear in the order in which the user has arranged them.\n * `comments` - The videos appear in order of number of comments.\n * `duration` - The videos appear in order of duration.\n * `likes` - The videos appear in order of number of likes.\n * `newest` - The newest videos appear first.\n * `oldest` - The oldest videos appear first.\n * `plays` - The videos appear in order of number of plays.\n"
},
"content_rating": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values describing the content in this event. To return the list of all possible content rating values, use the [`/contentratings`](https://developer.vimeo.com/api/reference/videos#get_content_ratings) endpoint."
},
"stream_privacy": {
"type": "object",
"properties": {
"view": {
"enum": [
"anybody",
"embed_only",
"nobody",
"password",
"unlisted"
],
"type": "string",
"example": "anybody",
"description": "The initial privacy of the videos generated by streaming to the event as well as the embed privacy of the entire collection.\n\nOption descriptions:\n * `anybody` - Anyone can access the event. This privacy setting appears as `Public` on the Vimeo front end.\n * `embed_only` - The event doesn't appear on Vimeo, but it can be embedded on other sites.\n * `nobody` - No one except the owner can access the event. This privacy setting appears as `Private` on the Vimeo front end.\n * `password` - Only those with the password can access the event.\n * `unlisted` - Only those with the private link can access the event.\n"
}
},
"description": "The privacy settings of the event."
},
"auto_cc_enabled": {
"type": "boolean",
"example": false,
"description": "Whether automated closed captions are enabled for the event."
},
"stream_password": {
"type": "string",
"example": "hunter1",
"description": "The password when **stream_privacy.view** is `password`. Anyone with the password can view the videos generated by streaming to the event."
},
"auto_cc_keywords": {
"type": "string",
"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",
"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"
},
"scheduled_playback": {
"type": "boolean",
"example": false,
"description": "Whether the scheduled playback feature is enabled."
},
"stream_description": {
"type": "string",
"example": "In this episode, we interview a surprise guest",
"description": "The description of the next video to be streamed to the event."
},
"automatically_title_stream": {
"type": "boolean",
"example": true,
"description": "Whether the title for the next video in the event is generated based on the time of the stream and the **title** field of the event."
},
"interaction_tools_settings": {
"type": "object",
"properties": {
"is_qna_moderated": {
"type": "boolean",
"example": true,
"description": "Whether the Q&A is moderated for the interaction tools settings."
},
"is_anonymous_questions_disabled": {
"type": "boolean",
"example": true,
"description": "Whether anonymous questions are disabled for the interaction tools settings."
}
},
"description": "The settings for the interaction tools."
}
}
}
LiveEssentialsUpdateEventBelongingToAuthenticatedUserRequest1
{
"type": "object",
"properties": {
"dvr": {
"type": "boolean",
"example": true,
"description": "Whether the DVR feature is enabled."
},
"embed": {
"type": "object",
"properties": {
"loop": {
"type": "boolean",
"example": true,
"description": "Whether the playlist should start from the beginning again after reaching the end of the last video."
},
"color": {
"type": "string",
"example": "#00adef",
"description": "The hexadecimal color code for the main color of the embed player."
},
"logos": {
"type": "object",
"properties": {
"vimeo": {
"type": "boolean",
"example": true,
"description": "Whether to show the Vimeo logo on the embed player."
},
"custom": {
"type": "object",
"properties": {
"link": {
"type": "string",
"example": "https://example.com",
"description": "The URL that loads when the user clicks the custom logo."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether to show the custom logo on the embed player."
},
"sticky": {
"type": "boolean",
"example": true,
"description": "Whether to show the custom logo persistently (`true`) or hide it with the rest of the UI (`false`)."
}
}
}
}
},
"autoplay": {
"type": "boolean",
"example": true,
"description": "Whether playback starts automatically on load."
},
"playlist": {
"type": "boolean",
"example": true,
"description": "Whether to show the playlist controls on the embed player."
},
"schedule": {
"type": "boolean",
"example": true,
"description": "Whether to show the event schedule on the embed player."
},
"use_color": {
"type": "boolean",
"example": true,
"description": "Whether the embed player should use (`true`) or ignore (`false`) the **embed.color** value."
}
},
"description": "The embed settings of the event and the videos generated by streaming to this event."
},
"title": {
"type": "string",
"example": "Live Content",
"description": "The title of the event. If **automatically_title_stream** is `true`, this value is the base title for videos created by streaming to this event."
},
"schedule": {
"type": "object",
"properties": {
"type": {
"enum": [
"single",
"weekly"
],
"type": "string",
"example": "weekly",
"description": "How often the event is expected to be live.\n\nOption descriptions:\n * `single` - The event is live one time only.\n * `weekly` - The event is live on a weekly basis.\n"
},
"weekdays": {
"type": "array",
"items": {
"type": "string"
},
"description": "A non-empty array of weekdays on which the event is expected to be live. Weekdays can range from 1 to 7, where 1 is Monday and 7 is Sunday. This parameter is required when **schedule.type** is `weekly`."
},
"daily_time": {
"type": "string",
"example": "14:00:00Z",
"description": "The time in ISO 8601 format when the event is expected to be live, with the zero UTC offset `Z`. This parameter is required when **schedule.type** is `weekly`."
}
},
"description": "Information about the time or times that the event is expected to be live."
},
"time_zone": {
"type": "string",
"example": "America/New_York",
"description": "The time zone used in resolving the timestamps that are included in automatically generated video titles."
},
"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 the live chat client on the Vimeo event page."
},
"stream_embed": {
"type": "object",
"properties": {
"embed": {
"enum": [
"private",
"public",
"whitelist"
],
"type": "string",
"example": "public",
"description": "The embed permission level for the event.\n\nOption descriptions:\n * `private` - Only the user can embed the event.\n * `public` - Anyone can embed the event.\n * `whitelist` - Only those on the whitelist can embed the event.\n"
}
}
},
"stream_title": {
"type": "string",
"example": "Special Feature",
"description": "The title of the next video to be streamed to the event. This parameter is required when **automatically_title_stream** is `false`."
},
"playlist_sort": {
"enum": [
"added_first",
"added_last",
"alphabetical",
"arranged",
"comments",
"duration",
"likes",
"newest",
"oldest",
"plays"
],
"type": "string",
"example": "added_first",
"description": "The order in which the videos of the event appear within the event's playlist.\n\nOption descriptions:\n * `added_first` - The most recently added videos appear first.\n * `added_last` - The most recently added videos appear last.\n * `alphabetical` - The videos appear in alphabetical order.\n * `arranged` - The videos appear in the order in which the user has arranged them.\n * `comments` - The videos appear in order of number of comments.\n * `duration` - The videos appear in order of duration.\n * `likes` - The videos appear in order of number of likes.\n * `newest` - The newest videos appear first.\n * `oldest` - The oldest videos appear first.\n * `plays` - The videos appear in order of number of plays.\n"
},
"content_rating": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values describing the content in this event. To return the list of all possible content rating values, use the [`/contentratings`](https://developer.vimeo.com/api/reference/videos#get_content_ratings) endpoint."
},
"stream_privacy": {
"type": "object",
"properties": {
"view": {
"enum": [
"anybody",
"embed_only",
"nobody",
"password",
"unlisted"
],
"type": "string",
"example": "anybody",
"description": "The initial privacy of the videos generated by streaming to the event as well as the embed privacy of the entire collection.\n\nOption descriptions:\n * `anybody` - Anyone can access the event. This privacy setting appears as `Public` on the Vimeo front end.\n * `embed_only` - The event doesn't appear on Vimeo, but it can be embedded on other sites.\n * `nobody` - No one except the owner can access the event. This privacy setting appears as `Private` on the Vimeo front end.\n * `password` - Only those with the password can access the event.\n * `unlisted` - Only those with the private link can access the event.\n"
}
},
"description": "The privacy settings of the event."
},
"auto_cc_enabled": {
"type": "boolean",
"example": false,
"description": "Whether automated closed captions are enabled for the event."
},
"stream_password": {
"type": "string",
"example": "hunter1",
"description": "The password when **stream_privacy.view** is `password`. Anyone with the password can view the videos generated by streaming to the event."
},
"auto_cc_keywords": {
"type": "string",
"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",
"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"
},
"scheduled_playback": {
"type": "boolean",
"example": false,
"description": "Whether the scheduled playback feature is enabled."
},
"stream_description": {
"type": "string",
"example": "In this episode, we interview a surprise guest",
"description": "The description of the next video to be streamed to the event."
},
"automatically_title_stream": {
"type": "boolean",
"example": true,
"description": "Whether the title for the next video in the event is generated based on the time of the stream and the **title** field of the event."
},
"interaction_tools_settings": {
"type": "object",
"properties": {
"is_qna_moderated": {
"type": "boolean",
"example": true,
"description": "Whether the Q&A is moderated for the interaction tools settings."
},
"is_anonymous_questions_disabled": {
"type": "boolean",
"example": true,
"description": "Whether anonymous questions are disabled for the interaction tools settings."
}
},
"description": "The settings for the interaction tools."
}
}
}
LiveEssentialsUpdateEventBelongingToAuthenticatedUserRequest2
{
"type": "object",
"properties": {
"dvr": {
"type": "boolean",
"example": true,
"description": "Whether the DVR feature is enabled."
},
"embed": {
"type": "object",
"properties": {
"loop": {
"type": "boolean",
"example": true,
"description": "Whether the playlist should start from the beginning again after reaching the end of the last video."
},
"color": {
"type": "string",
"example": "#00adef",
"description": "The hexadecimal color code for the main color of the embed player."
},
"logos": {
"type": "object",
"properties": {
"vimeo": {
"type": "boolean",
"example": true,
"description": "Whether to show the Vimeo logo on the embed player."
},
"custom": {
"type": "object",
"properties": {
"link": {
"type": "string",
"example": "https://example.com",
"description": "The URL that loads when the user clicks the custom logo."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether to show the custom logo on the embed player."
},
"sticky": {
"type": "boolean",
"example": true,
"description": "Whether to show the custom logo persistently (`true`) or hide it with the rest of the UI (`false`)."
}
}
}
}
},
"autoplay": {
"type": "boolean",
"example": true,
"description": "Whether playback starts automatically on load."
},
"playlist": {
"type": "boolean",
"example": true,
"description": "Whether to show the playlist controls on the embed player."
},
"schedule": {
"type": "boolean",
"example": true,
"description": "Whether to show the event schedule on the embed player."
},
"use_color": {
"type": "boolean",
"example": true,
"description": "Whether the embed player should use (`true`) or ignore (`false`) the **embed.color** value."
}
},
"description": "The embed settings of the event and the videos generated by streaming to this event."
},
"title": {
"type": "string",
"example": "Live Content",
"description": "The title of the event. If **automatically_title_stream** is `true`, this value is the base title for videos created by streaming to this event."
},
"schedule": {
"type": "object",
"properties": {
"type": {
"enum": [
"single",
"weekly"
],
"type": "string",
"example": "weekly",
"description": "How often the event is expected to be live.\n\nOption descriptions:\n * `single` - The event is live one time only.\n * `weekly` - The event is live on a weekly basis.\n"
},
"weekdays": {
"type": "array",
"items": {
"type": "string"
},
"description": "A non-empty array of weekdays on which the event is expected to be live. Weekdays can range from 1 to 7, where 1 is Monday and 7 is Sunday. This parameter is required when **schedule.type** is `weekly`."
},
"daily_time": {
"type": "string",
"example": "14:00:00Z",
"description": "The time in ISO 8601 format when the event is expected to be live, with the zero UTC offset `Z`. This parameter is required when **schedule.type** is `weekly`."
}
},
"description": "Information about the time or times that the event is expected to be live."
},
"time_zone": {
"type": "string",
"example": "America/New_York",
"description": "The time zone used in resolving the timestamps that are included in automatically generated video titles."
},
"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 the live chat client on the Vimeo event page."
},
"stream_embed": {
"type": "object",
"properties": {
"embed": {
"enum": [
"private",
"public",
"whitelist"
],
"type": "string",
"example": "public",
"description": "The embed permission level for the event.\n\nOption descriptions:\n * `private` - Only the user can embed the event.\n * `public` - Anyone can embed the event.\n * `whitelist` - Only those on the whitelist can embed the event.\n"
}
}
},
"stream_title": {
"type": "string",
"example": "Special Feature",
"description": "The title of the next video to be streamed to the event. This parameter is required when **automatically_title_stream** is `false`."
},
"playlist_sort": {
"enum": [
"added_first",
"added_last",
"alphabetical",
"arranged",
"comments",
"duration",
"likes",
"newest",
"oldest",
"plays"
],
"type": "string",
"example": "added_first",
"description": "The order in which the videos of the event appear within the event's playlist.\n\nOption descriptions:\n * `added_first` - The most recently added videos appear first.\n * `added_last` - The most recently added videos appear last.\n * `alphabetical` - The videos appear in alphabetical order.\n * `arranged` - The videos appear in the order in which the user has arranged them.\n * `comments` - The videos appear in order of number of comments.\n * `duration` - The videos appear in order of duration.\n * `likes` - The videos appear in order of number of likes.\n * `newest` - The newest videos appear first.\n * `oldest` - The oldest videos appear first.\n * `plays` - The videos appear in order of number of plays.\n"
},
"content_rating": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values describing the content in this event. To return the list of all possible content rating values, use the [`/contentratings`](https://developer.vimeo.com/api/reference/videos#get_content_ratings) endpoint."
},
"stream_privacy": {
"type": "object",
"properties": {
"view": {
"enum": [
"anybody",
"embed_only",
"nobody",
"password",
"unlisted"
],
"type": "string",
"example": "anybody",
"description": "The initial privacy of the videos generated by streaming to the event as well as the embed privacy of the entire collection.\n\nOption descriptions:\n * `anybody` - Anyone can access the event. This privacy setting appears as `Public` on the Vimeo front end.\n * `embed_only` - The event doesn't appear on Vimeo, but it can be embedded on other sites.\n * `nobody` - No one except the owner can access the event. This privacy setting appears as `Private` on the Vimeo front end.\n * `password` - Only those with the password can access the event.\n * `unlisted` - Only those with the private link can access the event.\n"
}
},
"description": "The privacy settings of the event."
},
"auto_cc_enabled": {
"type": "boolean",
"example": false,
"description": "Whether automated closed captions are enabled for the event."
},
"stream_password": {
"type": "string",
"example": "hunter1",
"description": "The password when **stream_privacy.view** is `password`. Anyone with the password can view the videos generated by streaming to the event."
},
"auto_cc_keywords": {
"type": "string",
"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",
"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"
},
"scheduled_playback": {
"type": "boolean",
"example": false,
"description": "Whether the scheduled playback feature is enabled."
},
"stream_description": {
"type": "string",
"example": "In this episode, we interview a surprise guest",
"description": "The description of the next video to be streamed to the event."
},
"automatically_title_stream": {
"type": "boolean",
"example": true,
"description": "Whether the title for the next video in the event is generated based on the time of the stream and the **title** field of the event."
},
"interaction_tools_settings": {
"type": "object",
"properties": {
"is_qna_moderated": {
"type": "boolean",
"example": true,
"description": "Whether the Q&A is moderated for the interaction tools settings."
},
"is_anonymous_questions_disabled": {
"type": "boolean",
"example": true,
"description": "Whether anonymous questions are disabled for the interaction tools settings."
}
},
"description": "The settings for the interaction tools."
}
}
}
LiveEventActivationCreateRtmpLinksRequest
{
"type": "object",
"properties": {
"cloud_composing_streaming": {
"type": "boolean",
"example": true,
"description": "Whether the stream activates from the cloud composer. _This field is deprecated._"
},
"streaming_start_requested": {
"type": "boolean",
"example": true,
"description": "Whether the stream activates from the cloud composer."
}
}
}
LiveEventActivationCreateRtmpLinksRequest1
{
"type": "object",
"properties": {
"cloud_composing_streaming": {
"type": "boolean",
"example": true,
"description": "Whether the stream activates from the cloud composer. _This field is deprecated._"
},
"streaming_start_requested": {
"type": "boolean",
"example": true,
"description": "Whether the stream activates from the cloud composer."
}
}
}
LiveEventActivationCreateRtmpLinksRequest2
{
"type": "object",
"properties": {
"cloud_composing_streaming": {
"type": "boolean",
"example": true,
"description": "Whether the stream activates from the cloud composer. _This field is deprecated._"
},
"streaming_start_requested": {
"type": "boolean",
"example": true,
"description": "Whether the stream activates from the cloud composer."
}
}
}
LiveEventAutomatedClosedCaptionsEditPreferenceForEventRequest
{
"type": "object",
"required": [
"auto_cc_enabled"
],
"properties": {
"auto_cc_lang": {
"enum": [
"de-DE",
"en-US",
"es-ES",
"fr-FR",
"pt-BR"
],
"type": "string",
"example": "en-US",
"description": "The language in which the automated closed captions appear.\n\nOption descriptions:\n * `de-DE` - The language is German.\n * `en-US` - The language is English.\n * `es-ES` - The language is Spanish.\n * `fr-FR` - The language is French.\n * `pt-BR` - The language is Portuguese.\n"
},
"auto_cc_enabled": {
"type": "boolean",
"example": true,
"description": "Whether automated closed captions are enabled for the event."
},
"auto_cc_keywords": {
"type": "string",
"example": "commonly-used words,phrases,technical terms",
"description": "A comma-separated list of keywords that improve the quality of the automated closed captions."
}
}
}
LiveEventAutomatedClosedCaptionsEditPreferenceForEventRequest1
{
"type": "object",
"required": [
"auto_cc_enabled"
],
"properties": {
"auto_cc_lang": {
"enum": [
"de-DE",
"en-US",
"es-ES",
"fr-FR",
"pt-BR"
],
"type": "string",
"example": "en-US",
"description": "The language in which the automated closed captions appear.\n\nOption descriptions:\n * `de-DE` - The language is German.\n * `en-US` - The language is English.\n * `es-ES` - The language is Spanish.\n * `fr-FR` - The language is French.\n * `pt-BR` - The language is Portuguese.\n"
},
"auto_cc_enabled": {
"type": "boolean",
"example": true,
"description": "Whether automated closed captions are enabled for the event."
},
"auto_cc_keywords": {
"type": "string",
"example": "commonly-used words,phrases,technical terms",
"description": "A comma-separated list of keywords that improve the quality of the automated closed captions."
}
}
}
LiveEventAutomatedClosedCaptionsEditPreferenceRequest
{
"type": "object",
"required": [
"auto_cc_enabled"
],
"properties": {
"auto_cc_lang": {
"enum": [
"de-DE",
"en-US",
"es-ES",
"fr-FR",
"pt-BR"
],
"type": "string",
"example": "en-US",
"description": "The language in which the automated closed captions appear.\n\nOption descriptions:\n * `de-DE` - The language is German.\n * `en-US` - The language is English.\n * `es-ES` - The language is Spanish.\n * `fr-FR` - The language is French.\n * `pt-BR` - The language is Portuguese.\n"
},
"auto_cc_enabled": {
"type": "boolean",
"example": true,
"description": "Whether automated closed captions are enabled for the event."
},
"auto_cc_keywords": {
"type": "string",
"example": "commonly-used words,phrases,technical terms",
"description": "A comma-separated list of keywords that improve the quality of the automated closed captions."
}
}
}
LiveEventDestinationsCreateDestinationRequest
{
"type": "object",
"required": [
"display_name",
"service_name",
"type"
],
"properties": {
"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"
},
"privacy": {
"enum": [
"CONNECTIONS",
"PUBLIC",
"all_friends",
"everyone",
"private",
"public",
"self",
"unlisted"
],
"type": "string",
"example": "public",
"description": "The privacy setting of the destination. Be sure to choose a value that corresponds to your service.\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"
},
"is_enabled": {
"type": "boolean",
"example": true,
"description": "Whether the destination is enabled for simulcasting."
},
"stream_key": {
"type": "string",
"example": "da056692-ba63-4749-a6eb-a476a22b3acd",
"description": "The RTMP stream key."
},
"stream_url": {
"type": "string",
"example": "rtmp://mycooldomain.com/live",
"description": "The RTMP URL for receiving the video stream."
},
"display_name": {
"type": "string",
"example": "My channel",
"description": "The title to display for the simulcast."
},
"scheduled_at": {
"type": "number",
"example": 1625754461,
"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": "youtube",
"description": "The service to simulcast to.\n\nOption descriptions:\n * `custom_rtmp` - Simulcast to a custom service.\n * `facebook` - Simulcast to Facebook Live.\n * `linkedin` - Simulcast to LinkedIn Live.\n * `youtube` - Simulcast to YouTube Live.\n"
},
"provider_video_id": {
"type": "string",
"example": "6817807391346708000",
"nullable": true,
"description": "The ID of the scheduled video."
},
"provider_destination_id": {
"type": "string",
"example": "bda55c6b3ba4",
"description": "The ID of the destination on the specified service, such as the YouTube channel ID or the Facebook page ID."
}
}
}
LiveEventDestinationsCreateEventDestinationRequest
{
"type": "object",
"required": [
"display_name",
"service_name",
"type"
],
"properties": {
"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"
},
"privacy": {
"enum": [
"CONNECTIONS",
"PUBLIC",
"all_friends",
"everyone",
"private",
"public",
"self",
"unlisted"
],
"type": "string",
"example": "public",
"description": "The privacy setting of the destination. Be sure to choose a value that corresponds to your service.\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"
},
"is_enabled": {
"type": "boolean",
"example": true,
"description": "Whether the destination is enabled for simulcasting."
},
"stream_key": {
"type": "string",
"example": "da056692-ba63-4749-a6eb-a476a22b3acd",
"description": "The RTMP stream key."
},
"stream_url": {
"type": "string",
"example": "rtmp://mycooldomain.com/live",
"description": "The RTMP URL for receiving the video stream."
},
"display_name": {
"type": "string",
"example": "My channel",
"description": "The title to display for the simulcast."
},
"scheduled_at": {
"type": "number",
"example": 1625754461,
"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": "youtube",
"description": "The service to simulcast to.\n\nOption descriptions:\n * `custom_rtmp` - Simulcast to a custom service.\n * `facebook` - Simulcast to Facebook Live.\n * `linkedin` - Simulcast to LinkedIn Live.\n * `youtube` - Simulcast to YouTube Live.\n"
},
"provider_video_id": {
"type": "string",
"example": "6817807391346708000",
"nullable": true,
"description": "The ID of the scheduled video."
},
"provider_destination_id": {
"type": "string",
"example": "bda55c6b3ba4",
"description": "The ID of the destination on the specified service, such as the YouTube channel ID or the Facebook page ID."
}
}
}
LiveEventDestinationsCreateOneTimeLiveEventDestinationRequest
{
"type": "object",
"required": [
"display_name",
"service_name",
"type"
],
"properties": {
"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"
},
"privacy": {
"enum": [
"CONNECTIONS",
"PUBLIC",
"all_friends",
"everyone",
"private",
"public",
"self",
"unlisted"
],
"type": "string",
"example": "public",
"description": "The privacy setting of the destination. Be sure to choose a value that corresponds to your service.\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"
},
"is_enabled": {
"type": "boolean",
"example": true,
"description": "Whether the destination is enabled for simulcasting."
},
"stream_key": {
"type": "string",
"example": "da056692-ba63-4749-a6eb-a476a22b3acd",
"description": "The RTMP stream key."
},
"stream_url": {
"type": "string",
"example": "rtmp://mycooldomain.com/live",
"description": "The RTMP URL for receiving the video stream."
},
"display_name": {
"type": "string",
"example": "My channel",
"description": "The title to display for the simulcast."
},
"scheduled_at": {
"type": "number",
"example": 1625754461,
"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": "youtube",
"description": "The service to simulcast to.\n\nOption descriptions:\n * `custom_rtmp` - Simulcast to a custom service.\n * `facebook` - Simulcast to Facebook Live.\n * `linkedin` - Simulcast to LinkedIn Live.\n * `youtube` - Simulcast to YouTube Live.\n"
},
"provider_video_id": {
"type": "string",
"example": "6817807391346708000",
"nullable": true,
"description": "The ID of the scheduled video."
},
"provider_destination_id": {
"type": "string",
"example": "bda55c6b3ba4",
"description": "The ID of the destination on the specified service, such as the YouTube channel ID or the Facebook page ID."
}
}
}
LiveEventDestinationsCreateOneTimeLiveEventDestinationRequest1
{
"type": "object",
"required": [
"display_name",
"service_name",
"type"
],
"properties": {
"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"
},
"privacy": {
"enum": [
"CONNECTIONS",
"PUBLIC",
"all_friends",
"everyone",
"private",
"public",
"self",
"unlisted"
],
"type": "string",
"example": "public",
"description": "The privacy setting of the destination. Be sure to choose a value that corresponds to your service.\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"
},
"is_enabled": {
"type": "boolean",
"example": true,
"description": "Whether the destination is enabled for simulcasting."
},
"stream_key": {
"type": "string",
"example": "da056692-ba63-4749-a6eb-a476a22b3acd",
"description": "The RTMP stream key."
},
"stream_url": {
"type": "string",
"example": "rtmp://mycooldomain.com/live",
"description": "The RTMP URL for receiving the video stream."
},
"display_name": {
"type": "string",
"example": "My channel",
"description": "The title to display for the simulcast."
},
"scheduled_at": {
"type": "number",
"example": 1625754461,
"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": "youtube",
"description": "The service to simulcast to.\n\nOption descriptions:\n * `custom_rtmp` - Simulcast to a custom service.\n * `facebook` - Simulcast to Facebook Live.\n * `linkedin` - Simulcast to LinkedIn Live.\n * `youtube` - Simulcast to YouTube Live.\n"
},
"provider_video_id": {
"type": "string",
"example": "6817807391346708000",
"nullable": true,
"description": "The ID of the scheduled video."
},
"provider_destination_id": {
"type": "string",
"example": "bda55c6b3ba4",
"description": "The ID of the destination on the specified service, such as the YouTube channel ID or the Facebook page ID."
}
}
}
LiveEventDestinationsGetAllAvailableDestinations200Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/live-event-destination"
}
}
LiveEventDestinationsGetAllAvailableDestinationsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/live-event-destination"
}
}
LiveEventDestinationsGetAllDestinationsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/live-event-destination"
}
}
LiveEventDestinationsGetAllOttDestinationsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ott-destination"
}
}
LiveEventDestinationsListAllAvailableDestinationsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/live-event-destination"
}
}
LiveEventDestinationsUpdateDestinationRequest
{
"type": "object",
"properties": {
"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"
},
"privacy": {
"enum": [
"CONNECTIONS",
"PUBLIC",
"all_friends",
"everyone",
"private",
"public",
"self",
"unlisted"
],
"type": "string",
"example": "public",
"description": "The privacy setting of the destination. Be sure to choose a value that corresponds to your service.\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"
},
"is_enabled": {
"type": "boolean",
"example": true,
"description": "Whether the destination is enabled for simulcasting."
},
"stream_key": {
"type": "string",
"example": "da056692-ba63-4749-a6eb-a476a22b3acd",
"description": "The RTMP stream key."
},
"stream_url": {
"type": "string",
"example": "rtmp://mycooldomain.com/live",
"description": "The RTMP URL for receiving the video stream."
},
"display_name": {
"type": "string",
"example": "My channel",
"description": "The title to display for the simulcast."
},
"service_name": {
"enum": [
"custom_rtmp",
"facebook",
"linkedin",
"youtube"
],
"type": "string",
"example": "youtube",
"description": "The service to simulcast to.\n\nOption descriptions:\n * `custom_rtmp` - Simulcast to a custom service.\n * `facebook` - Simulcast to Facebook Live.\n * `linkedin` - Simulcast to LinkedIn Live.\n * `youtube` - Simulcast to YouTube Live.\n"
},
"provider_destination_id": {
"type": "string",
"example": "bda55c6b3ba4",
"description": "The ID of the destination on the specified service, such as the YouTube channel ID or the Facebook page ID."
}
}
}
LiveEventLowLatencyToggleOptionRequest
{
"type": "object",
"properties": {
"low_latency": {
"type": "boolean",
"description": "Whether the event is low latency."
}
}
}
LiveEventLowLatencyToggleOptionRequest1
{
"type": "object",
"properties": {
"low_latency": {
"type": "boolean",
"description": "Whether the event is low latency."
}
}
}
LiveEventLowLatencyToggleOptionRequest2
{
"type": "object",
"properties": {
"low_latency": {
"type": "boolean",
"description": "Whether the event is low latency."
}
}
}
LiveEventThumbnailsAddThumbnailRequest
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"example": true,
"description": "Whether the thumbnail is the event's active thumbnail."
}
}
}
LiveEventThumbnailsCreateThumbnailForEventRequest
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"example": true,
"description": "Whether the thumbnail is the event's active thumbnail."
}
}
}
LiveEventThumbnailsCreateThumbnailForEventRequest1
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"example": true,
"description": "Whether the thumbnail is the event's active thumbnail."
}
}
}
LiveEventThumbnailsEditEventThumbnailRequest
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"example": true,
"description": "Whether the thumbnail is the event's active thumbnail."
}
}
}
LiveEventThumbnailsEditLiveEventThumbnailRequest
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"example": true,
"description": "Whether the thumbnail is the event's active thumbnail."
}
}
}
LiveEventThumbnailsGetAllResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/picture"
}
}
LiveEventThumbnailsGetAllThumbnailsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/picture"
}
}
LiveEventThumbnailsGetAllThumbsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/picture"
}
}
LiveEventThumbnailsUpdateEventThumbnailRequest
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"example": true,
"description": "Whether the thumbnail is the event's active thumbnail."
}
}
}
LiveEventVideosAddMultipleRequest
{
"type": "object",
"properties": {
"videos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"video": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"example": "/videos/258684937",
"description": "The URI of a video to add."
}
}
}
}
},
"description": "An array of video objects."
}
}
}
LiveEventVideosAddMultipleVideosRequest
{
"type": "object",
"properties": {
"videos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"video": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"example": "/videos/258684937",
"description": "The URI of a video to add."
}
}
}
}
},
"description": "An array of video objects."
}
}
}
LiveEventVideosGetAllResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
LiveEventVideosListAllVideosInEventResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
LiveEventVideosListLiveEventVideosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
LiveEventVideosRemoveMultipleRequest
{
"type": "object",
"properties": {
"videos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"video": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"example": "/videos/258684937",
"description": "The URI of a video to remove."
}
}
}
}
},
"description": "An array of video objects."
}
}
}
LiveEventVideosRemoveMultipleRequest1
{
"type": "object",
"properties": {
"videos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"video": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"example": "/videos/258684937",
"description": "The URI of a video to remove."
}
}
}
}
},
"description": "An array of video objects."
}
}
}
LiveEventVideosRemoveMultipleVideosRequest
{
"type": "object",
"properties": {
"videos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"video": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"example": "/videos/258684937",
"description": "The URI of a video to remove."
}
}
}
}
},
"description": "An array of video objects."
}
}
}
LiveEventVideosUploadMultipleRequest
{
"type": "object",
"properties": {
"videos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"video": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"example": "/videos/258684937",
"description": "The URI of a video to add."
}
}
}
}
},
"description": "An array of video objects."
}
}
}
OnDemandBackgroundsEditBackgroundOnPageRequest
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"example": true,
"description": "Whether this background image is the one that appears on the On Demand page."
}
}
}
OnDemandBackgroundsGetAllBackgroundsOnPageResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/picture"
}
}
OnDemandEssentialsCreatePageRequest
{
"type": "object",
"required": [
"content_rating",
"description",
"name",
"type"
],
"properties": {
"buy": {
"type": "object",
"properties": {
"price": {
"type": "object",
"properties": {
"AUD": {
"type": "number",
"example": 2.99,
"description": "The purchase price of the video in Australian dollars."
},
"CAD": {
"type": "number",
"example": 2.99,
"description": "The purchase price of the video in Canadian dollars."
},
"CHF": {
"type": "number",
"example": 2.99,
"description": "The purchase price of the video in Swiss francs."
},
"DKK": {
"type": "number",
"example": 2.99,
"description": "The purchase price of the video in Danish krone."
},
"EUR": {
"type": "number",
"example": 2.99,
"description": "The purchase price of the video in euros."
},
"GBP": {
"type": "number",
"example": 2.99,
"description": "The purchase price of the video in British pounds."
},
"JPY": {
"type": "number",
"example": 2.99,
"description": "The purchase price of the video in Japanese yen."
},
"KRW": {
"type": "number",
"example": 2.99,
"description": "The purchase price of the video in South Korean won."
},
"NOK": {
"type": "number",
"example": 2.99,
"description": "The purchase price of the video in Norwegian krone."
},
"PLN": {
"type": "number",
"example": 2.99,
"description": "The purchase price of the video in Polish zloty."
},
"SEK": {
"type": "number",
"example": 2.99,
"description": "The purchase price of the video in Swedish krona."
},
"USD": {
"type": "number",
"example": 2.99,
"description": "When **type** is `film`, the purchase price of the video in United States dollars. When **type** is `series`, the purchase price of the entire collection in United States dollars."
}
}
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether the video can be purchased. This parameter is required when **rent.active** is `false`."
},
"download": {
"type": "boolean",
"example": true,
"description": "Whether people who buy the video can download it. To use this parameter, **type** must be `film`."
}
}
},
"link": {
"type": "string",
"example": "darbyforever",
"description": "The custom string to use in the Vimeo URL of the On Demand page."
},
"name": {
"type": "string",
"example": "Darby Forever",
"description": "The name of the On Demand page."
},
"rent": {
"type": "object",
"properties": {
"price": {
"type": "object",
"properties": {
"AUD": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in Australian dollars."
},
"CAD": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in Canadian dollars."
},
"CHF": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in Swiss francs."
},
"DKK": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in Danish krone."
},
"EUR": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in euros."
},
"GBP": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in British pounds."
},
"JPY": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in Japanese yen."
},
"KRW": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in South Korean won."
},
"NOK": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in Norwegian krone."
},
"PLN": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in Polish zloty."
},
"SEK": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in Swedish krona."
},
"USD": {
"type": "number",
"example": 0.99,
"description": "When **type** is `film`, the rental price of the video in United States dollars. When **type** is `series`, the rental price of the entire collection in United States dollars."
}
}
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether the video can be rented. This parameter is required when **episodes.rent.active** is `true`."
},
"period": {
"enum": [
"1 week",
"1 year",
"24 hour",
"3 month",
"30 day",
"48 hour",
"6 month",
"72 hour"
],
"type": "string",
"description": "The rental period of the video.\n\nOption descriptions:\n * `1 week` - The video can be rented for a maximum of 1 week.\n * `1 year` - The video can be rented for a maximum of 1 year.\n * `24 hour` - The video can be rented for a maximum of 24 hours.\n * `3 month` - The video can be rented for a maximum of 3 months.\n * `30 day` - The video can be rented for a maximum of 30 days.\n * `48 hour` - The video can be rented for a maximum of 48 hours.\n * `6 month` - The video can be rented for a maximum of 6 months.\n * `72 hour` - The video can be rented for a maximum of 72 hours.\n"
}
}
},
"type": {
"enum": [
"film",
"series"
],
"type": "string",
"description": "The type of the On Demand page.\n\nOption descriptions:\n * `film` - The On Demand page is a film.\n * `series` - The On Demand page is a series.\n"
},
"episodes": {
"type": "object",
"properties": {
"buy": {
"type": "object",
"properties": {
"price": {
"type": "object",
"properties": {
"USD": {
"type": "number",
"example": 1.99,
"description": "The purchase price per episode in United States dollars. This parameter is required when **episodes.buy.active** is `true`."
}
}
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether episodes can be purchased."
},
"download": {
"type": "boolean",
"example": true,
"description": "Whether people who buy episodes can download them. To use this parameter, **type** must be `series`."
}
}
},
"rent": {
"type": "object",
"properties": {
"price": {
"type": "object",
"properties": {
"USD": {
"type": "number",
"example": 0.99,
"description": "The rental price per episode in United States dollars. This parameter is applicable only when **type** is `series`, and it's required when **episode.rent.active** is `true`."
}
}
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether episodes can be rented."
},
"period": {
"enum": [
"1 week",
"1 year",
"24 hour",
"3 month",
"30 day",
"48 hour",
"6 month",
"72 hour"
],
"type": "string",
"description": "The rental period of the episode.\n\nOption descriptions:\n * `1 week` - The episode can be rented for a maximum of 1 week.\n * `1 year` - The episode can be rented for a maximum of 1 year.\n * `24 hour` - The episode can be rented for a maximum of 24 hours.\n * `3 month` - The episode can be rented for a maximum of 3 months.\n * `30 day` - The episode can be rented for a maximum of 30 days.\n * `48 hour` - The episode can be rented for a maximum of 48 hours.\n * `6 month` - The episode can be rented for a maximum of 6 months.\n * `72 hour` - The episode can be rented for a maximum of 72 hours.\n"
}
}
}
}
},
"description": {
"type": "string",
"example": "DARBY FOREVER follows the fantasies of Darby, a shopgirl at \"Bobbins & Notions\".",
"description": "The description of the On Demand page."
},
"domain_link": {
"type": "string",
"example": "https://example.com",
"description": "The custom domain of the On Demand page."
},
"subscription": {
"type": "object",
"properties": {
"monthly": {
"type": "object",
"properties": {
"price": {
"type": "object",
"properties": {
"USD": {
"type": "number",
"example": 9.99,
"description": "The monthly subscription price in United States dollars. This parameter is required when **rent.active** and **buy.active** are `false`."
}
}
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether a monthly subscription is active. This parameter is required when **rent.active** and **buy.active** are `false`."
}
}
}
}
},
"content_rating": {
"enum": [
"drugs",
"language",
"nudity",
"safe",
"unrated",
"violence"
],
"type": "string",
"description": "The content rating of the video, given either as a comma-separated list or as a JSON array, depending on the request format.\n\nOption descriptions:\n * `drugs` - The video contains drug or alcohol use.\n * `language` - The video contains profanity or sexually suggestive content.\n * `nudity` - The video contains nudity.\n * `safe` - The video is suitable for all audiences.\n * `unrated` - The video hasn't been rated.\n * `violence` - The video contains violent or graphic content.\n"
},
"accepted_currencies": {
"enum": [
"AUD",
"CAD",
"CHF",
"DKK",
"EUR",
"GBP",
"JPY",
"KRW",
"NOK",
"PLN",
"SEK",
"USD"
],
"type": "string",
"description": "An array of accepted currencies.\n\nOption descriptions:\n * `AUD` - The currency is in Australian dollars.\n * `CAD` - The currency is in Canadian dollars.\n * `CHF` - The currency is in Swiss francs.\n * `DKK` - The currency is in Danish krone.\n * `EUR` - The currency is in euros.\n * `GBP` - The currency is in British pounds.\n * `JPY` - The currency is in Japanese yen.\n * `KRW` - The currency is in South Korean won.\n * `NOK` - The currency is in Norwegian krone.\n * `PLN` - The currency is in Polish zloty.\n * `SEK` - The currency is in Swedish krona.\n * `USD` - The currency is in United States dollars.\n"
}
}
}
OnDemandEssentialsGetAllUserPages200Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/on-demand-page"
}
}
OnDemandEssentialsGetAllUserPagesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/on-demand-page"
}
}
OnDemandGenresGetAllGenresResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/on-demand-genre"
}
}
OnDemandGenresGetAllPagesInGenreResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/on-demand-page"
}
}