Skip to main content
POST
Audio-to-Video

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <api_key>, where <api_key> is your API key. To get your API key, go to Developer Hub and click "Create new API Key".

Body

application/json

Body

end_seconds
number<float>
required

End time of your clip (seconds). Must be greater than start_seconds.

Required range: x >= 0.1
Example:

15

assets
object
required

Provide the audio file and an optional reference image.

name
string
default:Audio To Video - dateTime

Give your video a custom name for easy identification.

Example:

"My Audio To Video video"

start_seconds
number<float>
default:0

Start time of your clip (seconds). Must be ≥ 0.

Required range: x >= 0
Example:

0

resolution
enum<string>

Output video resolution. Defaults to 720p on paid tiers and 480p on free tiers.

Available options:
480p,
720p,
1080p
Example:

"720p"

style
object

Attributes used to dictate the style of the output

Response

Success

Success

id
string
required

Unique ID of the video. Use it with the Get video Project API to fetch status and downloads.

Example:

"cuid-example"

credits_charged
integer
required

The amount of credits deducted from your account to generate the video. If the status is not 'complete', this value is an estimate and may be adjusted upon completion based on the actual FPS of the output video.

If video generation fails, credits will be refunded, and this field will be updated to include the refund.

Example:

450