Sign Customiser

Navigation

Dark mode

AI sign designs

list_ai_designs

read

List AI designs

Copy page

Find the AI designs shoppers and the merchant made, and see which ones were delivered, refused or failed.

Overview

List the AI designs of this store, newest first, with an opaque cursor: the designs shoppers made in the customer customiser, quote files converted with the AI sign designer, merchant admin uploads and AI sign design jobs. Filter by status, origin, customiser_id or creation day. Each design has its outcome, its files and the products, orders and quote it is linked to. 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

readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
openWorldHintfalse

Prerequisites

  • A merchant has connected this store and approved the ai_sign_designs:read scope.

Arguments

limitinteger

How many designs to return per page, between 1 and 100. Defaults to 20.

cursorstring

The opaque next_cursor value from the previous page, sent back with identical filters and timezone.

filterobject

Optional filters. An unknown filter is rejected, never ignored.

filter.statusstring

Only designs with this status: processing, delivered, refused, failed. Expected to grow.

filter.originstring

Only designs from this origin: customer_customiser, quote, merchant_admin, api. Expected to grow.

filter.customiser_idinteger

Only designs made in this customiser.

filter.created_fromstring

The first included creation day, YYYY-MM-DD, counted in timezone.

filter.created_tostring

The last included creation day, YYYY-MM-DD, counted in timezone. It must not precede created_from.

timezonestring

The IANA timezone the creation days are counted in, such as Australia/Sydney. Defaults to UTC.

Result

A page of designs and the pagination block. An erased design is not listed. Each file has a download_url only when the design has a no-login link; a private file of a shopper, quote or merchant admin design has none.

request_idstringalways present
storeobjectalways present
store.idintegeralways present
store.namestringalways present
ai_designsarray of objectalways present

The page of designs, newest first.

ai_designs[].idintegeralways present
ai_designs[].originstringalways present

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

ai_designs[].statusstringalways present

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

ai_designs[].product_familystring or null

One of: neon, channel_letter, metal_cut_out

ai_designs[].customiser_idinteger or null
ai_designs[].filesarray of objectalways present

The SVG, EPS, PDF, preview and face files only when status is delivered, and the uploaded source and its preview for every status.

ai_designs[].files[].kindstringalways present

One of: svg, eps, illustrator_pdf, raster_preview, face_svg, source, source_preview

ai_designs[].files[].purposestringalways present
ai_designs[].files[].media_typestringalways present
ai_designs[].files[].accessstringalways present

One of: private, public

ai_designs[].files[].download_urlstring or null

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.

ai_designs[].product_idsarray of integeralways present
ai_designs[].order_idsarray of integeralways present
ai_designs[].quote_idinteger or null
ai_designs[].quote_fileobject or null

The quote file the design was converted from, or null.

ai_designs[].quote_file.field_idstringalways present
ai_designs[].quote_file.file_indexintegeralways present
ai_designs[].ai_sign_design_job_idstring or null
ai_designs[].feedback_ratingstring or null

One of: thumbs_up, thumbs_down

ai_designs[].created_atstringalways present
paginationobjectalways present
pagination.has_morebooleanalways present
pagination.next_cursorstring or null

Error cases

insufficient_scope

The connection was approved without ai_sign_designs:read.

invalid_cursor

The cursor belongs to other filters. Call the tool again without a cursor.

invalid_parameter

A filter value is not supported; allowed_values lists the accepted values.

List the delivered designs

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_ai_designs",
    "arguments": {
      "filter": {
        "status": "delivered"
      }
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": {
      "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
      "store": {
        "id": 12,
        "name": "Demo Signs"
      },
      "ai_designs": [
        {
          "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"
        }
      ],
      "pagination": {
        "has_more": false,
        "next_cursor": null
      }
    }
  }
}

A status that does not exist (error)

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_ai_designs",
    "arguments": {
      "filter": {
        "status": "downloadable"
      }
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "isError": true,
    "structuredContent": {
      "error": {
        "code": "invalid_parameter",
        "title": "Invalid query parameter",
        "detail": "The filter[status] value is not a supported AI design status.",
        "recovery": "Correct the parameter named in parameter. Dates are YYYY-MM-DD in UTC and identifiers are integers between 1 and 2147483647.",
        "parameter": "filter[status]",
        "allowed_values": [
          "processing",
          "delivered",
          "refused",
          "failed"
        ]
      }
    }
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.