API
esc

Type to search.

API reference

Models

The people a tryon 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

The Model object

Attributes

  • 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_typestring, nullable
  • age_bracketstring, nullable
  • ethnicitystring, nullable
  • hair_colorstring, nullable
  • eye_colorstring, nullable
  • preview_urlstring (URL), nullable
    Time-limited signed URL to a representative preview image.
  • preview_url_expires_attimestamp, nullable
    RFC 3339 / ISO 8601 timestamp.

The Model object

{
  "id": "01HX5K2MZ7A3Q4FBNDC0EVDXMD1",
  "name": "Eva",
  "is_public": true,
  "sex": "male",
  "body_type": "slim",
  "age_bracket": "young_adult",
  "ethnicity": "caucasian",
  "hair_color": "brown",
  "eye_color": "brown",
  "preview_url": "https://example.com/…",
  "preview_url_expires_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 tryon catalogue.

Parameters

  • limitinteger· queryoptional

    Default: 25

  • cursorstring· queryoptional
  • is_publicenum· queryoptional
    When set, narrow to public (true) or org-generated (false) models. Omit to receive both.
    • true
    • false

Returns

Returns a ModelList object with status 200.

Errors
  • 400

    Invalid request

  • 500

    Server error

GET/v1/models

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

Response · 200

{
  "data": [
    {
      "id": "01HX5K2MZ7A3Q4FBNDC0EVDXMD1",
      "name": "Eva",
      "is_public": true,
      "sex": "male",
      "body_type": "slim",
      "age_bracket": "young_adult",
      "ethnicity": "caucasian",
      "hair_color": "brown",
      "eye_color": "brown",
      "preview_url": "https://example.com/…",
      "preview_url_expires_at": "2026-04-27T14:32:00Z"
    }
  ],
  "next_cursor": "eyJpZCI6InByb2RfMDFIWCJ9",
  "has_more": true
}