Sign Customiser

Navigation

Dark mode

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.

GET/api/v3/ai-designs/{ai_design_id}/files/{file_kind}
GETDownload an AI design file
GET/api/v3/ai-designs/{ai_design_id}/files/{file_kind}

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

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

Path

The AI design id.

The file to download. One of svg, eps, illustrator_pdf, raster_preview, face_svg, source, source_preview.

Download an AI design file

Click Send to see the live response.

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

ai_design_idstringpathrequired

The AI design id.

Example: 51234

file_kindstringpathrequired

The file to download. One of svg, eps, illustrator_pdf, raster_preview, face_svg, source, source_preview.

Example: svg

Download an AI design file
curl https://web.signcustomiser.com/api/v3/ai-designs/51234/files/svg \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
<<binary>> The file, in its own media type.

Type a question and press Enter. Use the arrow keys to move between the results.