AI sign designs
delete_quote_ai_design
destructive writeDelete quote AI design
Clear a failed quote file conversion so that the file can be converted again.
Overview
Delete a failed AI design made from a quote file, so that the file can be converted again with create_quote_ai_design, as the merchant admin Quotes page does. Only a design whose status is failed and that has no work still running can be deleted. The design and its private copy of the quote file cannot be restored; the quote and its file do not change. The call needs confirm: true. Each connection can delete 10 designs a minute. The result is the design as it was. Requires ai_sign_designs:write and quotes:read, and an idempotency_key.
Permission
Requires theai_sign_designs:writepermission. A connection without it answersinsufficient_scopenaming the permission to approve.
Annotations
Prerequisites
- A quote id from list_quotes, and a design of it whose status is failed, from list_quote_ai_designs.
- A merchant has connected this store and approved the ai_sign_designs:write and quotes:read scopes.
Side effects
- Deletes the design and its private copy of the quote file permanently.
- Changes no quote, quote file, credit or other design.
- Claims the idempotency_key for at least 24 hours.
Arguments
The quote id, from list_quotes.
The id of a failed design of the quote, from list_quote_ai_designs.
Must be true to apply the change, because the design and its private copy of the quote file are deleted permanently. Without it the call returns a confirmation_required error and changes nothing.
A client-generated key unique to this logical write, such as a UUID. Required: repeating the call with the same key and the same arguments replays the original result instead of writing twice, and the same key with different arguments is an idempotency_key_conflict.
Result
The design as it was, so a caller can report what it removed.
Present and true when the design was deleted.
The design as it was, so a caller can report what it removed.
customer_customiser (a shopper used the AI sign designer), quote (a quote file was converted), merchant_admin (an upload in the merchant admin) or api (an AI sign design job). Expected to grow.
One of: customer_customiser, quote, merchant_admin, api
processing, then delivered (a design exists), refused (a check refused the design) or failed (no design for another reason). No credit is charged for refused or failed. Expected to grow.
One of: processing, delivered, refused, failed
One of: neon, channel_letter, metal_cut_out
The SVG, EPS, PDF, preview and face files only when status is delivered, and the uploaded source and its preview for every status.
One of: svg, eps, illustrator_pdf, raster_preview, face_svg, source, source_preview
One of: private, public
A URL that needs no login. For a private file of an api design it is a revocable Sign Customiser link. For a public file it is the public storage URL, which cannot be revoked. Null for every other private file.
The quote file the design was converted from, or null.
One of: thumbs_up, thumbs_down
True when this call replayed a previously recorded response for the same idempotency_key instead of applying the write again.
Error cases
The design is still processing, was delivered or refused, or still has work running. Nothing was deleted. Read it with get_ai_design, and retry with a new idempotency_key when status is failed.
Send confirm: true. A deleted design cannot be restored.
The design changed after the recorded deletion. Issue a new key and read the design before writing again.
The connection was approved without ai_sign_designs:write or without quotes:read.
This connection deleted too many designs in the last minute. Wait retry_after seconds.
The quote or the design does not exist for this store, or the design was not made from a file of this quote.
Delete a failed conversion
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "delete_quote_ai_design",
"arguments": {
"quote_id": 8123,
"ai_design_id": 51234,
"confirm": true,
"idempotency_key": "9c2d4e6f-1a3b-4c5d-8e7f-2a4b6c8d0e1f"
}
}
}{
"jsonrpc": "2.0",
"id": 1,
"result": {
"structuredContent": {
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
"store": {
"id": 12,
"name": "Demo Signs"
},
"ai_design_id": 51234,
"deleted": true,
"ai_design": {
"id": 51234,
"origin": "quote",
"status": "failed",
"product_family": "neon",
"customiser_id": 42,
"files": [
{
"kind": "source",
"purpose": "source",
"media_type": "image/png",
"access": "private",
"download_url": null
}
],
"product_ids": [],
"order_ids": [],
"quote_id": 8123,
"quote_file": {
"field_id": "field_artwork",
"file_index": 0
},
"ai_sign_design_job_id": null,
"feedback_rating": null,
"created_at": "2026-10-20T09:32:00Z"
},
"idempotent_replay": false
}
}
}A delivered design cannot be deleted (error)
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "delete_quote_ai_design",
"arguments": {
"quote_id": 8123,
"ai_design_id": 51234,
"confirm": true,
"idempotency_key": "9c2d4e6f-1a3b-4c5d-8e7f-2a4b6c8d0e1f"
}
}
}{
"jsonrpc": "2.0",
"id": 1,
"result": {
"isError": true,
"structuredContent": {
"error": {
"code": "ai_design_not_deletable",
"title": "AI design not deletable",
"detail": "Only a failed design with no work still running can be deleted, so that its quote file can be converted again. This design is still processing, was delivered, or still has work running. Nothing was deleted. Read the design with get_ai_design, and retry with a new idempotency_key when status is failed.",
"recovery": "Only a failed design with no work still running can be deleted. Nothing was deleted. Read the design with get_ai_design, and retry with a new idempotency_key when status is failed."
}
}
}
}