A video is finished
POSTed to the request's callback_url once the video is completed, failed or cancelled: the video as get_video returns it. Kinetune-Signature is t=,v1=<hex HMAC-SHA256 of "."> with your callback secret. Answer with any 2xx within 10 seconds; anything else is retried after 30 s, 2 min, 10 min, 30 min and 2 h.
Kinetune-Event*stringValue in
"video.completed""video.failed""video.cancelled"Kinetune-Delivery*stringA new id for every attempt
Format
uuidKinetune-Signature*stringapplication/json- body
id*stringtype*stringValue in
"lyric-video""canvas""music-video"variation*integerRange
-9007199254740991 <= value <= 9007199254740991variation_count*integerRange
-9007199254740991 <= value <= 9007199254740991quote_id*string|nullstatus*stringValue in
"queued""processing""completed""failed""cancelled"stage*stringThe step it is at while it is made
progress*number0–100
queue*|Why the video is waiting, while it waits (its plan's limit, or every render machine busy); null otherwise
outputs*array<>One file per format, once delivered
song*request*What the video was made from, with your metadata
look_id*string|nulllook*|nullcanvas?|A Canvas: its design and, for stock, the credit to show
music_video?|A music video's plan, once the director made it (null before)
quoted_credits*number|nullcharged_credits*number|nullerror*string|nullerror_code*string|nullretry_of_job_id*string|nullcreated_at*stringupdated_at*string[key: string]?unknownReceived
Example Requests
POST/video
application/json
{
"id": "string",
"type": "lyric-video",
"variation": -9007199254740991,
"variation_count": -9007199254740991,
"quote_id": "string",
"status": "queued",
"stage": "string",
"progress": 0,
"queue": {
"reason": "plan_limit",
"position": -9007199254740991,
"estimated_wait_seconds": -9007199254740991
},
"outputs": [
{
"aspect_ratio": "9:16",
"poster_seconds": 0,
"property1": null,
"property2": null
}
],
"song": {
"id": "string",
"title": "string",
"artist_name": "string"
},
"request": {
"property1": null,
"property2": null
},
"look_id": "string",
"look": {
"property1": null,
"property2": null
},
"quoted_credits": 0,
"charged_credits": 0,
"error": "string",
"error_code": "string",
"retry_of_job_id": "string",
"created_at": "string",
"updated_at": "string",
"property1": null,
"property2": null
}{
"Kinetune-Event": "video.completed",
"Kinetune-Delivery": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"Kinetune-Signature": "string"
}