PixVerse Platform Docs
  1. Learn about PixVerse Platform
PixVerse Platform Docs
  • Learn about PixVerse Platform
    • Introduce to PixVerse Platform
    • Quick Start
  • Getting started
    • How does the API work?
    • How to get API key?
    • How to check account balance?
    • How to subscribe API plans?
    • How to use Text-to-video
    • How to use Image-to-video
    • How to use Effects?
    • How to use Transition(First-last frame Feature)
    • How to get video generation status?
  • API Reference
    • API Parameter Description
    • Get user credit balance
      GET
    • Upload Image
      POST
    • Text-to-Video generation
      POST
    • Image-to-Video generation
      POST
    • Transition(First-last frame) generation
      POST
    • Get Video Generation Status
      GET
  • Trouble Shooting
    • Common errors and Solutions
    • Error codes
    • FAQ
  • Resources
    • Model & Pricing
    • Rate limit
    • Support
    • Change Logs
    • Term of Service
    • Privacy policy
  • PixVerse Tools
    • PixVerse MCP
  1. Learn about PixVerse Platform

Quick Start

Our API generates stunning videos based on user-uploaded prompts and images.
The overall API call flow is:
1.
each request requires an app-key and AI-trace-id to submit a video generation task, which returns a video_id.
2.
Through the video_id, you can get the video generation status.
3.
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

Login#

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#

1
Step 1
Click the Create key button in API Key section
image.png
2
Step 2
Please enter a name for your API key
image.png
3
Step 3
After entering the name, your API key will be displayed. Please store it securely as it will only be shown once.
image.png

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#

1
Generate video through the video generation interface
If generation is successful, it will return success and provide a video_id
2
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
3
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-VideoImage-to-VideoEffects
1. Submit task through text-to-video interface1. First upload image through the upload image interface
2. Submit task through image-to-video interface to get image ID
1. When submitting video generation task, please fill in template_id

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
Previous
Introduce to PixVerse Platform
Next
How does the API work?