Vionlabs Docs
API Specs

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)

GET
/results/fingerprintplus/v1/{inventory_id}

Authorization

key<token>

In: query

Path Parameters

inventory_idInventory Id

Customer identifier for a movie or series item in the catalog

Query Parameters

version?Version

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"
      }
    }
  }
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get fingerprint+ data for all items

Get a list of Fingerprint+ metadata for all items

GET
/results/fingerprintplus/v1/list/all

Authorization

key<token>

In: query

Query Parameters

episodes?Episodes

Include episodes

Defaultfalse
version?Version

Specify Fingerprint+ version code

Response Body

curl -X GET "https://loading/results/fingerprintplus/v1/list/all?episodes=false&version=string"
[]
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get fingerprint+ data for items with type movie

Get a list of Fingerprint+ metadata for items with type movie

GET
/results/fingerprintplus/v1/list/all/movies

Authorization

key<token>

In: query

Query Parameters

version?Version

Specify Fingerprint+ version code

Response Body

curl -X GET "https://loading/results/fingerprintplus/v1/list/all/movies?version=string"
[]
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get fingerprint+ data for items with type series

Get a list of Fingerprint+ metadata for items with type series

GET
/results/fingerprintplus/v1/list/all/series

Authorization

key<token>

In: query

Query Parameters

episodes?Episodes

Include episodes

Defaultfalse
version?Version

Specify Fingerprint+ version code

Response Body

curl -X GET "https://loading/results/fingerprintplus/v1/list/all/series?episodes=false&version=string"
[]
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get fingerprints+ updates for all items

Get updates of Fingerprint+ metadata for the specified time window

GET
/results/fingerprintplus/v1/updates/all

Authorization

key<token>

In: query

Query Parameters

last_hours?UpdatesWindowSelector

Choose one of the pre-defined results updates window categories:

  • 24 - Intended for once per day updates integration, time window is 25 hours (24 + 1 hour overlap)
  • 48 - Intended for once per two days updates integration, time window is 49 hours (48 + 1 hour overlap)
Default"24"
version?Version

Specify Fingerprint version code

Response Body

curl -X GET "https://loading/results/fingerprintplus/v1/updates/all?last_hours=24&version=string"
[]
Empty
Empty

Fingerprint+ result for an item

Gets fingerprint+ result status and data for an item in the customer catalog (movie or series)

GET
/results/fingerprintplus/v3/{inventory_id}

Authorization

key<token>

In: query

Path Parameters

inventory_idInventory Id

Customer identifier for a movie or series item in the catalog

Query Parameters

version?Version

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"
        }
      }
    }
  }
}
{
  "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.

GET
/results/fingerprintplus/v3/

Authorization

key<token>

In: query

Query Parameters

from_utcdatetime?From Utcdatetime

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

Formatdate-time
to_utcdatetime?To Utcdatetime

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

Formatdate-time
page_num?Page Num

Specifies a positional number of page with results

Default0
Range0 <= value
page_size?Page Size

Specifies a max number of results per page

Default500
Range1 <= value
type?AssetTypeSelector

Specify type of assets

Default"all"
version?Version

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 Endpoint

Gets vocabularies for all components (moods, genres, keywords, mood_tags) associated with a specific Fingerprint+ version.

GET
/results/fingerprintplus/v3/metadata/vocabularies

Authorization

key<token>

In: query

Query Parameters

version?Version

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"
    }
  ]
}

Vionlabs Emotion API

Vionlabs API for retrieval of content emotion results.

Vionlabs Marker Results API

Vionlabs API for retrieval of marker results (intro/recap skip and end credit detection).

On this page

Get item fingerprint+ metadata
Get fingerprint+ data for all items
Get fingerprint+ data for items with type movie
Get fingerprint+ data for items with type series
Get fingerprints+ updates for all items
Fingerprint+ result for an item
Paginated Fingerprint+ results
Get Vocabularies Endpoint