Back to Tool Reference
MCP

virtual_model.list

List the org's virtual models (the on-model identities behind VTO).

Effectread-onlyScopevirtual_model:readPlanStarter+

Parameters

audience_keystring

Optional — restrict to one audience (see brand_dna.get for keys).

statusstring

Optional — DRAFT, CREATED (usable for VTO), or FAILED.

pageintegerDefault: 1

1-based page number.

page_sizeintegerDefault: 20

Clamped to [1, 100].

Returns

resultsobject[]

Each: id, audience_key, audience_label, gender, ethnicity, age, status, image_url.

totalint

Number of models before pagination.

pageint

Current page.

page_sizeint

Effective page size.

Request
json
{
  "name": "virtual_model.list",
  "arguments": {}
}
Response
json
{
  "results": [
    {
      "id": "2e086a10-acb6-4716-a041-cc77e487fdea",
      "audience_key": "genz_streetwear",
      "audience_label": "Gen Z Streetwear",
      "gender": "men",
      "ethnicity": "East Asian",
      "age": 21,
      "status": "CREATED",
      "image_url": "https://cdn.vaybel.com/virtual_models/2e086a10-acb6-4716-a041-cc77e487fdea_front.png"
    },
    {
      "id": "63f70cb2-7afd-43cb-ac2c-6c69fa91ff4f",
      "audience_key": "genz_streetwear",
      "audience_label": "Gen Z Streetwear",
      "gender": "non-binary",
      "ethnicity": "East Asian",
      "age": 21,
      "status": "CREATED",
      "image_url": "https://cdn.vaybel.com/virtual_models/63f70cb2-7afd-43cb-ac2c-6c69fa91ff4f_front.png"
    }
  ],
  "total": 3,
  "page": 1,
  "page_size": 20
}