Skip to content

Start a video

POST
/v1/videos
curl --request POST \
--url https://api.clipbeat.app/v1/videos \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "song_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "tier": "preview", "style": "example", "character": "example", "aspect": "16:9", "title": "example" }'

Start a video from an imported song (credits are reserved, unused credits are returned).

Media typeapplication/json
object
song_id
required
string format: uuid
tier
string
default: preview
Allowed values: preview standard plus premium
style

World, place and look of the video

string
<= 600 characters
character

Original AI lead (no real or famous people)

string
<= 300 characters
aspect
string
Allowed values: 16:9 9:16
title
string
<= 120 characters

Started

Media typeapplication/json
object
id
string format: uuid
status
string
Allowed values: queued running completed failed canceled
tier
string
Allowed values: preview standard plus premium
title
string | null
aspect
string | null
created_at
string | null format: date-time
progress
object
stage
string | null
done
integer
total
integer
percent
integer
cost
object
credits_reserved
integer
credits_charged
integer
credits_refunded
integer
usd
number
result
object
video_url
string | null
poster_url
string | null
expires_in_sec
integer
error
string

Example

{
"status": "queued",
"tier": "preview"
}

Invalid request

Media typeapplication/json
object
error
required
string
message
required
string
topup_url
string
retry_after_sec
integer

Example generated

{
"error": "example",
"message": "example",
"topup_url": "example",
"retry_after_sec": 1
}

Missing, invalid or revoked API key

Media typeapplication/json
object
error
required
string
message
required
string
topup_url
string
retry_after_sec
integer

Example generated

{
"error": "example",
"message": "example",
"topup_url": "example",
"retry_after_sec": 1
}

Not enough credits (see topup_url)

Media typeapplication/json
object
error
required
string
message
required
string
topup_url
string
retry_after_sec
integer

Example generated

{
"error": "example",
"message": "example",
"topup_url": "example",
"retry_after_sec": 1
}

Key lacks the scope

Media typeapplication/json
object
error
required
string
message
required
string
topup_url
string
retry_after_sec
integer

Example generated

{
"error": "example",
"message": "example",
"topup_url": "example",
"retry_after_sec": 1
}

Not found

Media typeapplication/json
object
error
required
string
message
required
string
topup_url
string
retry_after_sec
integer

Example generated

{
"error": "example",
"message": "example",
"topup_url": "example",
"retry_after_sec": 1
}

Song still processing or another video in progress

Media typeapplication/json
object
error
required
string
message
required
string
topup_url
string
retry_after_sec
integer

Example generated

{
"error": "example",
"message": "example",
"topup_url": "example",
"retry_after_sec": 1
}

Brief rejected or song unusable

Media typeapplication/json
object
error
required
string
message
required
string
topup_url
string
retry_after_sec
integer

Example generated

{
"error": "example",
"message": "example",
"topup_url": "example",
"retry_after_sec": 1
}

Rate limited

Media typeapplication/json
object
error
required
string
message
required
string
topup_url
string
retry_after_sec
integer

Example generated

{
"error": "example",
"message": "example",
"topup_url": "example",
"retry_after_sec": 1
}