Référence API

Models

The people a photo shoot (tryon task) is rendered on: Veeton-curated public models and the ones your organization has generated, in one id space. Reference them as inputs.model_id.

Endpoints

GET/v1/models

L'objet Model

Attributs

idstring
Opaque model identifier. Org-generated models use ULIDs; Veeton-curated system models use shorter legacy ids (e.g. "19274"). Pass this value back as inputs.model_id on POST /v1/tasks/tryon.
namestring, nullable
is_publicboolean
True for Veeton-curated system models. False for org-generated models.
sexenum, nullable
- male
- female
- other
body_typeenum, nullable
- standard
- slim
- athletic
- plus_size
age_bracketenum, nullable
- baby
- child
- teen
- adult
- senior
ethnicityenum, nullable
- caucasian
- asian
- african
- hispanic
- middle_eastern
hair_colorenum, nullable
Valeurs possibles (12)
- blonde
- platinum
- light_brown
- brown
- medium_chestnut
- dark_brown
- black
- redhead
- red_auburn
- gray
- grey_silver
- fashion_color
eye_colorenum, nullable
Valeurs possibles (7)
- blue
- green
- brown
- hazel
- grey
- amber
- heterochromia
height_cminteger, nullable
The model's height in centimetres, set when the model is generated. Null when unknown.
previewobject, nullable
Afficher les attributs enfantsMasquer les attributs enfants
- mime_typeenum
  - image/jpeg
  - image/png
  - image/webp
- widthinteger, nullable
  Pixel width, null when not yet known.
- heightinteger, nullable
- urlstring (URL)
  Time-limited signed URL to the bytes. Fetch a fresh one from GET /v1/images/{id} when it expires.
- url_expires_attimestamp
  When url stops working.
- created_attimestamp
  Upload time for your photos, task completion for generations.

L'objet Model

{
  "id": "01HX5K2MZ7A3Q4FBNDC0EVDXMD1",
  "name": "Eva",
  "is_public": true,
  "sex": "male",
  "body_type": "slim",
  "age_bracket": "adult",
  "ethnicity": "caucasian",
  "hair_color": "brown",
  "eye_color": "brown",
  "height_cm": 174,
  "preview": {
    "mime_type": "image/jpeg",
    "width": 1,
    "height": 1,
    "url": "https://example.com/…",
    "url_expires_at": "2026-04-27T14:32:00Z",
    "created_at": "2026-04-27T14:32:00Z"
  }
}

List models

GET/v1/models

Cursor-paginated list of models available to the caller — Veeton-curated public models plus any models generated by the caller's organization.

Reference these ids in inputs.model_id when launching a tryon task at POST /v1/tasks/tryon.

Filter with ?is_public=true (only Veeton-curated models) or ?is_public=false (only org-generated). Omit to receive both.

The Veeton-curated models are pictured in the photo shoot catalog.

Paramètres

limitinteger· queryoptionnel
Par défaut : 25
cursorstring· queryoptionnel
is_publicenum· queryoptionnel
When set, narrow to public (true) or org-generated (false) models. Omit to receive both.
- true
- false

Retour

Retourne un objet ModelList avec le statut 200.

Erreurs

400
Invalid request
500
Server error

GET/v1/models

curl https://api.veeton.com/v1/models \
  -H "Authorization: Bearer $VEETON_KEY"
import requests

response = requests.get(
    "https://api.veeton.com/v1/models",
    headers={"Authorization": f"Bearer {VEETON_KEY}"},
)

print(response.json())
const response = await fetch("https://api.veeton.com/v1/models", {
  headers: { Authorization: `Bearer ${VEETON_KEY}` },
})

const data = await response.json()

Réponse · 200

{
  "data": [
    {
      "id": "01HX5K2MZ7A3Q4FBNDC0EVDXMD1",
      "name": "Eva",
      "is_public": true,
      "sex": "male",
      "body_type": "slim",
      "age_bracket": "adult",
      "ethnicity": "caucasian",
      "hair_color": "brown",
      "eye_color": "brown",
      "height_cm": 174,
      "preview": {
        "mime_type": "image/jpeg",
        "width": 1,
        "height": 1,
        "url": "https://example.com/…",
        "url_expires_at": "2026-04-27T14:32:00Z",
        "created_at": "2026-04-27T14:32:00Z"
      }
    }
  ],
  "next_cursor": "eyJpZCI6InByb2RfMDFIWCJ9",
  "has_more": true
}