Vionlabs Docs
API Specs

Vionlabs Content Summary API

External docs:SwaggerReDoc

Get Content Summary

GET
/results/content_summary/v1/{inventory_id}

Gets content summary for the asset with the specified inventory identifier.

Authorization

AuthorizationBearer <token>

Stytch access token authentication. Requires BOTH:

  • Authorization: Bearer ACCESS_TOKEN
  • catalog query parameter

Example: Authorization: Bearer ACCESS_TOKEN ?catalog=my_catalog

In: header

Path Parameters

inventory_id*Inventory Id

Query Parameters

version?|

Specify content summary version code

Response Body

application/json

application/json

curl -X GET "https://example.com/results/content_summary/v1/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",
    "content_summary": {
      "sections": [
        {
          "title": "string",
          "start": 0,
          "end": 0,
          "summary": "string",
          "keywords": [
            "string"
          ]
        }
      ],
      "summary": "string",
      "keywords": [
        "string"
      ],
      "translations": {
        "property1": {
          "sections": [
            {
              "title": "string",
              "start": 0,
              "end": 0,
              "summary": "string",
              "keywords": [
                "string"
              ]
            }
          ],
          "summary": "string",
          "keywords": [
            "string"
          ]
        },
        "property2": {
          "sections": [
            {
              "title": "string",
              "start": 0,
              "end": 0,
              "summary": "string",
              "keywords": [
                "string"
              ]
            }
          ],
          "summary": "string",
          "keywords": [
            "string"
          ]
        }
      }
    }
  }
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Gets content summary result status for the asset

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

Gets content summary result status for the asset with the specified inventory identifier.

Authorization

AuthorizationBearer <token>

Stytch access token authentication. Requires BOTH:

  • Authorization: Bearer ACCESS_TOKEN
  • catalog query parameter

Example: Authorization: Bearer ACCESS_TOKEN ?catalog=my_catalog

In: header

Path Parameters

inventory_id*Inventory Id

Query Parameters

version?|

Specify content summary version code

Response Body

application/json

application/json

curl -X GET "https://example.com/results/content_summary/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 paginated list of items with the content summary results statuses and data ordered by creation/update timestamp

GET
/results/content_summary/v1/

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

Authorization

AuthorizationBearer <token>

Stytch access token authentication. Requires BOTH:

  • Authorization: Bearer ACCESS_TOKEN
  • catalog query parameter

Example: Authorization: Bearer ACCESS_TOKEN ?catalog=my_catalog

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

Specifies result version code

Response Body

application/json

application/json

curl -X GET "https://example.com/results/content_summary/v1/"
{
  "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",
      "data": {
        "inventory_id": "string",
        "type": "movie",
        "vionlabs_id": "string",
        "version_id": "string",
        "content_summary": {
          "sections": [
            {
              "title": "string",
              "start": 0,
              "end": 0,
              "summary": "string",
              "keywords": [
                "string"
              ]
            }
          ],
          "summary": "string",
          "keywords": [
            "string"
          ],
          "translations": {
            "property1": {
              "sections": [
                {
                  "title": "string",
                  "start": 0,
                  "end": 0,
                  "summary": "string",
                  "keywords": [
                    "string"
                  ]
                }
              ],
              "summary": "string",
              "keywords": [
                "string"
              ]
            },
            "property2": {
              "sections": [
                {
                  "title": "string",
                  "start": 0,
                  "end": 0,
                  "summary": "string",
                  "keywords": [
                    "string"
                  ]
                }
              ],
              "summary": "string",
              "keywords": [
                "string"
              ]
            }
          }
        }
      }
    }
  ]
}
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Vionlabs Previews API

Vionlabs API for on-request assembling of previews results.

Vionlabs Vertical Conversion API

Vionlabs API for retrieving vertical conversion data, used to reframe a horizontal source video into a vertical crop without losing the subject of interest. For each frame, the response gives an x_center coordinate (in source-pixel units) saying where the camera should focus horizontally, plus the detected upper and lower black bar positions and the source frame dimensions. The API does not return a cropped video. Aspect ratio is independent of the conversion: the output is not tied to any specific output ratio (9:16, 4:5, 1:1, ...); the consumer picks one at render time by choosing how much of the source to include around x_center. Accordingly, the endpoint accepts no aspect-ratio, framing, or cropping parameters, only an optional version.