JOjogg
Avatar

Check product avatar image generation status

Changed on

Get the status and results of product avatar image generation by batch ID

get/v2/product_avatar/generation/{batch_id}

Request

  • Base URL
    https://api.jogg.ai
  • URL
    https://api.jogg.ai/v2/product_avatar/generation/{batch_id}
  • Auth
    API key in header x-api-key

Path parameters

batch_idstring required
Example:batch_123456

Batch ID from generation request

Response

Success

codeinteger required

Business status code:

  • 0 - Success
  • 10104 - Record not found
  • 10105 - Invalid API key
  • 18020 - Insufficient credit
  • 18025 - No permission to call APIs
  • 40000 - Parameter error
  • 50000 - System error
msgstring required

Response message

Example response

{
  "msg": "Success",
  "data": {
    "batch_id": "batch_123456",
    "summary": {
      "total": 4,
      "pending": 1,
      "processing": 1,
      "completed": 1,
      "failed": 1
    },
    "generations": [
      {
        "generation_id": "gen_123",
        "status": "completed",
        "created_at": 1640995200,
        "completed_at": 1640995500,
        "image_id": "img_123",
        "url": "https://example.com/image.jpg"
      }
    ]
  }
}

Changes