Optimize Product Video for TikTok
POST/api/products/:product/videos/:video/optimize
Optimize for TikTok: makes a NEW video from a ready one, re-encoded the way TikTok handles best — 1080×1920 (9:16), H.264 30 fps, AAC audio (a silent track is added when the original has none), with the index at the front of the file for fast start. A landscape or square original is scaled to fit and centred over a blurred copy of itself, so it fills the screen instead of showing bars. The original is kept unchanged.
products:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Answers 202 with the new video in processing status; its source_video_id points at the original and its name is the original's with -tiktok.mp4. Poll the video until status is ready (then it carries the usual size, codec and tiktok_fit values) or failed (with failure_reason). Asking again while a copy is being made, or once one is ready, returns that copy instead of making another.
Errors: 422 when the video is not ready yet or is itself an optimized copy.
Authentication: Requires Bearer token (scope products:write). Permission: products.update.
Request
Responses
- 202
- 401
- 403
- 404
- 422
- 429
Accepted
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.