AI Model API

AI Model API

The AI Model API allows you to generate studio-quality model images from your garment photos.

POST

Upload Model Garment

Upload one or more garment images to the model's garment library. You can upload up to 5 images at once by sending multiple 'image' and 'image_name' fields.

Parameters

  • imageRequired
    Multipart file upload (WEBP, JPG, PNG). Pass this key multiple times for batch upload (max 5 images).
  • image_nameOptional
    Descriptive name for each garment (e.g., 'saree_front'). Pass this key multiple times in the same order as your images.
POST/api/v2/models/garment-images/
Request

Headers

x-api-key: "YOUR_API_KEY"

Content-Type: "multipart/form-data"

Body (JSON)

// Form Data Example
image: (File 1)
image_name: "saree_front"

image: (File 2)
image_name: "saree_back"

// Note: Maximum 5 images allowed per request.
200 OKResponse
garment_images: [
  {
    "id": 2886,
    "image_url": "https://vtryon-app.b-cdn.net/models-garment-images/...",
    "image_name": "saree_front",
    "user": { "id": 6, "email": "user@example.com" },
    "created_at": "2026-05-12T10:33:15Z"
  },
  {
    "id": 2887,
    "image_url": "https://vtryon-app.b-cdn.net/models-garment-images/...",
    "image_name": "saree_back",
    "user": { "id": 6, "email": "user@example.com" },
    "created_at": "2026-05-12T10:33:15Z"
  }
]
GET

List Model Garment Images

Retrieves a list of all garment images uploaded for AI model generation.

Parameters

  • image_nameOptional
    Filter by image name (e.g., 'saree').
  • pageOptional
    The page number to retrieve (e.g., page=1).
  • page_sizeOptional
    The number of items to return per page (e.g., page_size=10).
GET/api/v2/models/garment-images/
Request

Headers

x-api-key: "YOUR_API_KEY"

200 OKResponse
{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 2886,
      "image_url": "https://vtryon-app.b-cdn.net/models-garment-images/...",
      "image_name": "saree_front",
      "user": { "id": 6, "email": "user@example.com" },
      "created_at": "2026-05-12T10:33:15Z"
    }
  ]
}
DELETE

Delete Model Garment Image

Permanently deletes a specific garment image from the model library using its ID.

Parameters

  • idRequired
    Unique ID of the model garment image to delete.
DELETE/api/v2/models/garment-images/{id}/
Request

Headers

x-api-key: "YOUR_API_KEY"

200 OKResponse
{
  "detail": "Deleted successfully"
}
POST

Create Model Generation Task

Generate a new AI model image wearing the specified garments.

Parameters

  • garment_image_idsRequired
    Array of model garment IDs.
  • image_qualityOptional
    '2k' or '4k'. (Default is '2k' if not specified).
POST/api/v2/models/image-generation-tasks/
Request

Headers

x-api-key: "YOUR_API_KEY"

Body (JSON)

{
  "garment_image_ids": [815],
  "image_quality": "4k"
}
200 OKResponse
{
  "id": 488,
  "task_status": "queued",
  "created_at": "2024-05-05T12:00:00Z"
}
GET

Get Model Task

Retrieve the current status, progress, and generated results of a specific model generation task using its unique ID.

Parameters

  • task_idRequired
    Unique ID of the model task to retrieve.
GET/api/v2/models/image-generation-tasks/{task_id}/
Request

Headers

x-api-key: "YOUR_API_KEY"

200 OKResponse
{
  "id": 488,
  "task_status": "completed",
  "generated_model_image_url": "https://cdn.vtryon.com/res/..."
}
GET

Get All Model Tasks

Retrieve status and results for model generation tasks.

Parameters

  • pageOptional
    The page number to retrieve (e.g., page=1).
  • page_sizeOptional
    The number of items to return per page (e.g., page_size=10).
GET/api/v2/models/image-generation-tasks/
Request

Headers

x-api-key: "YOUR_API_KEY"

200 OKResponse
{
  "count": 1,
  "results": [
    {
      "id": 488,
      "task_status": "completed",
      "generated_model_image_url": "https://cdn.vtryon.com/res/..."
    }
  ]
}
DELETE

Delete Model Task

Permanently deletes a specific AI model generation task and its associated data.

Parameters

  • task_idRequired
    Unique ID of the model task to delete.
DELETE/api/v2/models/image-generation-tasks/{task_id}/
Request

Headers

x-api-key: "YOUR_API_KEY"

200 OKResponse
{
  "detail": "Deleted successfully"
}

What's Next?

Master the Vtryon API to build your own custom fashion applications.

PreviousNext