Vionlabs Catalog API
Vionlabs API for ingesting and synchronising asset information. Catalog data is central to the operation of the system. To fully understand the models and the implications of operations, developers and integrators should consult the relevant section of the Vionlabs developer documentation.
[DEPRECATED] API key authentication using the X-API-Key HTTP header. Use the 'key' query parameter (?key=YOUR_API_KEY) instead.
In: header
Query Parameters
Specifies a positional number of page with results
00 <= valueSpecifies a max number of results per page
5001 <= valueFlag to indicate whether previously deleted items should be included
falseResponse Body
application/json
application/json
curl -X GET "https://example.com/catalog/v1/item"[
{
"id": "string",
"vionlabs_id": "string",
"type": "standalone"
}
]{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}[DEPRECATED] API key authentication using the X-API-Key HTTP header. Use the 'key' query parameter (?key=YOUR_API_KEY) instead.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X PUT "https://example.com/catalog/v1/item" \ -H "Content-Type: application/json" \ -d '{ "id": "string", "type": "standalone", "title": "string" }'null{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}[DEPRECATED] API key authentication using the X-API-Key HTTP header. Use the 'key' query parameter (?key=YOUR_API_KEY) instead.
In: header
Path Parameters
Item type
"standalone" | "series" | "season" | "episode"Customer identifier for item as specified in catalog
Query Parameters
Flag to indicate whether previously deleted items should be included
falseIf set to true, the item will be returned in the Asset-based model format. Otherwise, the item will be returned in the Metadata-based model format.This flag can only be enabled for episodes.
falseResponse Body
application/json
application/json
curl -X GET "https://example.com/catalog/v1/item/standalone/string"{
"id": "string",
"type": "standalone",
"title": "string",
"virtual": false,
"tag": [
"string"
],
"poster_urls": [
"string"
],
"alternative_lang_title": [
"string"
],
"external_ids": [
{
"provider": "IMDB",
"id": "string"
}
],
"metadata": {
"genres": [
"string"
],
"keywords": [
"string"
],
"categorized_keywords": [
{
"category": "string",
"keyword": "string"
}
],
"cast": [
"string"
],
"roles": [
"string"
],
"crew": [
{
"crew_member": "Jill Smith",
"role": "producer"
}
],
"short_description": "string",
"long_description": "string"
},
"ratings": [
{
"rating": "PG-13",
"scheme": "MPAA"
}
],
"window_info": {
"start": "string",
"end": "string"
},
"release_year": 1901,
"logo_urls": {
"property1": "string",
"property2": "string"
},
"episodic_info": {
"series_id": "string",
"season_id": "string",
"season_number": 1,
"episode_number": 1
},
"extended_episodic_info": {
"series_id": "string",
"series_title": "string",
"season_id": "string",
"season_title": "string",
"season_number": 1,
"episode_number": 1
},
"asset_info": {
"file_uri": "string",
"video_playback_uri": "string",
"duration": 1,
"asset_params": {}
},
"operations": {
"deleted": false,
"force_asset_reprocess": false
},
"timestamp": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}[DEPRECATED] API key authentication using the X-API-Key HTTP header. Use the 'key' query parameter (?key=YOUR_API_KEY) instead.
In: header
Path Parameters
Item type
"standalone" | "series" | "season" | "episode"Customer identifier for item as specified in catalog
Response Body
application/json
application/json
curl -X PUT "https://example.com/catalog/v1/delete/standalone/string"null{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}