Skip to content

Get a song

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

Song status (wait for status ready before starting a video).

id
required
string format: uuid

Song

Media typeapplication/json
object
id
string format: uuid
title
string | null
duration_sec
number | null
status
string
Allowed values: processing ready
lyrics_status
string
Allowed values: processing ready failed
created_at
string | null format: date-time

Example

{
"status": "processing",
"lyrics_status": "processing"
}

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
}