Skip to main content
GET
Get a video

Authorizations

Authorization
string
header
required

Send your workspace API key as a bearer token:

Keys are scoped to a single workspace. See Authentication.

Path Parameters

video_id
string
required

The Unif ID of the video.

Query Parameters

currency
string
default:USD

Convert every monetary field to this ISO 4217 currency.

Examples:

"USD"

"GBP"

"IDR"

Response

The video.

A short-form video with products attached.

id
string
Example:

"vid_01k3m9x7v2q8r4t6y0b1n5d7fa"

object
string
Allowed value: "video"
channel
enum<string>

A sales channel — the commerce surface a request is about. Behind each channel is a cascade of data sources, tried in cost order until one verifies; the roster is published, but which source answered a given row is not carried in the response, so the cascade can be re-tuned without breaking your code.

Available options:
tiktok_shop
Example:

"tiktok_shop"

market
enum<string>

An ISO 3166-1 alpha-2 country code identifying a channel storefront.

Available options:
US,
GB,
IE,
ES,
FR,
DE,
IT,
ID,
TH,
VN,
MY,
PH,
SG,
JP,
BR,
MX
Example:

"US"

caption
string | null
url
string<uri>
cover_url
string<uri>
duration_seconds
integer | null
published_at
string<date-time>
creator
object
products
object[]
metrics
object
currency
string
meta
object

How current and how complete this record is.