videos

Get a video

Status, progress, credits and, when completed, the download links

status is queued, processing, completed, failed or cancelled. While it waits, queue says why: plan_limit (the organization already makes as many videos at once as its plan allows; position is its place in line) or render_capacity (every render machine is busy; estimated_wait_seconds is about how long). Completed videos have outputs with download_url (full quality), web_url (720p) and poster_url, signed for 7 days. A lyric video's poster is a frame with one whole lyric line on screen (the hook when it can be), ready to set as the thumbnail where you post it; a Canvas's is its first frame. poster_seconds says where in that file the poster was cut, for posts that take a cover frame offset instead of an image (TikTok); null on videos made before it was kept. Failed videos have error and error_code; AI_VIDEO_UNAVAILABLE means the AI video couldn’t be made for a reason on our side, so make it again later.

get/api/v1/videos/{video_id}

Request

  • Base URL: https://kinetune.com
  • URL: https://kinetune.com/api/v1/videos/{video_id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://kinetune.com/api/auth/oauth2/authorize, token URL https://kinetune.com/api/auth/oauth2/token, scopes: videos:read)

Path parameters

video_idstring required

The video id

Response

OK

idstring required
type'lyric-video' | 'canvas' required
variationinteger required
variation_countinteger required
quote_idstring nullable required
status'queued' | 'processing' | 'completed' | 'failed' | 'cancelled' required
stagestring required

The step it is at while it is made

progressnumber required

0–100

requestobject required

What the video was made from, with your metadata

look_idstring nullable required
lookobject nullable required
canvasobject nullable

A Canvas: its design and, for stock, the credit to show

quoted_creditsnumber nullable required
charged_creditsnumber nullable required
errorstring nullable required
error_codestring nullable required
retry_of_job_idstring nullable required
created_atstring required
updated_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.