What this API does
Create the same Text To Video you can make in the browser, but programmatically, so you can automate it, run it at scale, or connect it to your own app or workflow.
Good for
How it works (3 steps)
file_path.complete, then download the result from downloads.Key options
face_swap_mode, start_seconds/end_seconds, or a text promptCost
Credits are only charged for the frames that actually render. You’ll see an estimate when the job is queued, and the final total after it’s done.
For detailed examples, see the product page.
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
The total duration of the output video in seconds.
The value must be greater than or equal to 5 seconds and less than or equal to 60 seconds.
Note: For 480p resolution, the value must be either 5 or 10.
5 <= x <= 605
Determines the orientation of the output video
portrait, landscape, square "landscape"
Give your video a custom name for easy identification.
"My Text To Video video"
Controls the output video resolution. Defaults to 720p if not specified.
480p and 720p are available on Creator, Pro, or Business tiers. However, 1080p require Pro or Business tier.
Options:
480p - Supports only 5 or 10 second videos. Output: 24fps. Cost: 120 credits per 5 seconds.720p - Supports videos between 5-60 seconds. Output: 30fps. Cost: 300 credits per 5 seconds.1080p - Supports videos between 5-60 seconds. Output: 30fps. Cost: 600 credits per 5 seconds.480p, 720p, 1080p "720p"
Success
Success
Unique ID of the video. Use it with the Get video Project API to fetch status and downloads.
"cuid-example"
Deprecated: Previously represented the number of frames (original name of our credit system) used for video generation. Use 'credits_charged' instead.
The amount of frames used to generate the video. If the status is not 'complete', the cost is an estimate and will be adjusted when the video completes.
450
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.
450