Poses API

Poses API

The Poses API allows you to generate additional pose variations for your AI model generations.

Endpoints

Expand your collection with multiple pose variations.

POST

Create Multi-Pose Task

Generate multiple looks/poses for an existing model task.

Parameters

  • models_image_generation_task_idRequired
    ID of the base model task.
  • variant_codeOptional
    Choose from 1 LOOK, 2 LOOKS, 4 LOOKS, or 7 LOOKS. (Default is '1_LOOK').

    Available Variants

    "1_LOOK"
    "2_LOOKS"
    "4_LOOKS"
    "7_LOOKS"
  • image_qualityOptional
    '2k' or '4k'. (Default is '2k').
POST/v2/models/multipose-tasks/look-wise/
Request

Headers

x-api-key: "YOUR_API_KEY"

Body (JSON)

{
  "variant_code": "7_LOOKS",
  "models_image_generation_task_id": 488,
  "image_quality": "4k"
}
200 OKResponse
{
  "id": 512,
  "status": "queued",
  "created_at": "2024-05-05T12:05:00Z"
}
GET

Poll for Task Status & Results

Because AI image generation is asynchronous, you must poll the server (e.g., every 3-5 seconds) to get the final image.

Task Statuses

queued/pending: Task is in the queue.
processing: AI is currently generating the image.
completed: The response will contain the result URL.
failed: Check the response for error details.
GET/v2/models/multipose-tasks/{task_id}/
Request

Headers

x-api-key: "YOUR_API_KEY"

200 OKResponse
{
  "id": 512,
  "status": "completed",
  "result_url": "https://cdn.vtryon.com/res/..."
}
GET

Get All Multi-Pose Tasks

Retrieve status and results for multi-pose 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/v2/models/multipose-tasks/
Request

Headers

x-api-key: "YOUR_API_KEY"

200 OKResponse
{
  "count": 1,
  "results": [
    {
      "id": 512,
      "status": "completed",
      "pose_variants": [
        { "url": "https://cdn.vtryon.com/res/pose1..." },
        { "url": "https://cdn.vtryon.com/res/pose2..." }
      ]
    }
  ]
}
DELETE

Delete Poses Task

Permanently deletes a specific multi-pose generation task using its ID.

Parameters

  • task_idRequired
    Unique ID of the poses task to delete.
DELETE/v2/models/multipose-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