Sign Customiser

Navigation

Dark mode

Returns one AI design of the store: its origin, its outcome, its files and the products, orders and quote it is linked to. Requires ai_sign_designs:read.

GET/api/v3/ai-designs/{ai_design_id}
GETGet an AI design
GET/api/v3/ai-designs/{ai_design_id}

Get an AI design

Returns one AI design of the store: its origin, its outcome, its files and the products, orders and quote it is linked to. Requires `ai_sign_designs:read`. Another store's design and an unknown id answer the same 404, and so does an erased design. Each file in `files` has a `url` that downloads it with your API key. `access` says where the file is stored. A `private` file of an `api` design also has a `download_url` that needs no key or login; it stops working if the design is erased. A `public` file is a file of a design made before private storage: its `download_url` is a public storage URL, which anyone with the URL can read, which cannot be revoked, and which outlives erasure. The SVG, EPS, PDF, preview and face files are listed only when `status` is `delivered`. The files of refused and failed attempts and the designer's diagnostic files are never published. The `source` and `source_preview` files of a `quote` design are the shopper's original quote file, so they also need `quotes:read`, as the quote does. Without it, their `download_url` is null and their `url` answers 403. The shopper's name, email and contact details are never returned.

Authorisation

The Authorization header expects a Bearer token. Generate one on the API keys page in your dashboard.

Path

The AI design id, from the list AI designs operation.

Get an AI design

Click Send to see the live response.

Overview

Another store's design and an unknown id answer the same 404, and so does an erased design. Each file in files has a url that downloads it with your API key. access says where the file is stored. A private file of an api design also has a download_url that needs no key or login; it stops working if the design is erased. A public file is a file of a design made before private storage: its download_url is a public storage URL, which anyone with the URL can read, which cannot be revoked, and which outlives erasure. The SVG, EPS, PDF, preview and face files are listed only when status is delivered. The files of refused and failed attempts and the designer's diagnostic files are never published. The source and source_preview files of a quote design are the shopper's original quote file, so they also need quotes:read, as the quote does. Without it, their download_url is null and their url answers 403. The shopper's name, email and contact details are never returned.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: ai_sign_designs:read

Path parameters

ai_design_idstringpathrequired

The AI design id, from the list AI designs operation.

Example: 51234

Get an AI design
curl https://web.signcustomiser.com/api/v3/ai-designs/51234 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "data": {
    "object": "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",
        "url": "https://web.signcustomiser.com/api/v3/ai-designs/51234/files/svg",
        "download_url": null
      },
      {
        "kind": "eps",
        "purpose": "manufacturing_export",
        "media_type": "application/postscript",
        "access": "private",
        "url": "https://web.signcustomiser.com/api/v3/ai-designs/51234/files/eps",
        "download_url": null
      },
      {
        "kind": "illustrator_pdf",
        "purpose": "manufacturing_export",
        "media_type": "application/pdf",
        "access": "private",
        "url": "https://web.signcustomiser.com/api/v3/ai-designs/51234/files/illustrator_pdf",
        "download_url": null
      },
      {
        "kind": "raster_preview",
        "purpose": "preview",
        "media_type": "image/png",
        "access": "private",
        "url": "https://web.signcustomiser.com/api/v3/ai-designs/51234/files/raster_preview",
        "download_url": null
      },
      {
        "kind": "source",
        "purpose": "source",
        "media_type": "image/png",
        "access": "private",
        "url": "https://web.signcustomiser.com/api/v3/ai-designs/51234/files/source",
        "download_url": null
      },
      {
        "kind": "source_preview",
        "purpose": "source",
        "media_type": "image/png",
        "access": "private",
        "url": "https://web.signcustomiser.com/api/v3/ai-designs/51234/files/source_preview",
        "download_url": null
      }
    ],
    "product_ids": [
      90211
    ],
    "order_ids": [
      123
    ],
    "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"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/ai-designs/51234",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

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