AI sign designs
Download an AI design file
Downloads one file of an AI design as an attachment. Requires
ai_sign_designs:read. file_kind is one of svg, eps,
illustrator_pdf, raster_preview, face_svg, source or
source_preview; any other value answers 404, as does another store's
design.
Overview
A kind that is not in the design's files answers 409
ai_sign_design_file_not_ready: the SVG, EPS, PDF, preview and face
files exist only when status is delivered. The source and
source_preview files of a quote design are the shopper's original
quote file and also need quotes:read; without it they answer 403
insufficient_scope. To give a file to someone without an API key,
give them its download_url when it has one.
The response media type is the file's own: image/svg+xml for svg
and face_svg, application/postscript for eps, application/pdf
for illustrator_pdf (an Illustrator-compatible PDF, not a native
Illustrator file), image/png for raster_preview, the type of the
uploaded artwork for source, and a PNG, JPEG or WebP image for
source_preview.
Authorisation
Bearer token required. Include it in the Authorization header.
Required scope: ai_sign_designs:read
Path parameters
The AI design id.
Example: 51234
The file to download. One of svg, eps, illustrator_pdf, raster_preview, face_svg, source, source_preview.
Example: svg
curl https://web.signcustomiser.com/api/v3/ai-designs/51234/files/svg \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN'<<binary>> The file, in its own media type.{
"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:read scope.",
"required_scopes": [
"ai_sign_designs:read"
],
"granted_scopes": [
"customisers: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/ai_sign_design_file_not_ready",
"title": "Design file not ready",
"status": 409,
"code": "ai_sign_design_file_not_ready",
"detail": "This file does not exist for this AI design. Read the design: files lists every file it has. The SVG, EPS, PDF, preview and face files exist only when status is delivered, and a refused or failed design has none of them.",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/rate_limited",
"title": "Too many requests",
"status": 429,
"code": "rate_limited",
"detail": "You have exceeded the request limit for this API key.",
"retry_after": 60,
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}