Back to Tool Reference
MCP

mockup.get

Fetch a saved mockup by ID when its record is not already available.

Effectread-onlyScopemockup:readPlanStarter+

This returns the same complete record as an item in mockup.list, not extra detail or a higher-resolution image. If that item was already returned in this reply, use it directly; do not fetch it again here. This returns data without displaying a widget. To show this mockup, call mockup.show with its ID; include any other requested views together. Use this for a direct lookup of a known ID that has not been retrieved, or when the user explicitly requests updated data.

url opens the mockup's design in the app; share it rather than building a link.

Parameters

mockup_idstringRequired

ID of a saved mockup, from mockup.list or a completed mockup.generate.

Request
json
{
  "name": "mockup.get",
  "arguments": {
    "mockup_id": "485d45e2-1451-4f53-9a41-7e3b1136a6cd"
  }
}
Response
json
{
  "id": "485d45e2-1451-4f53-9a41-7e3b1136a6cd",
  "view": "Back",
  "external_key": null,
  "type": "vto_images",
  "environment": "studio",
  "width": null,
  "height": null,
  "image": "https://cdn.vaybel.com/vto_mockups/462a683e-983a-4acd-8aa0-6e507b603bf0_633f3b8a-9013-4b2b-bdb3-5675cafe706b_back_9_16.png",
  "video": null,
  "status": "CREATED",
  "selected": true,
  "video_type": null,
  "created_at": "2025-10-10T04:31:52.012979+00:00",
  "queue_position": null,
  "step_progress": null,
  "feedback": null,
  "product_design": {
    "id": "462a683e-983a-4acd-8aa0-6e507b603bf0",
    "title": "Classic Jack-o'-Lantern Halloween Organic T-Shirt",
    "image": null
  },
  "virtual_model": "men",
  "audience": "Gen Z Streetwear",
  "step_message": "Mockup ready",
  "error_message": "",
  "url": "https://vaybel.com/dashboard/launch-product/462a683e-983a-4acd-8aa0-6e507b603bf0/mockups"
}