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 user credit balance

GET
/openapi/v2/account/balance

Request

Header Params
API-KEY
string 
required
ai-trace-id
string 
required
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/account/balance' \
--header 'API-KEY;' \
--header 'ai-trace-id: {{$string.uuid}}'

Responses

🟢200Success
application/json
Body
ErrCode
integer 
required
ErrMsg
string 
required
Resp
object 
required
account_id
integer 
required
Platform Account User ID
credit_monthly
integer 
required
Monthly Credits Balance
credit_package
integer 
required
Purchased Credits Balance
Example
{
  "ErrCode": 0,
  "ErrMsg": "success",
  "Resp": {
    "account_id": 123452341,
    "credit_monthly": 1069020,
    "credit_package": 3630
  }
}
Previous
API Parameter Description
Next
Upload Image