Back to Tool Reference
MCP

design.edit

Refine an existing design with a plain-language instruction.

EffectwritesReachesoutside VaybelScopedesign:writePlanStarter+Credits3Rate limit10/minIdempotent

The pipeline starts from the base design's artwork, brief and assets, so "make the text smaller, add the date" keeps everything else in place. The result is a new design linked to the base; design.get_history walks the chain.

Parameters

design_idstringRequired

UUID of a design owned by the calling organization.

instructionstringRequired

What to change, in plain language.

variant_group_uuidstring

Optional variant group uuid to re-target the colorway. Omit to keep the base design's.

idempotency_keystring

Send the same key when retrying this exact call. A completed request replays for 24 hours without running or billing again.

callback_urlstring

An https URL that receives a signed completion event when the work finishes, so you can skip polling. See Webhooks.

Returns

handlestring

Opaque async handle. Pass to design.get_generation.

status"pending"
messagestring

Describes the design.get_generation(..., wait_sec=...) contract.

Request
json
{
  "name": "design.edit",
  "arguments": {
    "design_id": "a26c06d3-32dc-5e33-9f63-b5d453ede96a",
    "instruction": "Make the text smaller and add the year"
  }
}