Retrieve image

March 17, 2025

Table of contents

  1. Request Headers
  2. Path parameter
  3. Responses
  4. Model
  5. Examples
  6. Try It

Use this endpoint to retrieve status and results of

https://api.useapi.net/v1/minimax/images/imageId

Request Headers
Authorization: Bearer {API token}
Content-Type: application/json
Path parameter
  • imageId is required. Specify the imageId you want to retrieve.
Responses
  • 200 OK

    {
      "id": "<image_id>",
      "desc": "...prompt...",
      "coverURL": "https://cdn.hailuoai.video/...png?x-oss-process=image/resize,w_1080/format,webp",
      "videoURL": "https://cdn.hailuoai.video/....png",
      "status": 2,
      "canRetry": false,
      "width": 0,
      "height": 0,
      "originFiles": [],
      "canAppeal": false,
      "downloadURL": "https://cdn.hailuoai.video/....png",
      "hasVoice": false,
      "modelID": "image-01",
      "useOriginPrompt": false,
      "isBookmarked": false,
      "disableGenerateSimilar": false,
      "createTime": 1742173334234,
      "postStatus": 0,
      "userID": 923847293472394000,
      "createType": 4,
      "promptImgURL": "",
      "extra": {
        "cameraMotions": [],
        "promptStruct": ""
      },
      "isVisitor": false,
      "videoURLs": {
        "feedURL": "",
        "downloadURLWithWatermark": "https://cdn.hailuoai.video/....png"
      },
      "priority": 0,
      "generatorType": 1,
      "isInFolder": false,
      "batchID": "357846312387492374",
      "aspectRatio": "9:16",
      "fileID": "user:<user>-minimax:<account>-file:<file_id>",
      "tags": [
        {
          "type": "normal",
          "tagIcon": "",
          "tagText": "image-01"
        },
        {
          "type": "normal",
          "tagIcon": "",
          "tagText": "Enable Optimization"
        },
        {
          "type": "normal",
          "tagIcon": "",
          "tagText": "Image to video"
        }
      ],
      "duration": 0,
      "resolution": 0,
      "humanCheckStatus": 0,
      "userIDStr": "<account>",
      "statusLabel": "completed",
      "statusFinal": true,
      "imageId": "user:<user>-minimax:<account>-image:<image_id>"
    }
    
  • 400 Bad Request

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

    {
      "error": "Unauthorized",
      "code": 401
    }
    
  • 404 Not Found

    {
        "error": "Not found.",
        "code": 404
    }
    
Model

Known status values:

  • 0 pending
  • 1 processing
  • 2 completed
  • 3 failed
  • 5 moderated
  • 7 moderated
  • 11 queued
  • 12 processing
  • 14 moderated
{   // TypeScript, all fields are optional
    id: string
    desc: string
    coverURL: string
    videoURL: string
    status: number
    canRetry: boolean
    width: number
    height: number
    originFiles: any[]
    canAppeal: boolean
    downloadURL: string
    hasVoice: boolean
    modelID: string
    useOriginPrompt: boolean
    isBookmarked: boolean
    disableGenerateSimilar: boolean
    createTime: number
    postStatus: number
    userID: number
    createType: number
    promptImgURL: string
    extra: {
      cameraMotions: any[]
      promptStruct: string
    }
    isVisitor: boolean
    videoURLs: {
      feedURL: string
      downloadURLWithWatermark: string
    }
    priority: number
    generatorType: number
    isInFolder: boolean
    batchID: string
    aspectRatio: string
    fileID: string
    tags: {
      type: string
      tagIcon: string
      tagText: string
    }[]
    duration: number
    resolution: number
    humanCheckStatus: number
    userIDStr: string
    statusLabel: string
    statusFinal: boolean
    imageId: string
}
Examples
  • curl "https://api.useapi.net/v1/minimax/images/<imageId>" \
       -H "Accept: application/json" \
       -H "Authorization: Bearer …" 
    
  • const token = "API token";
    const imageId = "imageId to retrieve"; 
    const apiUrl = `https://api.useapi.net/v1/minimax/images/${imageId}`; 
    const response = await fetch(apiUrl, {
      headers: {
        "Authorization": `Bearer ${token}`,
      },
    });
    const result = await response.json();
    console.log("response", {response, result});
    
  • import requests
    token = "API token"
    imageId = "imageId to retrieve"
    apiUrl = f"https://api.useapi.net/v1/minimax/images/{imageId}"
    headers = {
        "Content-Type": "application/json", 
        "Authorization" : f"Bearer {token}"
    }
    response = requests.get(apiUrl, headers=headers)
    print(response, response.json())
    
Try It