design.get_generation | Vaybel Docs

Effectread-onlyScopedesign:readPlanStarter+

Parameters

handlestringRequired

The task id returned from design.generate.

wait_secintegerDefault: 0

0 returns an instant snapshot. Positive values long-poll up to that many seconds and return when the task is complete/failed or the timeout expires.

image_viewstringDefault: "product"

One of "product", "artwork"

Keep product for ordinary design requests: show the artwork on the garment. Use artwork only when the user explicitly asks for raw artwork or print graphics. This only selects saved images.

Returns

handlestring

resource_idstring | null

Same as design_id once known.

status"pending" | "running" | "complete" | "failed"

doneboolean

design_idstring | null

Design UUID. null until the pipeline has produced a design.

progressnumber | null

Fractional progress 0.0-1.0 when known.

stagestring

product_imagesobject[]

Saved product previews (placement, image_url), front first. Show these by default. An empty list means no product preview is available yet; do not substitute raw artwork.

image_viewstring

The requested gallery view.

image_urlstring | null

Legacy raw artwork URL; not the default preview.

imagesobject[]

Every side's artwork, each placement (e.g. front, back) and image_url. Use only for explicit raw artwork requests. Do not generate additional mockups to retrieve saved images.

urlstring | null

Page that opens the design in the app. Share this link rather than building one.

errorstring

Public failure message, without internal processing diagnostics.

next_actionobject | null

On completion, call the returned read-only tool with its arguments once before replying, even when the request asks for a link. This displays the saved gallery without generating anything. Polling alone does not display images.