Vionlabs Docs
API Specs

Vionlabs Scene-Level Video-Text Retrieval API

The Scene Retrieval API offers semantic search capabilities for scenes across video asset(s).

Get Text Embedding

GET
/results/semantic_scenes/v1/text-embedding

Authorization

X-API-Key<token>

[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

q*Q

A text query for which to get a text-retrieval embedding.

version?|

Version of the model to use

Response Body

application/json

application/json

curl -X GET "https://example.com/results/semantic_scenes/v1/text-embedding?q=car+chase"
{
  "version_id": "string",
  "embedding": [
    0.11,
    0.2,
    "... (1024 floats total)",
    -0.11,
    0.99
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Scene Embeddings

GET
/results/semantic_scenes/v1/video-embedding/{inventory_id}

Authorization

X-API-Key<token>

[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

inventory_id*Inventory Id

Customer's identifier for a catalog item

Query Parameters

version?|

Version of the model to use

Response Body

application/json

application/json

curl -X GET "https://example.com/results/semantic_scenes/v1/video-embedding/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",
    "scene_embeddings": [
      {
        "start_ts": 0,
        "end_ts": 0,
        "embedding": [
          0.11,
          0.2,
          "... (1024 floats total)",
          -0.11,
          0.99
        ]
      }
    ]
  }
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Gets Vionlabs text-retrieval embeddings result status for the asset

GET
/results/semantic_scenes/v1/status/{inventory_id}

Authorization

X-API-Key<token>

[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

inventory_id*Inventory Id

Customer's identifier for a catalog item

Query Parameters

version?|

Version of the model to use

Response Body

application/json

application/json

curl -X GET "https://example.com/results/semantic_scenes/v1/status/string"
{
  "status": "success",
  "error": "string",
  "updated": "2019-08-24T14:15:22Z",
  "version_id": "string",
  "inventory_id": "string",
  "type": "movie"
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Processing Statuses

GET
/results/semantic_scenes/v1/video-embedding

Authorization

X-API-Key<token>

[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

from_utcdatetime?|

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

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

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
include_episodes?|
Defaultfalse
version?|

Product version code

Response Body

application/json

application/json

curl -X GET "https://example.com/results/semantic_scenes/v1/video-embedding"
{
  "page_num": 0,
  "page_size": 0,
  "total_count": 0,
  "data": [
    {
      "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"
    }
  ]
}

Vionlabs Previews API

Vionlabs API for on-request assembling of previews results.

Vionlabs Tasks API

Vionlabs API for creating, retrieving and deactivating processing tasks for catalog assets and product versions. Tasks are used to orchestrate processing and expose the current state of requested work across the system.