Get configs by resource information
POSThttps://api.one.blendvision.com/bv/playback/v1/resources/configs:resource-info
This api is used to retrieve the configuration information for the resource.
- It'll return a
404
/NotFound
error if any requested resource is not found.
Request
- application/json
Body
required
Required. The uuid of the resource includes live, VOD, and AOD.
Possible values: [RESOURCE_TYPE_LIVE
, RESOURCE_TYPE_VOD
, RESOURCE_TYPE_LIVE_EVENT
, RESOURCE_TYPE_LIVE_EVENT_RECORDING
, RESOURCE_TYPE_VOD_EVENT
, RESOURCE_TYPE_AUDIO_EVENT
, RESOURCE_TYPE_VOD_ENCODING
]
Required. The type of the resource.
Responses
- 200
- 400
- 401
- 403
- 500
- default
A successful response.
- application/json
- Schema
- Example (from schema)
Schema
config object
{
"config": {
"license_key": "string",
"status": "RESOURCE_STATUS_LIVE_SCHEDULED",
"showroom": {
"model": {},
"libraries": [
{
"id": "string",
"name": "string",
"url": "string"
}
]
},
"interaction": {
"poll_enabled": true,
"chatroom": {
"enabled": true,
"theme": "CHATROOM_THEME_LIGHT"
},
"event_id": "string"
},
"cover_image": {
"cover_image_url": "string",
"default_image_url": "string"
},
"player_setting": {
"setting": {},
"id": "string",
"name": "string",
"description": "string",
"libraries": [
{
"id": "string",
"name": "string",
"url": "string"
}
]
},
"chapter_setting": {
"enable": true,
"chapters": [
{
"title": "string",
"timestamp": "string"
}
]
},
"metadata": {
"short_description": "string",
"long_description": "string",
"labels": [
{
"name": "string"
}
]
},
"end_screen": {
"model": {},
"libraries": [
{
"id": "string",
"name": "string",
"url": "string"
}
],
"vods": [
{
"id": "string",
"cover_image": {
"type": "COVER_IMAGE_TYPE_AUTO",
"auto": {
"url": "string",
"name": "string",
"size": "string"
},
"customize": {
"library_id": "string",
"url": "string",
"name": "string",
"size": "string"
},
"updated_at": "2024-07-29T15:51:28.071Z"
}
}
]
},
"auto_tagging": {
"aggregated_tags": [
{
"name": "string",
"count": 0
}
],
"clips": [
{
"id": "string",
"start_time": {
"value": "string"
},
"end_time": {
"value": "string"
},
"title": "string",
"description": "string",
"tags": [
{
"name": "string"
}
],
"thumbnail_uri": "string",
"created_by": "CLIP_CREATED_BY_USER"
}
],
"panel_display": true,
"seek_bar_display": true
},
"title": "string",
"type": "RESOURCE_TYPE_LIVE_EVENT"
}
}
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
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
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
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
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- Schema
- Example (from schema)
Schema
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/playback/v1/resources/configs:resource-info' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'authorization: <API_KEY_VALUE>' \
-d '{
"resource_id": "string",
"resource_type": "RESOURCE_TYPE_LIVE"
}'