Vionlabs Docs
API Specs

Vionlabs Vertical Conversion API

GET
/results/vertical_conversion/v1/{inventory_id}

Get vertical conversion data for an asset.

The response describes where the camera should focus horizontally for every frame of the source video, expressed as x_center pixel coordinates in the source frame's coordinate system. It also reports the upper_black_bar / lower_black_bar positions and the source frame dimensions.

The output is independent of any output aspect ratio. To produce a vertical (or any other aspect-ratio) crop, the consumer chooses the crop width around x_center and uses the black-bar positions for the crop's top and bottom. This endpoint accepts no aspect-ratio, framing, or cropping parameters — none are needed.

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

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}

Get vertical conversion result status for an asset.

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

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"
    }
  ]
}