Get VOD

GET https://api.one.blendvision.com/bv/cms/v1/vods/:id

Returns a VOD resource.

Required field(s):

id

Request

Path Parameters

id stringrequired

Required. The unique id of the VOD.

Header Parameters

x-bv-org-id stringrequired

To invoke this API using api_token, you need to set the x-bv-org-id header to specify the organization for which you want to perform the action.

Responses

A successful response.

application/json

Schema
Example (from schema)

Schema

vod object

id stringrequired

Output only. The unique id of VOD resource.

name stringrequired

Output only. The name of VOD resource.

source object

Output only. Indicate the source file that you want to encode.

type string

Possible values: [SOURCE_TYPE_LIBRARY, SOURCE_TYPE_CLOUD_STORAGE]

Indicates the Source type, should match the following library or cloud_storage setting.

library object

cloud_storage object

profile_set object

Output only. Indicate the profile set that defines the encoding settings.

id string

Output only. The resource identifier of profile set.

name string

Input only. The name of profile set.

protocols - PROTOCOL_HLS: HTTP Live Streaming - PROTOCOL_DASH: Dynamic Adaptive Streaming over HTTP - PROTOCOL_WHEP: WebRTC-HTTP Egress Protocol - PROTOCOL_PROGRESSIVE: Progressive download (string)[]

Possible values: [PROTOCOL_HLS, PROTOCOL_DASH, PROTOCOL_WHEP, PROTOCOL_PROGRESSIVE]

Input only. The protocols.

smart_abr boolean

Input only. Smart abr.

multiple_audio_track object

video_codec - VIDEO_CODEC_H264: VIDEO_CODEC_H264 Indicates video code H.264 - VIDEO_CODEC_H265: VIDEO_CODEC_H265 Indicates video code H.265 (string)

Possible values: [VIDEO_CODEC_H264, VIDEO_CODEC_H265]

Input only. The video codec.

profiles object[]

preset boolean

Output only. The prest is system or custom. If preset is true, the profile set is created by system, otherwise the profile set is created by custom.

queue string

Possible values: [QUEUE_STANDARD, QUEUE_PRIORITY]

Output only. Indicates which queue this encoding job was executed on before.

pte object

stream object[]

labels object[]

created_at date-timerequired

Output Only. Indicate the create time of the VOD.

status stringrequired

Possible values: [VOD_STATUS_CREATED, VOD_STATUS_INGESTED, VOD_STATUS_QUEUED, VOD_STATUS_ENCODED, VOD_STATUS_DEPLOYED, VOD_STATUS_SUCCEEDED, VOD_STATUS_FAILED, VOD_STATUS_CANCELLED, VOD_STATUS_DELETED]

Output Only. Indicate the current status of the VOD.

previous_status string

Output only. Indicate the previous status of the VOD.

metadata object

source_file_info object

updated_at date-timerequired

Output Only. Indicate the latest update time of the VOD.

schedule object

security object

Output Only. Indicate the security setting of the VOD.

privacy objectrequired

watermark object

domain_control object

protection object

geo_control string[]

