Sign Customiser

Navigation

Dark mode

AI sign designs

Convert a quote file with the AI sign designer

Copy page

Starts the AI sign designer on one file of a quote, as Convert with AI does on the merchant admin's Quotes page. Name the file with the field_id and file_index of the quote's files.

POST/api/v3/quotes/{quote_id}/ai-designs
POSTConvert a quote file with the AI sign designer
POST/api/v3/quotes/{quote_id}/ai-designs

Convert a quote file with the AI sign designer

Starts the AI sign designer on one file of a quote, as Convert with AI does on the merchant admin's Quotes page. Name the file with the `field_id` and `file_index` of the quote's `files`. Requires `ai_sign_designs:write` and `quotes:read`, and an `Idempotency-Key`. Another store's quote and an unknown id answer the same 404. Credits: the design holds one credit before any work starts. A delivered design charges that credit, and a refused or failed design releases it. With no credit available this answers 409 `insufficient_credits` and nothing is reserved. The response is the new AI design with `status` `processing` and `origin` `quote`; read it with the get AI design operation until `status` changes. A quote file is converted once. If the file was converted before, in the merchant admin or with this operation, this answers 200 with that design and charges nothing. A retry with the same `Idempotency-Key` and body returns the first answer and charges nothing more. The AI sign designer reads PNG, JPEG, WebP, AVIF, SVG and PDF files within the source limits of `GET /api/v3/ai-sign-design-capabilities`. This operation checks the file's size, its signature and the dimensions in its header, and answers 422 `quote_file_not_convertible` when one fails. The queued designer then copies the file to private storage and decodes it before any paid work; if that fails, the design ends `failed` and nothing is charged. The copy and every file the design makes are stored privately. An erased quote answers 410 `quote_redacted`. These designs share the in-flight limits and the per-key admission budget of AI sign design jobs: if the designer is busy this answers 429 `ai_sign_design_capacity_reached` with `Retry-After`, so retry with the same key. While the AI sign designer is turned off, or designs cannot start for this store yet, this answers 503 `ai_sign_designer_unavailable` and nothing is reserved. To check a conversion first without spending anything, use the validate operation.

Authorisation

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

Path

The submission id, from the list quotes operation.

Body
Convert a quote file with the AI sign designer

Overview

Requires ai_sign_designs:write and quotes:read, and an Idempotency-Key. Another store's quote and an unknown id answer the same 404. Credits: the design holds one credit before any work starts. A delivered design charges that credit, and a refused or failed design releases it. With no credit available this answers 409 insufficient_credits and nothing is reserved. The response is the new AI design with status processing and origin quote; read it with the get AI design operation until status changes. A quote file is converted once. If the file was converted before, in the merchant admin or with this operation, this answers 200 with that design and charges nothing. A retry with the same Idempotency-Key and body returns the first answer and charges nothing more. The AI sign designer reads PNG, JPEG, WebP, AVIF, SVG and PDF files within the source limits of GET/api/v3/ai-sign-design-capabilities. This operation checks the file's size, its signature and the dimensions in its header, and answers 422 quote_file_not_convertible when one fails. The queued designer then copies the file to private storage and decodes it before any paid work; if that fails, the design ends failed and nothing is charged. The copy and every file the design makes are stored privately. An erased quote answers 410 quote_redacted. These designs share the in-flight limits and the per-key admission budget of AI sign design jobs: if the designer is busy this answers 429 ai_sign_design_capacity_reached with Retry-After, so retry with the same key. While the AI sign designer is turned off, or designs cannot start for this store yet, this answers 503 ai_sign_designer_unavailable and nothing is reserved. To check a conversion first without spending anything, use the validate operation.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: quotes:read

Path parameters

quote_idstringpathrequired

The submission id, from the list quotes operation.

Example: 8123

Request body

field_idstringbody
file_indexintegerbody

Request body example

application/json
{
  "field_id": "field_artwork",
  "file_index": 0
}
Convert a quote file with the AI sign designer
curl https://web.signcustomiser.com/api/v3/quotes/8123/ai-designs \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "field_id": "field_artwork",
  "file_index": 0
}'
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": "source",
        "purpose": "source",
        "media_type": "image/png",
        "access": "private",
        "url": "https://web.signcustomiser.com/api/v3/ai-designs/51234/files/source",
        "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"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/quotes/8123/ai-designs",
    "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.