Vionlabs Docs

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.

GET
/results/vertical_conversion/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

The inventory ID of the asset to get the vertical conversion for

Query Parameters

version?|

Optional vertical conversion result version to fetch. If omitted, the catalog's configured default version is used.

Response Body

application/json

application/json

curl -X GET "https://example.com/results/vertical_conversion/v1/string"
{
  "coordinates": [
    {
      "ts": 0,
      "pts": 0,
      "frm_idx": 0,
      "x_center": 0
    }
  ],
  "upper_black_bar": 0,
  "lower_black_bar": 0,
  "source_frame_width": 0,
  "source_frame_height": 0
}
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
GET
/results/vertical_conversion/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

The inventory ID of the item to get the vertical conversion for

Query Parameters

version?|

The version of the vertical conversion to get

Response Body

application/json

application/json

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