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

Upload Image

POST
/openapi/v2/image/upload
OpenAPI 接口
Uploads an image to the server. Image requirements: maximum dimensions 4000*4000 pixels, file size less than 20MB. Supported formats: "png", "webp", "jpeg", "jpg"

Request

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}}
Body Params multipart/form-data
image
file 
optional

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 POST 'https://app-api.pixverse.ai/openapi/v2/image/upload' \
--header 'API-KEY;' \
--header 'Ai-trace-id: {{$string.uuid}}' \
--form 'image=@""'

Responses

🟢200OK
application/json
Success
Body
ErrCode
integer 
optional
ErrMsg
string 
optional
Resp
object 
dto.UploadImgResp
optional
img_id
integer 
optional
img_url
string 
optional
Example
{
  "ErrCode": 0,
  "ErrMsg": "string",
  "Resp": {
    "img_id": 0,
    "img_url": "string"
  }
}
🔴500Server Error
Previous
Get user credit balance
Next
Text-to-Video generation