PixVerse Platform Docs
  1. API Reference
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. API Reference

Get Video Generation Status

GET
/openapi/v2/video/result/{id}
OpenAPI 接口
1: Generation successful; 5: Generating; 7: Contents moderation failed; 8: Generation failed;

Request

Path Params
id
integer 
required
video_id from generation task
Header Params
API-KEY
string 
required
app-key from PixVerse platform
Ai-trace-id
string 
required
traceID format: UUID, must be unique for each request
Example:
{{$string.uuid}}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://app-api.pixverse.ai/openapi/v2/video/result/' \
--header 'API-KEY;' \
--header 'Ai-trace-id: {{$string.uuid}}'

Responses

🟢200OK
application/json
Success
Body
ErrCode
integer 
optional
ErrMsg
string 
optional
Resp
object 
dto.GetOpenapiMediaDetailResp
optional
create_time
string 
optional
create_time
id
integer 
optional
video_id
modify_time
string 
optional
update_time
negative_prompt
string 
optional
negative Prompt
outputHeight
integer 
optional
height of video
outputWidth
integer 
optional
width of video
prompt
string 
optional
prompt
resolution_ratio
integer 
optional
video_quality
seed
integer 
optional
seed
size
integer 
optional
video size
status
integer 
optional
video status: Generation succesful = 1; Generating=5; Deleted = 6; Contents moderation failed = 7; Generation failed= 8;
style
string 
optional
style
url
string 
optional
video result
Example
{
  "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": 0,
    "style": "string",
    "url": "string"
  }
}
Previous
Transition(First-last frame) generation
Next
Common errors and Solutions