AI sign designs
get_ai_design
readGet AI design
Poll a quote conversion until it is delivered, refused or failed, or check the files and links of one design.
Overview
Read one AI design of this store: its origin, its status, its files and the products, orders and quote it is linked to, and the store rating. The SVG, EPS, PDF, preview and face files are listed only when the design is delivered. A file has a download_url that needs no login only for a design of an AI sign design job, or for a public file of a design made before private storage. The shopper name, email and contact details are never returned. Requires ai_sign_designs:read. Has no side effects.
Permission
Requires theai_sign_designs:readpermission. A connection without it answersinsufficient_scopenaming the permission to approve.
Annotations
Prerequisites
- An AI design id from list_ai_designs, list_quote_ai_designs or create_quote_ai_design.
- A merchant has connected this store and approved the ai_sign_designs:read scope.
Arguments
The AI design id, from list_ai_designs, list_quote_ai_designs or create_quote_ai_design.
Result
The design. While status is processing, read it again later. The result never contains file contents.
The AI design.
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
Error cases
The connection was approved without ai_sign_designs:read.
The id is unknown, belongs to another store, or the design was erased.
A delivered quote conversion
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_ai_design",
"arguments": {
"ai_design_id": 51234
}
}
}{
"jsonrpc": "2.0",
"id": 1,
"result": {
"structuredContent": {
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
"store": {
"id": 12,
"name": "Demo Signs"
},
"ai_design": {
"id": 51234,
"origin": "quote",
"status": "delivered",
"product_family": "neon",
"customiser_id": 42,
"files": [
{
"kind": "svg",
"purpose": "design",
"media_type": "image/svg+xml",
"access": "private",
"download_url": null
},
{
"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": "thumbs_up",
"created_at": "2026-10-20T09:32:00Z"
}
}
}
}A design of another store (error)
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_ai_design",
"arguments": {
"ai_design_id": 99999
}
}
}{
"jsonrpc": "2.0",
"id": 1,
"result": {
"isError": true,
"structuredContent": {
"error": {
"code": "resource_not_found",
"title": "Resource not found",
"detail": "The requested resource does not exist or does not belong to the authenticated store.",
"recovery": "The identifier does not exist in this store. Use the matching list tool to rediscover a valid id."
}
}
}
}