Vionlabs Fingerprint+ API
Vionlabs API for retrieval of content fingerprint results plus additional metadata.
Get item fingerprint+ metadata
Gets Fingerprint+ for an item in the customer catalog (movie or series)
In: header
Path Parameters
Customer's identifier for a catalog item
Query Parameters
Specify Fingerprint+ version code
Response Body
curl -X GET "https://loading/results/fingerprintplus/v1/string?version=string"{
"inventory_id": "string",
"type": "movie",
"vionlabs_id": "string",
"version_id": "string",
"fingerprint": [
0
],
"mood": {
"property1": 0,
"property2": 0
},
"genre": {
"property1": 0,
"property2": 0
},
"keyword": {
"property1": 0,
"property2": 0
},
"mood_tag": {
"property1": 0,
"property2": 0
},
"language": {
"main": "string"
},
"synopsis": {
"synopsis_short": "string",
"synopsis_long": "string",
"synopses": {
"de": {
"synopsis_short": "string",
"synopsis_long": "string"
},
"en": {
"synopsis_short": "string",
"synopsis_long": "string"
},
"es": {
"synopsis_short": "string",
"synopsis_long": "string"
},
"fr": {
"synopsis_short": "string",
"synopsis_long": "string"
},
"ja": {
"synopsis_short": "string",
"synopsis_long": "string"
},
"nl": {
"synopsis_short": "string",
"synopsis_long": "string"
},
"pt": {
"synopsis_short": "string",
"synopsis_long": "string"
},
"th": {
"synopsis_short": "string",
"synopsis_long": "string"
}
}
}
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Fingerprint+ result status and data for an item
Gets fingerprint+ result status and data for an item in the customer catalog (movie or series)
In: header
Path Parameters
Customer's identifier for a catalog item
Query Parameters
Specify Fingerprint+ version code
Response Body
curl -X GET "https://loading/results/fingerprintplus/v3/string?version=string"{
"status": "success",
"error": "string",
"updated": "2019-08-24T14:15:22Z",
"version_id": "string",
"inventory_id": "string",
"type": "movie",
"data": {
"inventory_id": "string",
"type": "movie",
"vionlabs_id": "string",
"version_id": "string",
"fingerprint": [
0
],
"mood": {
"property1": 0,
"property2": 0
},
"genre": {
"property1": 0,
"property2": 0
},
"keyword": {
"property1": 0,
"property2": 0
},
"mood_tag": {
"property1": 0,
"property2": 0
},
"language": {
"main": "string"
},
"synopsis": {
"synopsis_short": "string",
"synopsis_long": "string",
"synopses": {
"de": {
"synopsis_short": "string",
"synopsis_long": "string"
},
"en": {
"synopsis_short": "string",
"synopsis_long": "string"
},
"es": {
"synopsis_short": "string",
"synopsis_long": "string"
},
"fr": {
"synopsis_short": "string",
"synopsis_long": "string"
},
"ja": {
"synopsis_short": "string",
"synopsis_long": "string"
},
"nl": {
"synopsis_short": "string",
"synopsis_long": "string"
},
"pt": {
"synopsis_short": "string",
"synopsis_long": "string"
},
"th": {
"synopsis_short": "string",
"synopsis_long": "string"
}
}
}
}
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Fingerprint+ result status for an item
Gets fingerprint+ result status for an item in the customer catalog (movie or series)
In: header
Path Parameters
Customer's identifier for a catalog item
Query Parameters
Specify Fingerprint+ version code
Response Body
curl -X GET "https://loading/results/fingerprintplus/v3/status/string?version=string"{
"status": "success",
"error": "string",
"updated": "2019-08-24T14:15:22Z",
"version_id": "string",
"inventory_id": "string",
"type": "movie"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Paginated Fingerprint+ results
Gets a paginated list of items with Fingerprint+ results statuses and data for the customer catalog.
The parameters from_utcdatetime and to_utcdatetime filter by the moment when
processing of the Fingerprint+ product finished for an asset (UTC timestamps).
Example:
To retrieve items whose processing finished between 2024-03-06T20:00:00 and
2024-03-07T20:00:00, call the endpoint with:
from_utcdatetime=2024-03-06T20:00:00&to_utcdatetime=2024-03-07T20:00:00.
In: header
Query Parameters
Specifies the start of the UTC time window (ISO 8601) for items whose Fingerprint+ processing finished at or after this time. If not specified then all results will be returned
date-timeSpecifies the end of the UTC time window (ISO 8601) for items whose Fingerprint+ processing finished at or before this time. If not specified then utcnow() value will be used. It is recommended to fix this argument while looping across pages to establish a fixed time window
date-timeSpecifies a positional number of page with results
00 <= valueSpecifies a max number of results per page
5001 <= valueSpecify type of assets
"all"Specifies Fingerprint+ version code
Response Body
curl -X GET "https://loading/results/fingerprintplus/v3/?from_utcdatetime=2024-03-06T20%3A00%3A00&to_utcdatetime=2024-03-07T20%3A00%3A00&page_num=0&page_size=500&type=all&version=string"{
"page_num": 0,
"page_size": 0,
"total_count": 0,
"data": []
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Vocabularies
Gets vocabularies for all components (moods, genres, keywords, mood_tags) associated with a specific Fingerprint+ version.
In: header
Query Parameters
Fingerprint+ version code
Response Body
curl -X GET "https://loading/results/fingerprintplus/v3/metadata/vocabularies?version=string"{
"version": "11.7",
"mood": [
"high energy science fiction",
"dark crime",
"emotional tearjerker"
],
"genre": [
"action",
"drama",
"comedy",
"thriller"
],
"keyword": [
"car chase",
"romance",
"explosion",
"dialogue"
],
"moodtag": [
"intense",
"relaxing",
"inspiring",
"dark"
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Similar Titles
Get a list of similar items to the specified customer inventory id from the customer catalog.
Use the asset_type query parameter to filter by movies, series, or both (default).
Query parameters skip and count can be used to accumulate longer lists over multiple calls.
In: header
Path Parameters
Customer's identifier for a catalog item
Query Parameters
Type of similar items to return. If not specified, all types are returned
Specify Fingerprint+ version for the similarity lists
Number of items to skip from beginning of list
Number of items to return in list
Response Body
curl -X GET "https://loading/results/fingerprintplus/v3/similar/string?asset_type=movie&version=string&skip=0&count=0"{
"inventory_id": "string",
"type": "movie",
"vionlabs_id": "string",
"last_updated": "2019-08-24T14:15:22Z",
"version_id": "string",
"similar": [
{
"inventory_id": "string",
"type": "movie",
"vionlabs_id": "string",
"score": 0
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}