Vionlabs Docs

Vionlabs Emotion API

Vionlabs API for retrieval of content emotion results.

Get item emotion result status and data

Gets the emotion result status and data for an item in the customer catalog

GET
/results/emotions/v2/{inventory_id}
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 emotion version code

Response Body

curl -X GET "https://loading/results/emotions/v2/string?version=string"
{
  "status": "success",
  "error": "string",
  "updated": "2019-08-24T14:15:22Z",
  "version_id": "string",
  "inventory_id": "string",
  "type": "movie",
  "data": {
    "inventory_id": "0f275779fd14c747addf3045004907d5",
    "type": "movie",
    "vionlabs_id": "06e2a2e40bd4fa6e",
    "version_id": "op-emotion-v1",
    "emotion": [
      {
        "start_time": 0,
        "end_time": 5,
        "emotions": [
          {
            "surprise": 0.6482031209448723
          }
        ],
        "valence": 0.06063194200396538,
        "arousal": 0.4024266302585602,
        "dominance": -0.16464726626873016
      },
      {
        "start_time": 5,
        "end_time": 10,
        "emotions": [
          {
            "sadness": 0.6262996799841408
          }
        ],
        "valence": -0.18314671516418457,
        "arousal": 0.4077441096305847,
        "dominance": -0.31257230043411255
      }
    ]
  }
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get paginated list of items with emotion results statuses and data ordered by creation/update timestamp

Gets a paginated list of items with the emotion results statuses and data for the customer catalog

GET
/results/emotions/v2/
key<token>

In: query

Query Parameters

from_utcdatetime?From Utcdatetime

Specifies start of time window (ISO 8601). If not specified then all results will be returned

Formatdate-time
to_utcdatetime?To Utcdatetime

Specifies end of time window (ISO 8601). 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 result version code

Response Body

curl -X GET "https://loading/results/emotions/v2/?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": []
}
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}