Skip to main content

Get file

GET 

/bv/cms/v1/library/files/:id

Returns the specified File resource.


Required field(s):

  • id

Request

Path Parameters

    id stringrequired

    Required.

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.

Schema
    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]

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

    attrs object
    property name* string
    has_subtitle Output Only. Indicate the video has subtitle or not when the file type is `FILE_TYPE_VIDEO` (boolean)
    subtitles object[]
  • Array [
  • id string

    The unique id of the subtitle.

    library_id string

    The unique id of the library subtitle file.

    name string

    The name of the subtitle file.

    code string

    The language code of the subtitle file. Follow RFC 5646 (shortest ISO 639 code).

    display string

    The display name of the subtitle file.

  • ]
  • status string

    Possible values: [FILE_STATUS_SUCCEED, FILE_STATUS_PROGRESSING, FILE_STATUS_FAILED]

    Output Only. The file status.

    created_at date-time

    Output only.

    updated_at date-time

    Output only.

Loading...