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

FAQ

Authentication and Accounts#

Where can I create an API Key?#

Sign in to the PixVerse API Platform and create an API Key in your account settings.

Can I use the same API Key in a browser or mobile app?#

Keep the API Key on a trusted server. Do not expose it in client-side code, URLs, screenshots, or public logs.

Can uploaded resources be shared across accounts or regions?#

No. Use images, videos, audio, and generated IDs with the same API account and region that created them.

Requests and Task Status#

Why does a successful request not contain the final video immediately?#

Video generation is asynchronous. A successful creation request returns Resp.video_id. Poll Query Task Status or use a Webhook, and treat the task as complete only when status=1 and Resp.url is accessible.

How often should I query task status?#

Poll every 3-5 seconds and use a new Ai-trace-id for each request. Do not create a duplicate task only because processing takes longer than expected.

How should I interpret HTTP 200?#

Always evaluate both the HTTP status and ErrCode. HTTP 200 alone does not indicate business success; ErrCode=0 is required.

Templates and Media#

How do I know which inputs a template requires?#

Use the template-list HTTP interface and follow the current template metadata. Required media, duration, resolution, and Credit consumption may differ by template.

Why is an uploaded image or video rejected by a generation endpoint?#

Confirm the media type, format, dimensions, file size, account, region, and compatible endpoint. Use the ID returned by the corresponding upload interface.

Billing#

Where can I find current pricing?#

See Pricing > PixVerse API Pricing in this documentation and confirm current commercial rates in the PixVerse API Platform before publishing customer-facing estimates.

Are failed tasks refunded automatically?#

Qualifying failed, moderated, or timed-out tasks may be refunded. Treat a refund as complete only after the refund record appears in the account ledger and the balance is restored.

Is Resp.credits the final billing record?#

Use Resp.credits for display and preliminary reconciliation. Valid debit and refund entries in the account ledger are the final charging record.

Troubleshooting#

What should I provide when contacting support?#

Include the endpoint, request time, HTTP status, ErrCode, ErrMsg, Ai-trace-id, and video_id when available. Do not include your full API Key.
Contact api_business@pixverse.ai.
Previous
Error Codes
Next
Webhook Callbacks