1. Preparation
PixVerse Platform Docs
  • Get Started
    • What Is PixVerse AI?
    • Model Capability Map
    • Billing and Usage
    • Quick Start
    • Contact Us
    • Privacy and Data Protection
  • API
    • Preparation
      • Start Here
      • Concurrency Rules
      • Query Task Status
      • Error Codes
      • FAQ
      • Webhook Callbacks
      • Upload Image
        POST
      • Upload Media (Video and Audio)
        POST
      • Verify Uploaded Audio
        POST
      • Get Effect Template List
        GET
      • Get TTS Speaker List
        GET
      • Get Restyle Effect List
        GET
      • Query Task Status
        GET
      • Get Account Balance
        GET
      • Usage Deduction Query
        POST
      • Create Custom Voice
        POST
      • Delete Custom Voice
        DELETE
    • Core Capabilities
      • Text-to-Video
      • Image-to-Video and Video Templates
      • First and Last Frame Video
      • Reference-to-Video (Fusion)
      • Multi-Transition Video
      • Video Extend
      • Image Template Generation
      • Get Image Generation Result
    • Solutions
      • Video Upscale
      • Video Restyle
      • Lipsync
      • Video Edit (Modify)
      • Image Avatar
      • Select Video Mask
      • Sound Effect
      • Subject Replacement (Swap)
      • Motion Control (Mimic)
      • One-click Real Estate Video
      • One-click VibeMV
  • Pricing
    • PixVerse API Pricing
  • Changelog
    • Changelog
  1. Preparation

Query Task Status

GET
/openapi/v2/video/result/{video_id}
Video-generation endpoints return a video_id. Use this endpoint to poll the task status and retrieve the output URL after generation completes.

Status Values#

statusDescription
1Generation completed. The output URL is available in Resp.url.
5Generating. Continue polling every 3-5 seconds.
7Content moderation failed. Review the request content before retrying.
8Generation failed

Polling Guidance#

Poll every 3-5 seconds while status=5.
Consider the task complete only when status=1 and Resp.url is accessible.
For status=7, revise content that may have failed moderation before creating a new request.
For status=8, inspect the request, preserve the Ai-trace-id, and verify any applicable credit refund in the account ledger.

Request

Path Params

Header Params

Responses

🟢200
application/json
Successful response.
Bodyapplication/json

🟠400
🟠401
Request Request Example
Shell
curl --location 'https://app-api.pixverse.ai/openapi/v2/video/result/' \
--header 'API-KEY: your-api-key' \
--header 'Ai-trace-id: 550e8400-e29b-41d4-a716-446655440000'
Response Response Example
200 - Processing task
{
    "ErrCode": 0,
    "ErrMsg": "Success",
    "Resp": {
        "id": 123456789,
        "status": 5,
        "url": "",
        "outputWidth": 0,
        "outputHeight": 0
    }
}
Previous
Get Restyle Effect List
Next
Get Account Balance