Retrieve the list of images

December 6, 2024 (March 9, 2026)

Table of contents

  1. Request Headers
  2. Query Parameters
  3. Responses
  4. Model
  5. Examples
  6. Try It

Retrieve the list of images, this will include those currently being generated or queued. Check the image_status_name field for the status and the field image_status_final to determine if the provided status is the final status.

The API internally uses the field image_status to calculate values for image_status_name and image_status_final. See below for the known statuses map:

image_status image_status_name image_status_final
1 COMPLETED true
5 QUEUED false
7 MODERATED true
9 GENERATING false
10 PROCESSING false

https://api.useapi.net/v2/pixverse/images/?…

Request Headers
Authorization: Bearer {API token}
Content-Type: application/json
Query Parameters
  • email is optional when only one account configured. However, if you have multiple accounts configured, this parameter becomes required.

  • limit is optional, specify the number of images to return. Default 50.

  • offset is optional, specify the offset from where to start.

Responses
  • 200 OK

    {
        "data": [
            {
                "image_id": "user:<userid>-pixverse:<email>-image:11223344",
                "image_status": 1,
                "account_id": 33445566,
                "asset_id": 0,
                "asset_source": 1,
                "asset_type": 0,
                "create_mode": "t2i",
                "creation_type": 0,
                "model": "qwen-image",
                "prompt": "<prompt>",
                "quality": "720p",
                "aspect_ratio": "1:1",
                "seed": 123456,
                "image_path": "image/...",
                "image_url": "https://media.pixverse.ai/image/...webp",
                "output_width": 720,
                "output_height": 720,
                "customer_img_paths": [],
                "customer_img_urls": null,
                "platform": "",
                "queue_data": null,
                "created_at": "2026-03-09T12:34:56Z",
                "updated_at": "2026-03-09T12:34:58Z",
                "is_collected": false,
                "water_mark": false,
                "media_locked": 0,
                "image_status_name": "COMPLETED",
                "image_status_final": true
            }
        ],
        "next_offset": 50,
        "total": 12
    }
    
  • 400 Bad Request

    {
        "error": "<Error message>",
        "code": 400
    }
    
  • 401 Unauthorized

    {
      "error": "Unauthorized",
      "code": 401
    }
    
Model
{   // TypeScript, all fields are optional
  data: {
    image_id: string
    image_status: number
    account_id: number
    asset_id: number
    asset_source: number
    asset_type: number
    create_mode: string
    creation_type: number
    model: string
    prompt: string
    quality: string
    aspect_ratio: string
    seed: number
    image_path: string
    image_url: string
    output_width: number
    output_height: number
    customer_img_paths: string[]
    customer_img_urls: string[] | null
    platform: string
    queue_data: {
        estimated_gen_time: number
        processing_start_time: string
        queue_count: number
        queue_time: number
    } | null
    created_at: string
    updated_at: string
    is_collected: boolean
    water_mark: boolean
    media_locked: number
    // added
    image_status_name: string
    image_status_final: boolean
  }[]
  next_offset: number
  total: number
}
Examples
  • curl "https://api.useapi.net/v2/pixverse/images/?email=email" \
       -H "Accept: application/json" \
       -H "Authorization: Bearer …"
    
  • const token = "API token";
    const email= "Previously configured account email";
    const apiUrl = `https://api.useapi.net/v2/pixverse/images/?email=${email}`;
    const response = await fetch(apiUrl, {
      headers: {
        "Authorization": `Bearer ${token}`,
      },
    });
    const result = await response.json();
    console.log("response", {response, result});
    
  • import requests
    token = "API token"
    email= "Previously configured account email"
    apiUrl = f"https://api.useapi.net/v2/pixverse/images/?email={email}"
    headers = {
        "Content-Type": "application/json",
        "Authorization" : f"Bearer {token}"
    }
    response = requests.get(apiUrl, headers=headers)
    print(response, response.json())
    
Try It