Introduction
The Get Design Image API is designed to retrieve the generated image output of a customized design. It enables applications to fetch preview images, rendered artwork, or final design visuals associated with a specific design ID. This API is commonly used in product personalization platforms where users create custom products such as apparel, merchandise, packaging, or print-ready assets.
The API helps frontend applications, admin systems, and production workflows display or download the latest design image generated during the customization process. Depending on the configuration, the response may include image URLs, rendering status, preview formats, dimensions, or downloadable assets required for visualization and fulfillment workflows.
Typically, this API is invoked after a design has been created or modified, allowing systems to retrieve the most recent visual representation of the customized product. It plays a critical role in enabling real-time previews, approval workflows, production validation, and customer-facing design experiences
Use Cases
- Product Personalization Preview
Retrieve the latest generated image for a customized product so users can preview their design before placing an order.
- Cart and Checkout Visualization
Display finalized product mockups inside cart, checkout, or order summary pages to improve customer confidence.
- Print Production Workflow
Fetch high-quality rendered images or print-ready assets for downstream manufacturing and printing systems.
- Design Approval Process
Allow customers or internal teams to review and approve generated design visuals before production begins.
- Marketplace and Catalog Rendering
Generate dynamic product thumbnails and personalized product images for storefront listings or marketing campaigns.
- Order Management Systems
Display associated design images within order history, order tracking, or customer support portals.
- Mobile and Web Applications
Enable real-time rendering and image synchronization across multiple platforms and devices.
- Download and Sharing Features
Allow users to download or share their personalized design image through external channels or social platforms.
Endpoint
GET /api/4/ Design/GetDesignImage
curl --location 'https://api.artifi.net/api/4/Design/GetDesignImage?designId=42815102&viewCode=153617&width=500&height=500' \
--header 'websiteId: 23' \
--header 'webApiClientKey: c961461a-bQWA287-448c-b9ea-e1162bd2f0b8h'
Parameters
Header Validation
Header Name | Type | Required | Description |
websiteId | int | Yes | Unique identifier of the website. |
webApiClientKey | string | Yes | API client key used for authentication. |
Query Parameters
Name | Type | Required | Description |
DesignId | Integer | yes | This is the ID of the designed product that gets added to cart. Design ID is created when the user adds the customized product to the cart.
|
viewCode | string | Yes | This parameter becomes mandatory when a specific view needs to be pulled from the product. If not specified, the default view image will be pulled by the API.
|
Width | Int | No | This parameter refers to the width of the output image. |
Height | Int | No | This parameter refers to the height of the output image. |
Success Responses
Returns a physical PNG image file with content type image/png
- If Width and Height are provided: returns a resized thumbnail image.
- If Width and Height are not provided (0): returns a standard-sized image resized to the design's canvas dimensions.
Error Code List (Click Here)
Q&A
1. What does the Get Design Image API return?
It returns a generated image of the customized design only, without any product mockup or background.
2. What is the response format of this API?
The API returns a binary image file, not a JSON response.
3. What is the content type of the response?
The response content type is image/png (or as defined by DesignImageMediaType).
4. Does the API return a downloadable file?
Yes, the response is raw image data that can be directly downloaded or rendered in a browser or application.
5. Can I control the size of the returned image?
Yes, you can specify Width and Height parameters to control the output size.
6. What happens when Width and Height are provided?
The API returns a resized thumbnail image based on the given dimensions.
7. What happens when Width and Height are not provided or set to 0?
The API returns an image resized to the design’s original canvas dimensions.
8. Does this API return the full product image?
No, it only returns the design layer (customization artwork), not the product visualization.
9. Can this API be used for previewing designs?
Yes, it is ideal for design-only previews where product context is not required.
10. Is this suitable for print workflows?
Yes, the returned design image can be used as a base asset for printing or further processing.
11. Can the output image be high resolution?
Yes, if the design canvas is high resolution and no resizing is applied, the output will match that quality.
12. Does the API support multiple image formats?
By default, it returns PNG, but the format may vary depending on the configured DesignImageMediaType.
13. Is authentication required to access this API?
Yes, proper authentication/authorization is required to securely fetch design images.
14. Can this API be used in real-time design editors?
Yes, it can be used to fetch updated design images after each modification.
15. What happens if the design image is not yet generated?
The API may return an error or processing state, depending on implementation.
16. Can this API be used for sharing designs?
Yes, since it returns a standalone design image, it can be easily shared or exported.
17. Does the API include metadata in the response?
No, the response is strictly binary image data. Any metadata must be handled separately.