Quick Start

Our API generates stunning videos based on user-uploaded prompts and images.

The overall API call flow is:

each request requires an app-key and AI-trace-id to submit a video generation task, which returns a video_id.

Through the video_id, you can get the video generation status.

When the video generation status changes from 5->1, you can download the video file through the URL.

Prerequisites

PixVerse API Platform account

API Key

Please log in to the PixVerse platform, register/login to your account. If you have a PixVerse consumer account, you can log in directly.

Set up API key

Step 1

Click the Create key button in API Key section

Step 2

Please enter a name for your API key

Step 3

After entering the name, your API key will be displayed. Please store it securely as it will only be shown once.

Set Header Parameters

API-KEY parameter: Enter the App-key created on the website

AI-trace-ID: Please use UUID format, ensuring a unique value for each request. If the value is too simple or identical to other request values, the effect may be incorrect or won't generate.

About Ai-trace-ID

Please generate a new ai-trace-id for each unique request (especially video generate)

Use UUID or similar unique identifier generation method

If you use the same ai-trace-id multiple times, You won't get a new video generated

Video Generation

Generate video through the video generation interface

If generation is successful, it will return success and provide a video_id

Get video generation status

Using the Video_id obtained from the generation interface, fill it in the id param parameter to get the video generation status. Status 5 indicates video is being generated, status 1 indicates video generation is complete

Poll video generation status, download video based on status changes

When video generation status is 1, you can download the video through the URL.

Main Function Call Methods

Text-to-Video	Image-to-Video	Effects	Transition	Lip sync	Extend
1. Submit task through text-to-video interface	1. First upload image through the upload image interface 2. Submit task through image-to-video interface to get video	1. When submitting video generation task, please fill in template_id	1. Upload two images(for first & last frame) through the upload image endpoint 2. Submit task through transition endpoint to get transition video	1.Prepare a video, either generated via the PixVerse API or uploaded via the media_upload endpoint. 2.Prepare Lipsync content, either as plain text or as an audio file uploaded via the media_upload endpoint.	1.Prepare a video, either generated via the PixVerse API or uploaded via the media_upload endpoint.

Next Steps

Model&Pricing

Models provided by PixVerse Platform and their respective pricing

Rate limit

Understand PixVerse Platform concurrency limits

Error codes

Various error codes encountered during API usage

FAQ

Common questions encountered during API calls

Prerequisites#

Login#

Set up API key#

Set Header Parameters#

Video Generation#

Main Function Call Methods#

Next Steps#