# POST 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.

- Source URL: https://www.signcustomiser.com/help/api/v3-post-convert-a-quote-file-with-the-ai-sign-designer/
- Markdown URL: https://www.signcustomiser.com/help/api/v3-post-convert-a-quote-file-with-the-ai-sign-designer.md
- Group: AI sign designs
- OpenAPI for this group: https://www.signcustomiser.com/help/openapi/ai-sign-designs.json
- Method: POST
- Path: /api/v3/quotes/{quote_id}/ai-designs
- Auth: Bearer token
- Required scopes: `quotes:read`

## Path parameters

- quote_id (string, required): The submission id, from the list quotes operation. Example: 8123

## Body parameters

- field_id (string, optional): No description provided.
- file_index (integer, optional): No description provided.

## Request body example

```json
{
  "field_id": "field_artwork",
  "file_index": 0
}
```

## cURL example

```bash
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 examples

### 200 Converted before

```json
{
  "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"
  }
}
```

### 202 POST 202 example 2

```json
{
  "data": {
    "object": "ai_design",
    "id": 51234,
    "origin": "quote",
    "status": "processing",
    "product_family": "neon",
    "customiser_id": 42,
    "files": [
      {
        "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/ai-designs/51234",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}
```

### 400 Missing idempotency key

```json
{
  "type": "https://www.signcustomiser.com/help/api/problems/missing_idempotency_key",
  "title": "Missing idempotency key",
  "status": 400,
  "code": "missing_idempotency_key",
  "detail": "Provide an Idempotency-Key header for this write.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
```

### 401 Missing API key

```json
{
  "type": "https://www.signcustomiser.com/help/api/problems/missing_api_key",
  "title": "Missing API key",
  "status": 401,
  "code": "missing_api_key",
  "detail": "Provide a store API key as a bearer token.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
```

### 403 Insufficient scope

```json
{
  "type": "https://www.signcustomiser.com/help/api/problems/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "This operation requires the quotes:read scope, but the API key grants the following scopes: ai_sign_designs:write. Create a key that includes the required scope in the merchant admin under Integrate → API Tokens.",
  "required_scopes": [
    "quotes:read"
  ],
  "granted_scopes": [
    "ai_sign_designs:write"
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
```

### 404 Unknown quote

```json
{
  "type": "https://www.signcustomiser.com/help/api/problems/resource_not_found",
  "title": "Resource not found",
  "status": 404,
  "code": "resource_not_found",
  "detail": "The requested resource does not exist or does not belong to the authenticated store.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
```

### 409 Low credit

```json
{
  "type": "https://www.signcustomiser.com/help/api/problems/insufficient_credits",
  "title": "Insufficient credits",
  "status": 409,
  "code": "insufficient_credits",
  "detail": "A design job reserves 1 credit before it starts, and this store has 0 available. Nothing was reserved, and the source was not used. Add credits in the merchant admin, then retry with the same source.",
  "required_units": 1,
  "available_units": 0,
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
```

### 409 Idempotency conflict

```json
{
  "type": "https://www.signcustomiser.com/help/api/problems/idempotency_key_conflict",
  "title": "Idempotency key conflict",
  "status": 409,
  "code": "idempotency_key_conflict",
  "detail": "This Idempotency-Key was already used for a different request body on this operation.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
```

### 410 Quote erased

```json
{
  "type": "https://www.signcustomiser.com/help/api/problems/quote_redacted",
  "title": "Quote erased",
  "status": 410,
  "code": "quote_redacted",
  "detail": "The shopper's data in this quote was erased, so its files cannot be converted. Nothing was reserved. Do not retry.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
```

### 422 Unknown quote file

```json
{
  "type": "https://www.signcustomiser.com/help/api/problems/quote_file_not_found",
  "title": "Quote file not found",
  "status": 422,
  "code": "quote_file_not_found",
  "detail": "The quote has no file with this field_id and file_index. Read the quote: files lists every file it has. Nothing was reserved.",
  "errors": [
    {
      "pointer": "/file_index",
      "code": "not_found",
      "detail": "The quote has no file with this field_id and file_index. Read the quote: files lists every file it has."
    }
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
```

### 422 File type not convertible

```json
{
  "type": "https://www.signcustomiser.com/help/api/problems/quote_file_not_convertible",
  "title": "Quote file not convertible",
  "status": 422,
  "code": "quote_file_not_convertible",
  "detail": "The AI sign designer converts only PNG, JPEG, WebP, AVIF, SVG and PDF files, and this quote file is none of them. Nothing was reserved.",
  "errors": [
    {
      "pointer": "/file_index",
      "code": "content_type_mismatch",
      "detail": "The AI sign designer converts only PNG, JPEG, WebP, AVIF, SVG and PDF files, and this quote file is none of them.",
      "allowed_values": [
        "image/png",
        "image/jpeg",
        "image/webp",
        "image/avif",
        "image/svg+xml",
        "application/pdf"
      ]
    }
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
```

### 429 Designer busy

```json
{
  "type": "https://www.signcustomiser.com/help/api/problems/ai_sign_design_capacity_reached",
  "title": "AI sign design capacity reached",
  "status": 429,
  "code": "ai_sign_design_capacity_reached",
  "detail": "The most design jobs that can run at the same time are already running. Nothing was reserved, and the source was not used. Retry with the same Idempotency-Key and body after retry_after seconds.",
  "retry_after": 30,
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
```

### 503 Designs unavailable

```json
{
  "type": "https://www.signcustomiser.com/help/api/problems/ai_sign_designer_unavailable",
  "title": "AI sign designer unavailable",
  "status": 503,
  "code": "ai_sign_designer_unavailable",
  "detail": "AI sign design jobs cannot start for this store yet. No credit was reserved and no work started. Sources and jobs that already exist stay readable. Read GET /api/v3/ai-sign-design-capabilities and try again when available is true.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
```
