Vionlabs Docs
API Specs

Vionlabs Content Summary API

External docs:SwaggerReDoc

Vionlabs Content Summary API for summarizing information-heavy content (news segments, podcasts).

Get Content Summary

GET
/results/content_summary/v1/{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

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}

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

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/

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
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 Catalog API

Vionlabs API for ingesting and synchronising asset information. Catalog data is central to the operation of the system. To fully understand the models and the implications of operations, developers and integrators should consult the relevant section of the Vionlabs developer documentation.

Vionlabs Contextual Ad Breaks API

Vionlabs API for retrieval of Contextual Ad Breaks results.