AI sign designs
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.
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
The submission id, from the list quotes operation.
Example: 8123
Request body
Request body example
{
"field_id": "field_artwork",
"file_index": 0
}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
}'{
"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": "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"
}{
"type": "https://www.signcustomiser.com/help/api/problems/insufficient_scope",
"title": "Insufficient scope",
"status": 403,
"code": "insufficient_scope",
"detail": "This operation requires the ai_sign_designs:write scope.",
"required_scopes": [
"ai_sign_designs:write"
],
"granted_scopes": [
"ai_sign_designs:read"
],
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"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"
}{
"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"
}{
"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"
}{
"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"
}{
"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"
}{
"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"
}