The PixVerse Platform API provides a straightforward way to generate videos from text prompts or images. This guide explains the core concepts and workflow of our API.

API Architecture Overview

The PixVerse API follows RESTful principles, making it easy to integrate with your applications. All API requests are made over HTTPS to ensure security, and data is exchanged in JSON format.

Key Components

Authentication: Every request requires an API key for authentication

Endpoints: Specialized endpoints for different generation types

Asynchronous Processing: Video generation occurs asynchronously

Status Checking: Get video generation status to monitor generation progress

Result Retrieval: Download links for completed videos

Basic Workflow

Authentication

All requests must include in the header :

your API key for autentication

A different Ai-trace-id for each unique request (If you use the same ai-trace-id multiple times, You won't get a new video generated)

Other generation task requirements

Request Submission

Submit your generation request to the appropriate endpoint:

our request domain is https://app-api.pixverse.ai

💡

Text-to-video

Image-to-video

Effects

Transition-generation

Use Text-to-Video geneartion interface
https://docs.platform.pixverse.ai/text-to-video-generation-13016634e0

According to parameter, please modify your value what you want
https://docs.platform.pixverse.ai/api-parameter-description-803491m0

{
"aspect_ratio": "16:9",
"duration": 5,
"model": "v3.5",
"motion_mode": "normal",
"negative_prompt": "string",
"prompt": "string",
"quality": "540p",
"seed": 0,
"water_mark": false
}

Response Handling

After submitting a request, you'll receive a response with video_id containing:

{
  "ErrCode": 0,
  "ErrMsg": "success",
  "Resp": {
    "video_id": 0
  }
}

Status Checking

Use the video_id to periodically check the status of your generation:

GET https://app-api.pixverse.ai/openapi/v2/video/result/{video_id}

https://docs.platform.pixverse.ai/get-video-generation-status-13016632e0

Result Retrieval

Once processing is complete, the status endpoint will return status 1

   {
 "ErrCode": 0,
 "ErrMsg": "string",
 "Resp": {
   "create_time": "string",
   "id": 0,
   "modify_time": "string",
   "negative_prompt": "string",
   "outputHeight": 0,
   "outputWidth": 0,
   "prompt": "string",
   "resolution_ratio": 0,
   "seed": 0,
   "size": 0,
   "status": 1,
   "style": "string",
   "url": "string"
 }
}

How does the API work?

API Architecture Overview#

Key Components#

Basic Workflow#

API Architecture Overview

Key Components

Basic Workflow