Back to top

Vidrovr API - v0.1

Authors

Vidrovr Inc.

Vidrovr API

This document details the methods and endpoints that can be used to interface with the Vidrovr solution. This includes all parameters for querying and retrieving metadata, interfacing with our multimodal search solution, and obtaining the video assets that appear in a user’s account for Vidrovr.

Get API Version

This gets the version of the API that is being used

Retrieve API version
GET/get_api_version

Example URI

GET https://platform.vidrovr.com/public/api/v01/get_api_version
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "Hello, world!",
  "version": "Hello, world!",
  "methods": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "API Name"
    },
    "version": {
      "type": "string",
      "description": "API Version"
    },
    "methods": {
      "type": "string",
      "description": "API Endpoints"
    }
  }
}

Get Mapping of Video Asset

Get mapping information mapping the hashed identifier of the chunk or full asset and name of uploaded content to the Vidrovr system.

Get Video Mappings
GET/get_asset_mapping{?asset_type,id,api_key}

Example URI

GET https://platform.vidrovr.com/public/api/v01/get_asset_mapping?asset_type=&id=&api_key=
URI Parameters
HideShow
asset_type
string (required) 

Type of asset id you are providing (‘chunk’ vs ‘asset’)

id
string (required) 

id of asset being provided

api_key
string (required) 

