Skip to content

Get a video

GET
/v1/videos/{id}
curl --request GET \
--url https://api.clipbeat.app/v1/videos/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>'

Video status, progress, cost and download link when completed.

id
required
string format: uuid

Video

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"
}

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 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
}