Upload Image

POST

/openapi/v2/image/upload

Upload an image using multipart/form-data. Supported formats: JPEG, PNG, and WebP; the file must be smaller than 20 MB, with neither dimension exceeding 10,000 pixels.

Provide either a local image file or an image URL, not both. Replace the example URL with a publicly accessible image URL before sending the request.

Request

Header Params

Body Params multipart/form-dataRequired

Responses

🟢200OK

application/json

Successful response.

Bodyapplication/json

Request Example

Shell

curl --location 'https://app-api.pixverse.ai/openapi/v2/image/upload' \
--header 'API-KEY: your-api-key' \
--header 'Ai-trace-id: 550e8400-e29b-41d4-a716-446655440000' \
--form 'image=@""' \
--form 'image_url="https://example.com/image.png"'

Response Example

Successful Example

{
    "ErrCode": 0,
    "ErrMsg": "Success",
    "Resp": {
        "img_id": 123456789,
        "img_url": "https://example.com/image.png"
    }
}

Webhook Callbacks

Upload Media (Video and Audio)