Get content metadata

GET 
https://api.one.blendvision.com/bv/playback/v1/contents

Fetches metadata associated with a specific content using the provided playback token for authorization.

---

• Returns a 401/Unauthenticated if the playback token is not valid.
• Returns a 404/NotFound if the requested content metadata is not found.

Request

Header Parameters

authorization string

This API should be invoked with playback token.

Responses

200

A successful response.

application/json

Schema

Schema

id uuid

Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Output only. The unique id of resource (live/vod).

title string

Output only. The title of resource (live/vod).

is_ended boolean

Output only. The field indicating the live event is ended or not.

player_setting object

Output only. The settings for the player.

template string

Possible values: [TEMPLATE_STANDALONE, TEMPLATE_EMBEDDED]

Output only. The template of the player.

features object[]

Output only. The features provided by player.

Array [

name string

Possible values: [FEATURE_NAME_PSE, FEATURE_NAME_ULL]

]

share object

Output only. The share links provided by player.

url string

show_iframe_tag boolean

description string

Output only. The description that will be displayed in the player.

color string

Output only. The color of the player.

cover_image_url string

Output only. The cover image url of the player.

default_image_url string

Output only. The default cover image url of the player, it is used to display in the unexpected case.

watermark object

Output only. The watermark information of the player.

position string

Possible values: [POSITION_BOTTOM_RIGHT, POSITION_BOTTOM_MIDDLE, POSITION_BOTTOM_LEFT, POSITION_CENTER_RIGHT, POSITION_CENTER_LEFT, POSITION_TOP_RIGHT, POSITION_TOP_MIDDLE, POSITION_TOP_LEFT, POSITION_RANDOM, POSITION_CUSTOM]

image_url string

text string

size float

offset object

x int32required

Required. The x-axis position of the watermark. Represented as a percentage of the image width. The range of values that can be set is from 1 to 100.

y int32required

Required. The y-axis position of the watermark. Represented as a percentage of the image height. The range of values that can be set is from 1 to 100.

tenant_id string

Output only. The unique id of tenant.

playable boolean

Output only. The field indicating the resource is in playable state or not.

type string

Possible values: [RESOURCE_TYPE_LIVE_EVENT, RESOURCE_TYPE_LIVE_EVENT_RECORDING, RESOURCE_TYPE_VOD_EVENT, RESOURCE_TYPE_AUDIO_EVENT]

Output only. The type of resource.

assoc_resource_id string

Output only. The associate resource id, including vod_encoding id, it's used for later analytics.

assoc_resource_type string

Possible values: [RESOURCE_TYPE_VOD_ENCODING]

Output only. The associate resource type. It is used for later analytics.

last_watched_position int64

Output only. The last watched position, in seconds. The API caller can use this field to resume the playback from the last watched position.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "is_ended": true,
  "player_setting": {
    "template": "TEMPLATE_STANDALONE",
    "features": [
      {
        "name": "FEATURE_NAME_PSE"
      }
    ],
    "share": {
      "url": "string",
      "show_iframe_tag": true
    },
    "description": "string",
    "color": "string",
    "cover_image_url": "string",
    "default_image_url": "string",
    "watermark": {
      "position": "POSITION_BOTTOM_RIGHT",
      "image_url": "string",
      "text": "string",
      "size": 0,
      "offset": {
        "x": 0,
        "y": 0
      }
    }
  },
  "tenant_id": "string",
  "playable": true,
  "type": "RESOURCE_TYPE_LIVE_EVENT",
  "assoc_resource_id": "string",
  "assoc_resource_type": "RESOURCE_TYPE_VOD_ENCODING",
  "last_watched_position": 0
}

400

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

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

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

401

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

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

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

403

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

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

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

500

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

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

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

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "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/playback/v1/contents' \
-H 'Accept: application/json' \
-H 'authorization: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://api.one.blendvision.com

Auth

BearerTokenAuth

Parameters

authorization — header

ResponseClear

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