Sign Customiser

Navigation

Dark mode

AI sign designs

Validate a quote file conversion

Copy page

Dry-runs the convert a quote file operation with the same body. It returns the problem the conversion would return, or a verdict.

POST/api/v3/quotes/{quote_id}/ai-designs/validate-create
POSTValidate a quote file conversion
POST/api/v3/quotes/{quote_id}/ai-designs/validate-create

Validate a quote file conversion

Dry-runs the convert a quote file operation with the same body. It returns the problem the conversion would return, or a verdict. Requires `ai_sign_designs:write` and `quotes:read`. Nothing is reserved, no file is copied, no idempotency key is used, no budget is spent and no work starts. It reads only the start of the quote file, to check its type and header; the conversion checks everything again. `ai_design_id` is the design already made from the file, or null. `required_units` is the credits the conversion would hold: 1, or 0 when the file was converted before. `available_units` is the credits the store has.

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
Validate a quote file conversion

Overview

Requires ai_sign_designs:write and quotes:read. Nothing is reserved, no file is copied, no idempotency key is used, no budget is spent and no work starts. It reads only the start of the quote file, to check its type and header; the conversion checks everything again. ai_design_id is the design already made from the file, or null. required_units is the credits the conversion would hold: 1, or 0 when the file was converted before. available_units is the credits the store has.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: ai_sign_designs:write

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
}
Validate a quote file conversion
curl https://web.signcustomiser.com/api/v3/quotes/8123/ai-designs/validate-create \
  --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_validation",
    "operation": "create",
    "valid": true,
    "ai_design_id": 51234,
    "required_units": 0,
    "available_units": 24
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/quotes/8123/ai-designs/validate-create",
    "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.