Immutable. Specify the alpha-2 codes (See: https://www.iban.com/country-codes) to restrict access to the content by geo locations. Allow all regions when empty.

cover_image object

export object

showroom object

byo_cdn object

player_setting object

chapter_setting object

subtitles object[]

Output Only. The vod subtitles.

Array [

id string

The unique id of subtitle.

track_no string

The number of audio track.

lang_code string

The language code of the subtitle. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

display string

The display name of the subtitle.

status string

Possible values: [SUBTITLE_STATUS_GENERATING, SUBTITLE_STATUS_SUCCEED, SUBTITLE_STATUS_FAILED, SUBTITLE_STATUS_NOT_FOUND]

The status of subtitle.

subtitle_file_info object

The information of subtitle.

file object

id string

Output only. The unique id of the file.

type string

Possible values: [FILE_TYPE_VIDEO, FILE_TYPE_IMAGE, FILE_TYPE_SUBTITLE, FILE_TYPE_DOCUMENT, FILE_TYPE_WEB_LINK, FILE_TYPE_AUDIO]

Input only. The type of the file.

name string

Input only. The name of the file.

size int64

Input only. The size of the file in bytes.

uri string

Output only. The uri of the file.

source stringrequired

Possible values: [FILE_SOURCE_LIVE_EVENT, FILE_SOURCE_UPLOAD_IN_LIBRARY, FILE_SOURCE_ADD_VOD, FILE_SOURCE_CLOUD_STORAGE_AWS, FILE_SOURCE_STT, FILE_SOURCE_ADD_AOD, FILE_SOURCE_AISK, FILE_SOURCE_GOOGLE_DRIVE, FILE_SOURCE_GOOGLE_CALENDAR, FILE_SOURCE_HIGHLIGHT, FILE_SOURCE_TRANSLATE, FILE_SOURCE_LIVE_CLIP]

Required. The source of the file, only for display.

attrs object

has_subtitle Output Only. Indicate the video has subtitle or not when the file type is `FILE_TYPE_VIDEO` (boolean)

subtitles object[]

status string

Possible values: [FILE_STATUS_SUCCEED, FILE_STATUS_PROGRESSING, FILE_STATUS_FAILED]

Output Only. The file status.

permission object

summary object

metadata object

created_at date-time

Output only.

updated_at date-time

Output only.

contents object[]

source_type string

Possible values: [SUBTITLE_SOURCE_TYPE_LOCAL, SUBTITLE_SOURCE_TYPE_STT, SUBTITLE_SOURCE_TYPE_AI_TRANSLATE]

The source type of subtitle.

source_subtitle_id string

The id of the source subtitle used for translation.

applied_dictionaries string[]

The dictionaries applied to the subtitle.

created_at date-time

Output only.

updated_at date-time

Output only.

]

type - VOD_TYPE_STT: video for stt, it represents the type of background vod - VOD_TYPE_AUDIO_FOR_STT: audio for stt, it represents the type of background aod (string)

Possible values: [VOD_TYPE_ENCODING, VOD_TYPE_CATCHUP, VOD_TYPE_AMS_VIDEO, VOD_TYPE_AMS_AUDIO, VOD_TYPE_STT, VOD_TYPE_AUDIO_ENCODING, VOD_TYPE_AUDIO_FOR_STT, VOD_TYPE_BACKGROUND]

Output Only. The vod type.

org_id stringrequired

Output Only. The organization ID that the encoding belongs to.

stream_id string

Optional. Output only. The stream ID from the Platform API, which is responsible for providing basic encoding and streaming functions, such as encoding server and content delivery.

end_screen object

summary object

permission objectrequired

latest_vod_encoding_stages object[]

tagging_setting object

mode string

Possible values: [ENCODING_MODE_QUALITY_FIRST, ENCODING_MODE_SPEED_FIRST]

Output Only. The encoding mode of the VOD.

{
  "vod": {
    "cover_image": {
      "auto": {
        "name": "AUTO",
        "size": "39430",
        "url": "https://d3r4shtv85jcno.cloudfront.net/42f6c33e-f632-44e5-8042-05abb5fa2223/vod/dfd6e1a9-3f38-43dc-9966-f35caefe77b5/cover_image/cover_image.jpg"
      },
      "type": "COVER_IMAGE_TYPE_AUTO",
      "updated_at": "2023-05-30T10:43:37Z"
    },
    "created_at": "2023-05-30T10:34:29Z",
    "export": null,
    "id": "aca7071e-f09a-4bc5-8955-5f316142f574",
    "labels": [],
    "metadata": {
      "labels": [],
      "long_description": "",
      "short_description": ""
    },
    "name": "video.mp4",
    "permission": {
      "assignments": [
        {
          "access_role": "ACCESS_ROLE_SUPER_EDITOR",
          "assigned_type": "ASSIGNED_TYPE_OWNER",
          "email": "",
          "id": "",
          "name": ""
        }
      ],
      "default_access_role": "ACCESS_ROLE_DENY"
    },
    "previous_status": "VOD_STATUS_ENCODED",
    "profile_set": {
      "id": "6a2b2ea3-9e35-4216-93c9-da09dee5ab12",
      "multiple_audio_track": {
        "lang_customizes": [],
        "lang_from": "LANG_FROM_FIRST_TRACK"
      },
      "name": "H.264-1080P-30fps",
      "preset": false,
      "profiles": [
        {
          "audio_bitrate": "128",
          "b_frame": true,
          "codec_profile": "CODEC_PROFILE_AUTO",
          "frame_rate": "FRAME_RATE_30",
          "gop_size": 2,
          "id": "57acf6c4-688e-47c5-a4f9-548c64ef6ddb",
          "level": "CODEC_PROFILE_LEVEL_AUTO",
          "name": "1080p-5Mbps",
          "preset": false,
          "segment_duration": 6,
          "standard": "RESOLUTION_TYPE_UNSPECIFIED",
          "video_bitrate": "5000",
          "video_codec": "VIDEO_CODEC_H264",
          "video_height": 1080,
          "video_width": 1920
        },
        {
          "audio_bitrate": "128",
          "b_frame": true,
          "codec_profile": "CODEC_PROFILE_AUTO",
          "frame_rate": "FRAME_RATE_30",
          "gop_size": 2,
          "id": "d8b7caa0-7487-4cdf-ab64-44cf54783d34",
          "level": "CODEC_PROFILE_LEVEL_AUTO",
          "name": "720p-2.5Mbps",
          "preset": false,
          "segment_duration": 6,
          "standard": "RESOLUTION_TYPE_UNSPECIFIED",
          "video_bitrate": "2500",
          "video_codec": "VIDEO_CODEC_H264",
          "video_height": 720,
          "video_width": 1440
        },
        {
          "audio_bitrate": "96",
          "b_frame": true,
          "codec_profile": "CODEC_PROFILE_AUTO",
          "frame_rate": "FRAME_RATE_30",
          "gop_size": 2,
          "id": "39861dab-83da-4cd7-bb58-7ae6af648c19",
          "level": "CODEC_PROFILE_LEVEL_AUTO",
          "name": "480p-1.5Mbps",
          "preset": false,
          "segment_duration": 6,
          "standard": "RESOLUTION_TYPE_UNSPECIFIED",
          "video_bitrate": "1500",
          "video_codec": "VIDEO_CODEC_H264",
          "video_height": 480,
          "video_width": 850
        },
        {
          "audio_bitrate": "96",
          "b_frame": true,
          "codec_profile": "CODEC_PROFILE_AUTO",
          "frame_rate": "FRAME_RATE_30",
          "gop_size": 2,
          "id": "31bb7972-1c87-44c2-a07c-fe9d18321644",
          "level": "CODEC_PROFILE_LEVEL_AUTO",
          "name": "360p-700kbps",
          "preset": false,
          "segment_duration": 6,
          "standard": "RESOLUTION_TYPE_UNSPECIFIED",
          "video_bitrate": "700",
          "video_codec": "VIDEO_CODEC_H264",
          "video_height": 360,
          "video_width": 640
        },
        {
          "audio_bitrate": "64",
          "b_frame": true,
          "codec_profile": "CODEC_PROFILE_AUTO",
          "frame_rate": "FRAME_RATE_30",
          "gop_size": 2,
          "id": "54479d60-c1ba-41fa-898b-3d7fe983b5ac",
          "level": "CODEC_PROFILE_LEVEL_AUTO",
          "name": "240p-400kbps",
          "preset": false,
          "segment_duration": 6,
          "standard": "RESOLUTION_TYPE_UNSPECIFIED",
          "video_bitrate": "400",
          "video_codec": "VIDEO_CODEC_H264",
          "video_height": 240,
          "video_width": 426
        }
      ],
      "protocols": [
        "PROTOCOL_DASH",
        "PROTOCOL_HLS"
      ],
      "smart_abr": false,
      "video_codec": "VIDEO_CODEC_H264"
    },
    "pte": {
      "profile": "PTE_PROFILE_UNSPECIFIED"
    },
    "queue": "QUEUE_STANDARD",
    "schedule": {
      "enable": false,
      "end_time": null,
      "start_time": null
    },
    "security": {
      "domain_control": {
        "domains": [],
        "enabled": false
      },
      "geo_control": [],
      "privacy": {
        "token": null,
        "type": "SECURITY_PRIVACY_TYPE_PUBLIC"
      },
      "protection": {
        "type": "PROTECTION_TYPE_UNSPECIFIED"
      },
      "watermark": {
        "enabled": false,
        "position": "WATERMARK_POSITION_UNSPECIFIED",
        "type": "WATERMARK_TYPE_UNSPECIFIED"
      }
    },
    "source": {
      "cloud_storage": null,
      "library": {
        "subtitles": [
          {
            "code": "en",
            "display": "English",
            "id": "24bc359e-3fe3-4cb6-9278-1a1ceaf35d52",
            "name": "example.srt"
          }
        ],
        "video": {
          "id": "63df97e3-519b-4426-bf01-d1841cdc2ccd"
        }
      },
      "type": "SOURCE_TYPE_LIBRARY"
    },
    "source_file_info": {
      "audios": [
        {
          "bitrate": "128",
          "codec": "AUDIO_CODEC_AAC",
          "lang": "und",
          "sample_rate": "48000"
        }
      ],
      "bitrate": "2337",
      "duration": 300.032,
      "file_name": "video.mp4",
      "size": "92797819",
      "video": {
        "aspect_ratio": "DISPLAY_ASPECT_RATIO_16_9",
        "bitrate": "2337",
        "codec": "VIDEO_CODEC_H264",
        "frame_rate": "FRAME_RATE_UNSPECIFIED",
        "height": 1080,
        "interlace": false,
        "width": 1920
      }
    },
    "status": "VOD_STATUS_SUCCEEDED",
    "stream": [
      {
        "manifests": [
          {
            "protocol": "PROTOCOL_DASH",
            "uris": [
              {
                "resolutions": [
                  {
                    "height": "1080",
                    "width": "1920"
                  },
                  {
                    "height": "720",
                    "width": "1280"
                  },
                  {
                    "height": "480",
                    "width": "854"
                  },
                  {
                    "height": "360",
                    "width": "640"
                  },
                  {
                    "height": "240",
                    "width": "426"
                  }
                ],
                "uri": "https://d3r4shtv85jcno.cloudfront.net/42f6c33e-f632-44e5-8042-05abb5fa2223/vod/dfd6e1a9-3f38-43dc-9966-f35caefe77b5/vod/dash.mpd"
              }
            ]
          },
          {
            "protocol": "PROTOCOL_HLS",
            "uris": [
              {
                "resolutions": [
                  {
                    "height": "1080",
                    "width": "1920"
                  },
                  {
                    "height": "720",
                    "width": "1280"
                  },
                  {
                    "height": "480",
                    "width": "854"
                  },
                  {
                    "height": "360",
                    "width": "640"
                  },
                  {
                    "height": "240",
                    "width": "426"
                  }
                ],
                "uri": "https://d3r4shtv85jcno.cloudfront.net/42f6c33e-f632-44e5-8042-05abb5fa2223/vod/dfd6e1a9-3f38-43dc-9966-f35caefe77b5/vod/hls.m3u8"
              }
            ]
          }
        ],
        "thumbnail": {
          "uri": "https://d3r4shtv85jcno.cloudfront.net/42f6c33e-f632-44e5-8042-05abb5fa2223/vod/dfd6e1a9-3f38-43dc-9966-f35caefe77b5/thumbnail/00/thumbnails.vtt"
        }
      }
    ],
    "updated_at": "2023-05-30T10:43:49Z"
  }
}

A bad request response. The code is 3 means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.

application/json

Schema
Example (from schema)

Schema

code int32

message string

details object[]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

A unauthenticated response. The header authorization was missing or unidentified.

application/json

Schema
Example (from schema)

Schema

code int32

message string

details object[]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

A forbidden response. It means that the provided authorization did not have enough permission to access the resource or the API.

application/json

Schema
Example (from schema)

Schema

code int32

message string

details object[]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

A server error response. There are more HTTP status code mappings listed on here.

application/json

Schema
Example (from schema)

Schema

code int32

message string

details object[]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

Schema
Example (from schema)

Schema

code int32

message string

details object[]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Authorization: authorization

name: authorizationtype: apiKeydescription: Enter the token with Bearer schema prefix, eg. `Bearer <token-string>`in: header

curl
python
go
nodejs
php

CURL

curl -L 'https://api.one.blendvision.com/bv/cms/v1/vods/:id' \
-H 'Accept: application/json' \
-H 'authorization: <API_KEY_VALUE>'

ResponseClear

Click the Send API Request button above and see the response here!

Get VOD

https://api.one.blendvision.com/bv/cms/v1/vods/:id

Request​

Path Parameters

Header Parameters

Responses​

Authorization: authorization

Request

Responses