User Specific API Key

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "asset_id": "5eda9cfa873799cd20c4ec45f556e5193ea07fda",
  "chunks": [
    "5eda9cfa873799cd2",
    "5eda9cfa873799cd2"
  ],
  "name": "test_123"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "asset_id": {
      "type": "string",
      "description": "1859-4ab7-9dff-0d103b83b1cf (string) - id of parent asset"
    },
    "chunks": {
      "type": "array",
      "description": "array of ids of chunks"
    },
    "name": {
      "type": "string",
      "description": "name of primary asset"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: applicaiton/json
Body
{
  "asset_id": "5eda9cfa873799cd20c4ec45f556e5193ea07fda",
  "name": "test_123"
}
Schema
{
  "type": "object",
  "properties": {
    "asset_id": {
      "type": "string",
      "description": "1859-4ab7-9dff-0d103b83b1cf (string) - id of chunk asset"
    },
    "name": {
      "type": "string",
      "description": "name of primary asset"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

List Videos

This lists the videos that are in a particular account for a given company.

Retrieve Videos in Vidrovr
GET/get_video_list{?order,start_date,stop_date,limit,offset,api_key}

Example URI

GET https://platform.vidrovr.com/public/api/v01/get_video_list?order=&start_date=&stop_date=&limit=&offset=&api_key=
URI Parameters
HideShow
order
string (optional) Default: 'desc' 

Possible: ['desc, ‘asc’]. The order in which to return the video assets, this is ordered by sequential id.

start_date
number (optional) Default: 0 

Epoch Time w/ respect to UTC

stop_date
number (optional) Default: today 

Epoch Time w/ respect to UTC

limit
number (optional) Default: 10 

Max: 100. The number of videos to return in the list.

offset
number (optional) Default: 10 

The number of videos shifted in the return

api_key
string (required) 

User Specific API Key

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "creation_date": 1477933369688,
    "name": "Demo",
    "id": "2ef39e06e877d92d698efb0013832e8bd94730a6",
    "finished_all_processing": true,
    "failed": false
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Return Metadata for Uploaded Asset

Metadata returned object has the following attributes:

Retrieve Metadata
GET/get_metadata{?id,api_key,transcript}

Example URI

GET https://platform.vidrovr.com/public/api/v01/get_metadata?id=&api_key=&transcript=
URI Parameters
HideShow
id
string (required) 

id of the asset to be returned

api_key
string (required) 

User Specific API Key

transcript
string (optional) 

retrieve full transcript without timestamp, will replace audio_words, needs to be set to true

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "2ef39e06e877d92d698efb0013832e8bd94730a6",
  "creation_date": 1477933369688,
  "name": "2ef39e06e877d92d698efb0013832e8bd94730a6",
  "on_screen_text": [
    {
      "text": "LIVE",
      "frame_start": 29,
      "frame_stop": 585,
      "x": 34,
      "y": 20,
      "w": 39,
      "h": 15
    }
  ],
  "person_identification": [
    {
      "person": "Unknown",
      "frame_start": 29,
      "frame_stop": 585
    }
  ],
  "tags": [
    {
      "tag": "Fountain",
      "frame_start": 29,
      "frame_stop": 585
    }
  ],
  "scenes": [
    {
      "scene": "'Television Studio'",
      "frame_start": 29,
      "frame_stop": 585
    }
  ],
  "audio_words": [
    {
      "start": 0.54,
      "end": 0.76,
      "word 'Vidrovr'": ""
    }
  ],
  "thumbnail": "https://platform.vidrovr.com/api/thumbnail_url",
  "transcipt": []
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "id as requested in the api call"
    },
    "creation_date": {
      "type": "number",
      "description": "creation date in standard epoch time in ms"
    },
    "name": {
      "type": "string",
      "description": "name of the file that was assigned by the creator"
    },
    "on_screen_text": {
      "type": "array",
      "description": "array of on screen text"
    },
    "person_identification": {
      "type": "array",
      "description": "array of person detected"
    },
    "tags": {
      "type": "array",
      "description": "array of assigned tags"
    },
    "scenes": {
      "type": "array",
      "description": "array of assigned scenes"
    },
    "audio_words": {
      "type": "array"
    },
    "thumbnail": {
      "type": "string",
      "description": "thumbnail url for the video asset"
    },
    "transcipt": {
      "type": "array"
    }
  }
}

Search Audio

Vidrovr Audio search that looks for exact or fuzzy match of particular words across a user’s video assets.

Search Audio
GET/search_audio{?query,api_key,max_results,search_type}

Example URI

GET https://platform.vidrovr.com/public/api/v01/search_audio?query=&api_key=&max_results=&search_type=
URI Parameters
HideShow
query
string (required) 

Query string used to search over the vidrovr dataset

api_key
string (required) 

User Specific API Key

max_results
number (optional) Default: 20 

The number of maximum returned results

search_type
string (optional) Default: "exact" 

Type of search to perform. Possible: [“exact”, “fuzzy”]

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "score": 10.73,
    "word_index": 121,
    "rerank_score": 0.228,
    "id": "2ef39e06e877d92d698efb0013832e8bd94730a6",
    "time": 38.75
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Search Boolean

Vidrovr Boolean search creates logical AND intersections across different types of filters - content / people / tags

Default returns all data produced You may request clips for the returns which the query will return filtered by setting clip parameter to True. If using clips you may in turn set the thresholds of how strictly to filter 0-100 – representing fuzzy match scores.

Search Boolean
GET/search_boolean{?content_filter,people_filter,tags_filter,api_key,clips,max_results}

Example URI

GET https://platform.vidrovr.com/public/api/v01/search_boolean?content_filter=&people_filter=&tags_filter=&api_key=&clips=&max_results=
URI Parameters
HideShow
content_filter
array[string] (required) 

Query string array for searching content

people_filter
array[string] (required) 

Query string array for searching people

tags_filter
array[string] (required) 

Query string array for searching tags

api_key
string (required) 

User Specific API Key

clips
boolean (optional) Default: [80,70,80] --> 

Setting to set whether your would like to generate clips.

max_results
number (optional) Default: 20 

The number of maximum returned results

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "score": 10.73,
    "creation_date": 1477933369688,
    "name": "Demo",
    "id": "2ef39e06e877d92d698efb0013832e8bd94730a6",
    "failed": false,
    "scene_detection": [
      {
        "scene": "'Television Studio'",
        "frame_start": 29,
        "frame_stop": 585
      }
    ],
    "tag_detections": [
      {
        "tag": "Fountain",
        "frame_start": 29,
        "frame_stop": 585
      }
    ],
    "person_detections": [
      {
        "person": "Unknown",
        "frame_start": 29,
        "frame_stop": 585
      }
    ],
    "ocr_detections": [
      {
        "text": "LIVE",
        "frame_start": 29,
        "frame_stop": 585,
        "x": 34,
        "y": 20,
        "w": 39,
        "h": 15
      }
    ],
    "audio_words": [
      {
        "start": 0.54,
        "end": 0.76,
        "word 'Vidrovr'": "Hello, world!"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Log Video Publish

This is part of a publishing flow and enables the search to increase the quality of results based on usage. It also enables Vidrovr to track value add.

Log Video Publish
POST/log_video_publish{?video_id,api_key}

Example URI

POST https://platform.vidrovr.com/public/api/v01/log_video_publish?video_id=&api_key=
URI Parameters
HideShow
video_id
string (optional) 

Vidrovr video id, to link asset that syste

api_key
string (required) 

User Specific API Key

Response  200
HideShow
Headers
Content-Type: application/json

Generated by aglio on 27 Nov 2017