Vionlabs Fingerprint+ API
Vionlabs API for retrieval of content fingerprint results plus additional metadata.
[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
Customer's identifier for a catalog item
Query Parameters
Specify Fingerprint+ version code
Response Body
application/json
application/json
curl -X GET "https://example.com/results/fingerprintplus/v3/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": {
"High Octane": 1
},
"genre": {
"action": 0.98,
"martial art": 0.9,
"thriller": 0.93
},
"keyword": {
"crime boss": 1,
"crime family": 0.95,
"crime syndicate": 0.94
},
"mood_tag": {
"revenge": 0.99,
"suspenseful": 1,
"violent": 0.99
},
"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"
},
"pl": {
"synopsis_short": "string",
"synopsis_long": "string"
},
"pt": {
"synopsis_short": "string",
"synopsis_long": "string"
},
"th": {
"synopsis_short": "string",
"synopsis_long": "string"
}
},
"error": "string"
}
}
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}[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
Customer's identifier for a catalog item
Query Parameters
Specify Fingerprint+ version code
Response Body
application/json
application/json
curl -X GET "https://example.com/results/fingerprintplus/v3/status/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"
}
]
}[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 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
Specifies 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
Specifies a positional number of page with results
00 <= valueSpecifies a max number of results per page
5001 <= valueSpecify type of assets
"all""all" | "movie" | "series" | "seasons" | "series_and_episodes" | "seasons_and_episodes" | "series_and_seasons_and_episodes" | "movie_and_series"Specifies Fingerprint+ version code
Response Body
application/json
application/json
curl -X GET "https://example.com/results/fingerprintplus/v3/"{
"page_num": 0,
"page_size": 0,
"total_count": 0,
"data": []
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}[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
Fingerprint+ version code
Response Body
application/json
application/json
curl -X GET "https://example.com/results/fingerprintplus/v3/metadata/vocabularies"{
"version": "11.7",
"mood": [
"Cerebral Thrills",
"Dark & Gritty",
"Heartwarming Family",
"Love & Romance",
"Uplifting & Feelgood"
],
"genre": [
"action",
"drama",
"comedy",
"thriller"
],
"keyword": [
"car chase",
"romance",
"explosion",
"dialogue"
],
"moodtag": [
"atmospheric",
"dark",
"feel-good",
"intense",
"moody",
"suspenseful",
"tense",
"uplifting"
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}[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
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
application/json
application/json
curl -X GET "https://example.com/results/fingerprintplus/v3/similar/string"{
"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"
}
]
}[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
Customer's identifier for a catalog item
Query Parameters
Specify Fingerprint+ version for the query title embedding
Number of items to return in list.
501 <= value <= 75Response Body
application/json
application/json
curl -X GET "https://example.com/results/fingerprintplus/v3/similar/gfp/string"{
"similar": [
{
"type": "string",
"imdb_id": "string",
"title": "string",
"year": 0,
"score": 0
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}