The Imagine API enables developers to automate the creation of production-ready eCommerce content — from asset upload to final delivery — using simple REST APIs.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"17543092","collectionId":"afe55ef7-a259-4c44-8acb-246d28707c28","publishedId":"2sAYX8GfPM","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-04-04T19:29:50.000Z"},"item":[{"name":"Setup & Usage Guide","item":[],"id":"b845bbec-44be-44c0-abd3-64416ad04c0c","description":"The Imagine.io API lets you programmatically create, manage, and deliver production-ready eCommerce visual content from your own 3D models. The platform supports two primary workflows:
\nUpload your 3D model and use the API to automatically generate rich visual content — including an interactive 3D Model Viewer, Augmented Reality (AR) experiences, 360° Spin views, and Silo Images with clean backgrounds using a default template. Once processing is complete, all generated assets are delivered as ready-to-use URLs that you can embed directly into your website, mobile app, or product detail pages.
\nPlace your uploaded products into professionally designed scenes (also called templates) to generate photorealistic rendered images — with full control over camera angles, product positioning, rotation, and material options. This workflow enables you to produce lifestyle imagery, marketing visuals, and catalog-ready product shots at scale, entirely through the API.
\nThis section covers everything required to start using the Imagine.io APIs, including authentication, variables, headers, and common workflows.
\nIt is the single source of truth for:
\nAuthentication
\nHow to get API keys
\nKey types
\nRequired request headers
\nAPI scopes
\nHow to manage API keys (rotate, revoke, update domains/scopes)
\nSecurity best practices
\nBase URL
\nCommon collection variables
\nAPI credits
\nPagination
\nShared workflow guidance
\nError responses
\nAll Imagine APIs use header-based authentication via API keys passed in the request header.
\nLogin at https://app.imagine.io/
\nOpen Settings (top-right profile menu)
\nGo to the API tab
\nClick Create Key in the API Access section
\nSelect Key Type (Public or Secret)
\nEnter a Label (e.g., \"Production Server\", \"Staging\")
\nAdd Allowed Domains (e.g., yourdomain.com or localhost:3000)
Select the required scopes (listed below)
\nClick Create
\nCopy the key from the API Access list
\nEvery API request must include the following headers:
\nAuthorization: Imagine-key {{your_api_key}}\nOrigin: {{your_registered_domain}}\nContent-Type: application/json\n\n\n\nAbout the
\nOriginheader: All requests must include anOriginheader matching one of the domains registered against your API key. Requests with a missing or unregisteredOriginwill be rejected with401 Unauthorized.
API keys must be created with the required scope(s) for the APIs you intend to use. Scopes define access permissions and must be selected during key creation.
\n\n\nNote: Requests made without the required scope will return
\n403 Forbidden.
Use the table below to pick the correct key type for each operation. Public keys are safe for client-side use; secret keys must remain server-side only.
\nAfter creating your API keys, you may need to update them over time — for example, when deploying to a new environment, changing permissions, rotating keys for security, or permanently disabling a key that is no longer needed.
\nAll key management actions are available from the API Access section under Settings → API. Each key in the list has a ⋮ (three-dot) menu on the right side of its row. Clicking it opens a dropdown with five actions — Copy Key, Add/Update Domains, Add/Update Scope, Regenerate Key, and Revoke Key — covering everything you need to maintain and secure your API keys without having to create new ones from scratch.
\nUse when: a key is compromised, or you want to rotate keys periodically as a security practice.
\nLogin at https://app.imagine.io/
\nOpen Settings (top-right profile menu)
\nGo to the API tab
\nLocate the key you want to rotate in the API Access list
\nClick the ⋮ (three-dot menu) on the right of that row
\nSelect Regenerate Key
\nConfirm the action in the popup
\nCopy the new key value immediately — the old key is invalidated instantly
\nUpdate all applications, scripts, and environment variables with the new value
\n\n\nHeads up: Regenerating invalidates the old key immediately. Plan ahead and update your applications with the new value to avoid downtime.
\n
Use when: an employee leaves, a key is exposed, or the key is no longer needed.
\nLogin at https://app.imagine.io/
\nOpen Settings (top-right profile menu)
\nGo to the API tab
\nLocate the key you want to revoke in the API Access list
\nClick the ⋮ (three-dot menu) on the right of that row
\nSelect Revoke Key
\nConfirm the action in the popup
\n\n\nHeads up: Revoked keys cannot be restored. Any application still using a revoked key will receive
\n401 Unauthorizedimmediately. Create a new key if you need to restore access.
Use when: deploying to a new domain or removing one — without creating a new key.
\nLogin at https://app.imagine.io/
\nOpen Settings (top-right profile menu)
\nGo to the API tab
\nLocate the key in the API Access list
\nClick the ⋮ (three-dot menu) on the right of that row
\nSelect Add/Update Domains
\nAdd new domains (e.g., yourdomain.com, staging.yourdomain.com) or remove existing ones
Click Save to apply the changes
\n\n\nNote: Requests from a domain not on the allowed list are rejected. Changes take effect immediately.
\n
Use when: granting new permissions (e.g., Generate Content) or restricting access — without creating a new key.
\nLogin at https://app.imagine.io/
\nOpen Settings (top-right profile menu)
\nGo to the API tab
\nLocate the key in the API Access list
\nClick the ⋮ (three-dot menu) on the right of that row
\nSelect Add/Update Scope
\nCheck or uncheck the scopes you want to grant or revoke (see the Scopes table above)
\nClick Save to apply the changes
\n\n\nNote: Removing a scope causes related API calls to return
\n403 Forbiddenimmediately. Changes take effect right away.
Keep secret keys secure — never expose them in frontend code
\nDo not commit API keys to source control
\nRotate keys immediately if exposed (see Regenerate Key above)
\nUse public keys for read-only client-side operations
\nAll API requests are made to the following base URL:
\nhttps://api.imagine.io\n\nAppend the endpoint path to this base URL for every request. For example:
\nPOST https://api.imagine.io/v1/product/details/\nGET https://api.imagine.io/v1/product/status/\nPOST https://api.imagine.io/v1/product/job/\n\nResponses may include the api_hits_available field to help you track your remaining usage credits. Each API hit deducts one credit. For additional information or support, please contact Imagine.io: https://imagine.io/company/contact-us
APIs that return lists (e.g. Get / List Products, Get Images) use pagination. Every paginated response includes:
\nUsage: To iterate through all pages, follow next_link until it returns null.
Default page size: 20 results per page.
\n\n\nTip: Use query parameters like
\nunicode,sku_id, orgtinto filter results and reduce the number of pages.
APIs follow an asynchronous processing model. Operations such as content generation and image rendering are not completed instantly and require follow-up status checks or result retrieval.
\n\n\nNote: You can also retrieve rendered images and their statuses using the
\n
Get Product Content Status and Get Shared Content APIs. Rendered images generated through the Image Rendering workflow can be fetched alongside your product content (3D Model Viewer, AR, 360 Degree Spin, and Silo Images). Currently, only Silo Images are available as rendered image output through these APIs. Support for additional rendered image types will be added in future updates.
Content generation and image rendering are asynchronous processes and may take a few minutes to complete.
\nRecommended Approach:
\nWait 3–5 minutes after job creation before the first check
\nRetry every 2–3 minutes if results are not ready
\nStop polling when the status is Done or Failed
Avoid:
\nImmediate polling after job creation
\nHigh-frequency repeated requests
\nAll Imagine APIs return standard HTTP status codes.
\n","_postman_id":"b845bbec-44be-44c0-abd3-64416ad04c0c"},{"name":"Product Upload & Management","item":[{"name":"Create Product","event":[{"listen":"test","script":{"exec":["const res = pm.response.json();","pm.test(\"status=true\", function () {"," pm.expect(res.status).to.eql(true);","});","// Auto-save product_unicode and S3 upload URLs for subsequent requests","if (res.status && res.data) {"," const d = res.data;"," if (d.unicode) pm.collectionVariables.set(\"product_unicode\", d.unicode);"," if (d.presigned_url_prop_user_file && d.presigned_url_prop_user_file.url) {"," pm.collectionVariables.set(\"s3_prop_url\", d.presigned_url_prop_user_file.url);"," }"," if (d.presigned_url_thumbnail && d.presigned_url_thumbnail.url) {"," pm.collectionVariables.set(\"s3_thumbnail_url\", d.presigned_url_thumbnail.url);"," }","}"],"type":"text/javascript","packages":{},"requests":{},"id":"5d0b79c9-348b-4a84-80c3-ba9221798e79"}}],"id":"20153d88-e3fd-4732-8aab-c6a83001b606","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Imagine-key sk_your_secret_key_here","type":"default"},{"key":"Origin","value":"yourdomain.com","type":"default"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Astronaut Space Suit Model","description":"Product name - A human-readable display name for the product | Optional
\n","type":"text"},{"key":"main_asset_name","value":"astronaut_suit","description":"Main asset name - identifier for the product's 3D asset | Optional
\n","type":"text"},{"key":"sku_id","value":"SKU-ASTRONAUT-00001","description":"SKU ID - Stock Keeping Unit identifier for inventory tracking | Optional
\n","type":"text"},{"key":"prop_data_user_file_name","value":"astronaut.glb","description":"3D model filename - Name of the file to be uploaded (must include extension)
\n","type":"text"},{"key":"thumbnail_name","value":"astronaut_suit_thumb.png","description":"Thumbnail filename - Name of the preview image file to be uploaded (PNG/JPG format)
\n","type":"text"},{"key":"gtin","value":"3210987654321","description":"Global Trade Item Number. | Optional
\n","type":"text","uuid":"028690b5-59f1-4ab0-88a2-15a4cf41d1d7"}]},"url":"https://api.imagine.io/v1/product/details/","description":"Endpoint: POST /v1/product/details/
Authentication: Secret Key required
Creates a new product record and returns presigned S3 upload URLs for both the 3D model and thumbnail image. This is the first step in the product upload workflow.
\nAuthorization: Imagine-key sk_your_secret_key_here
Origin: yourdomain.com
Content-Type: multipart/form-data
Returns a JSON object containing:
\nunicode — the unique identifier for all subsequent API calls
presigned_url_prop_user_file — S3 upload payload for the 3D model file
presigned_url_thumbnail — S3 upload payload for the thumbnail file
Run the Upload 3D Model to S3 request using the model presigned URL.
\nRun the Upload Thumbnail to S3 request using the thumbnail presigned URL.
\nRun the Mark Upload Success request to complete the workflow.
\nThis request saves the following variables for use in subsequent API calls:
\nproduct_unicode — value of the unicode field from the response
`s3_prop_*` — presigned S3 upload URL and associated form fields for the 3D model upload
\n`s3_thumb_*` — presigned S3 upload URL and associated form fields for the thumbnail upload
\nS3 object key
\n"},{"key":"x-amz-algorithm","value":"AWS4-HMAC-SHA256","type":"text","description":"AWS signing algorithm
\n"},{"key":"x-amz-credential","value":"XXXXXXXXXXXXXXXXXXXXXXXXXXXX/XXXXXXXX/us-east-1/s3/aws4_request","type":"text","description":"AWS credentials
\n"},{"key":"x-amz-date","value":"XXXXXXXXTXXXXXXZ","type":"text","description":"Request timestamp
\n"},{"key":"policy","value":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","type":"text","description":"S3 upload policy
\n"},{"key":"x-amz-signature","value":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","type":"text","description":"Request signature
\n"},{"key":"file","description":"3D Model File - Select your .glb file to upload
\n","type":"file","value":""}]},"url":"https://example-bucket.s3.amazonaws.com/","description":"Endpoint: Use the presigned S3 upload URL returned in the Create Product response (for example, presigned_url_prop_user_file.url). Do not use your API base URL for this request.
Authentication: None (presigned URL)
\nThis request uploads the 3D model file directly to the S3 bucket using the presigned URL returned by Create Product. The request is sent to the bucket URL returned in the response, while the required upload fields come from the same presigned payload.
\nUse presigned_url_prop_user_file.url as the request URL
Use the matching presigned_url_prop_user_file.fields values in the form-data body
Do not send this request to https://api.imagine.io
All fields are provided in the Create Product response. Use these values as-is when making the upload request.
\nSuccess: HTTP 204 (No Content)
\nNo response body on success
\nEmpty response indicates successful upload
\nAfter successful upload, proceed to Upload Thumbnail to S3
\n","urlObject":{"protocol":"https","path":[""],"host":["example-bucket","s3","amazonaws","com"],"query":[],"variable":[]}},"response":[{"id":"c4306a2a-03ff-42d2-8f23-ab8ef4889158","name":"✅ 204 - Uploaded (example)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"key","value":"media/private/product/prop_data_user_file/73891/0/prop_data_astronaut.glb","type":"text","description":"S3 object key - Auto-filled from Create Product response"},{"key":"x-amz-algorithm","value":"AWS4-HMAC-SHA256","type":"text","description":"AWS signing algorithm - Auto-filled from presigned URL response"},{"key":"x-amz-credential","value":"XXXXXXXXXXXXXXXXXXXXXXXXXXXX/XXXXXXXX/us-east-1/s3/aws4_request","type":"text","description":"AWS credentials - Auto-filled from presigned URL response"},{"key":"x-amz-date","value":"XXXXXXXXTXXXXXXZ","type":"text","description":"Request timestamp - Auto-filled from presigned URL response"},{"key":"policy","value":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","type":"text","description":"S3 upload policy - Auto-filled from presigned URL response"},{"key":"x-amz-signature","value":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","type":"text","description":"Request signature - Auto-filled from presigned URL response"},{"key":"file","description":"3D Model File - Select your .glb file to upload","type":"file","src":[""]}]},"url":"https://example-bucket.s3.amazonaws.com/"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"6b9c6a0f-7957-4012-a234-a8c3f5a6d131"},{"name":"Upload Thumbnail to S3 (presigned)","event":[{"listen":"test","script":{"id":"a372984b-d78f-425a-bc62-e61ed62749ae","exec":["pm.test(\"S3 upload succeeded (204/201)\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201, 204]);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"9edaf002-e4fb-4aca-a491-e1785194e6f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"key","value":"media/private/product/thumbnail/73891/0/thumbnail_astronaut_suit_thumb.png","type":"text","description":"S3 object key
\n"},{"key":"x-amz-algorithm","value":"AWS4-HMAC-SHA256","type":"text","description":"AWS signing algorithm
\n"},{"key":"x-amz-credential","value":"XXXXXXXXXXXXXXXXXXXXXXXXXXXX/XXXXXXXX/us-east-1/s3/aws4_request","type":"text","description":"AWS credentials
\n"},{"key":"x-amz-date","value":"XXXXXXXXTXXXXXXZ","type":"text","description":"Request timestamp
\n"},{"key":"policy","value":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","type":"text","description":"S3 upload policy
\n"},{"key":"x-amz-signature","value":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","type":"text","description":"Request signature
\n"},{"key":"file","type":"file","description":"Thumbnail Image File - Select your .png or .jpg file to upload
\n","value":""}]},"url":"https://example-bucket.s3.amazonaws.com/","description":"Endpoint: Use the presigned S3 bucket URL returned in the Create Product response (for example, presigned_url_thumbnail.url). Do not use your API base URL for this request.
Authentication: None (presigned URL)
This request uploads the thumbnail image directly to the S3 bucket using the presigned URL returned by Create Product. The request must be sent to the bucket URL from the response, while the required upload fields come from the same presigned payload.
\nUse presigned_url_thumbnail.url as the request URL
Use the matching presigned_url_thumbnail.fields values in the form-data body
Do not send this request to https://api.imagine.io
All fields are automatically populated from the Create Product response:
\nPNG (Portable Network Graphics) - Recommended for transparency
\nJPG/JPEG (Joint Photographic Experts Group) - For smaller file size
\nSuccess: HTTP 204 (No Content)
\nNo response body on success
\nAfter both model and thumbnail are uploaded successfully, run Mark Upload Success to finalize the product creation
\n","urlObject":{"protocol":"https","path":[""],"host":["example-bucket","s3","amazonaws","com"],"query":[],"variable":[]}},"response":[{"id":"10e50309-2a22-4279-9f3b-026604f335a3","name":"✅ 204 - Uploaded (example)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"key","value":"media/private/product/thumbnail/73891/0/thumbnail_astronaut_suit_thumb.png","type":"text","description":"S3 object key - Auto-filled from Create Product response"},{"key":"x-amz-algorithm","value":"AWS4-HMAC-SHA256","type":"text","description":"AWS signing algorithm - Auto-filled from presigned URL response"},{"key":"x-amz-credential","value":"XXXXXXXXXXXXXXXXXXXXXXXXXXXX/XXXXXXXX/us-east-1/s3/aws4_request","type":"text","description":"AWS credentials - Auto-filled from presigned URL response"},{"key":"x-amz-date","value":"XXXXXXXXTXXXXXXZ","type":"text","description":"Request timestamp - Auto-filled from presigned URL response"},{"key":"policy","value":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","type":"text","description":"S3 upload policy - Auto-filled from presigned URL response"},{"key":"x-amz-signature","value":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","type":"text","description":"Request signature - Auto-filled from presigned URL response"},{"key":"file","type":"file","description":"Thumbnail Image File - Select your .png or .jpg file to upload","src":[""]}]},"url":"https://example-bucket.s3.amazonaws.com/"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9edaf002-e4fb-4aca-a491-e1785194e6f9"},{"name":"Mark Upload Success","event":[{"listen":"test","script":{"exec":["// ===== Helper: read variables from globals > environment > collection =====","function getVar(key) {"," return pm.globals.get(key) || pm.environment.get(key) || pm.collectionVariables.get(key);","}","const res = pm.response.json();","pm.test(\"status=true\", function(){ pm.expect(res.status).to.eql(true); });"],"type":"text/javascript","packages":{},"requests":{},"id":"a6531014-e06a-472a-9c7d-7dd3c502d86d"}}],"id":"bbeca97e-4525-4431-9a73-3894b84b0cb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Authorization","value":"Imagine-key sk_your_secret_key_here","type":"default"},{"key":"Origin","value":"yourdomain.com","type":"default"},{"key":"Content-Type","value":"application/json","type":"default"}],"body":{"mode":"raw","raw":"{\n \"action\": \"mark_upload_success\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.imagine.io/v1/product/details/XXX/","description":"Endpoint: PATCH /v1/product/details/XXX/
Authentication: Secret Key required
Notifies the system that both the 3D model and thumbnail have been successfully uploaded to S3. This request must be called after completing both S3 uploads to finalize the product creation process.
\nCall this endpoint only after:
\n✅ 3D model uploaded to S3 (HTTP 204 response)
\n✅ Thumbnail uploaded to S3 (HTTP 204 response)
\nAuthorization: Imagine-key sk_your_secret_key_here
Origin: yourdomain.com
Content-Type: application/json
{\n \"action\": \"mark_upload_success\"\n}\n\nproduct_unicode — The unique product identifier returned as unicode in the Create Product API responseReturns updated product information including:
\nNew upload_status (typically \"2\" for completed)
Returns the updated upload status along with the complete product information.
\nSuccess message
\n1 - Created (awaiting uploads)
2 - Upload complete (ready for content generation)
After marking upload success:
\nProduct becomes available for content generation
\nYou can create content jobs
\nProduct appears in product listings
\nReady for automated processing workflows
\nEndpoint: PATCH /v1/product/details/XXX/
Authentication: Secret Key required
Partially update product metadata. Send only the fields you want to change.
\nAuthorization: Imagine-key sk_your_secret_key_here
Origin: yourdomain.com
Content-Type: multipart/form-data
product_unicode — The unique product identifier returned as unicode in the Create Product responseReturns updated product information:
\n{\n \"status\": true,\n \"data\": {\n \"unicode\": \"XXX\",\n \"gtin\": \"9877664537\",\n \"name\": \"Astronaut v2\",\n \"main_asset_name\": \"astronaut_v2\",\n \"sku_id\": \"SKU-002\",\n \"created_at\": \"2026-02-06T19:11:08.125900+05:30\",\n \"upload_status\": \"2\"\n },\n \"message\": \"Product updated successfully\",\n \"api_hits_available\": 994\n}\n\nEndpoint: GET /v1/product/details/
Authentication: Secret Key or Public Key
Unified endpoint for retrieving product information:
\nGet Single Product: Provide a specific identifier (unicode, gtin, sku_id, or salsify_id) to retrieve one product
\nList All Products: Omit all filters to get all products
\nFilter Products: Use optional query parameters to search and filter
\nAuthorization: Imagine-key sk_your_secret_key_here
Authorization: Imagine-key pk_your_public_key_here
Origin: yourdomain.com
\n\nFilters can be combined. Omit all filters to return every product.
\n
{\n \"next_link\": null,\n \"previous_link\": null,\n \"current_page_number\": 1,\n \"count\": 1,\n \"total_pages\": 1,\n \"results\": [\n {\n \"unicode\": \"XXX\",\n \"gtin\": \"9877664537\",\n \"name\": \"Astronaut v2\",\n \"main_asset_name\": \"astronaut_v2\",\n \"sku_id\": \"SKU-002\",\n \"created_at\": \"2026-02-06T19:11:08.125900+05:30\"\n }\n ],\n \"api_hits_available\": 993\n}\n\nGet a single product by UUID:
\nGET /v1/product/details/?unicode=XXX\n\nList all products:
\nGET /v1/product/details/\n\nFilter by GTIN:
\nGET /v1/product/details/?gtin=3210987654321\n\nSearch products:
\nGET /v1/product/details/?search=astronaut\n\nEndpoint: DELETE /v1/product/details/XXX/
Authentication: Secret Key required
Soft-delete a product. The product is marked for deletion and will be removed after a grace period.
\nAuthorization: Imagine-key sk_your_secret_key_here
Origin: yourdomain.com
Success (200 OK):
\n{\n \"status\": true,\n \"data\": {\n \"unicode\": \"XXX\"\n },\n \"message\": \"Successfully marked for deletion. Will be deleted on 2026-02-06 19:42:20.164263\",\n \"api_hits_available\": 990\n}\n\nThis section provides everything you need to upload, manage, and organize your 3D products on the Imagine.io platform via the API.
\n\n\nNote: The S3 upload URLs for the 3D model and thumbnail are returned in the Create Product response as `presigned_url_prop_user_file.url` and `presigned_url_thumbnail.url`. Use these URLs directly as the request endpoint for the PUT (S3) requests — do not use your API base URL.
\n
You can upload industry-standard 3D model files with a product thumbnail, and manage product metadata such as name, SKU, and GTIN. Once a product is uploaded and finalized, it becomes available for content generation and image rendering workflows.
\nCreate a new product record and receive secure presigned upload URLs for your 3D model and thumbnail
\nUpload your 3D model and thumbnail image directly to cloud storage using the presigned URLs
\nFinalize the upload by confirming both files were uploaded successfully
\nUpdate product metadata (name, SKU, GTIN, asset name) at any time
\nRetrieve a single product by UUID, SKU, or GTIN — or list all products with search and filtering
\nDelete products via soft-delete with a grace period for recovery
\nProduct Unicode (unicode): A unique UUID assigned to every product on creation. This value is returned in the API response and used as the primary identifier for all subsequent API calls.
Presigned Upload URLs: Secure, time-limited URLs returned by the Create Product API. Use these to upload files directly to S3.
\nUpload Status: Tracks whether the product's files have been uploaded (1 = awaiting uploads, 2 = upload complete).
\n\nTip: Steps 1–4 must be completed in order for new products. Steps 5–7 can be used independently at any time.
\n
For authentication, shared headers, variables, scopes, polling guidance, and pagination, refer to the Setup & Usage Guide.
\n","_postman_id":"540dfc37-ef83-457d-a1fa-2883802e15a6"},{"name":"Generate Content & Renders","item":[{"name":"Create Product Content Job","event":[{"listen":"test","script":{"exec":["const res = pm.response.json();","pm.test(\"status=true\", function () {"," pm.expect(res.status).to.eql(true);","});","pm.test(\"HTTP 200/202\", () => pm.expect(pm.response.code).to.be.oneOf([200,202]));","if (res.data && res.data.product_unicode) {"," pm.collectionVariables.set(\"product_unicode\", res.data.product_unicode);","}"],"type":"text/javascript","packages":{},"requests":{},"id":"50bdae61-0543-4978-a49c-f5bbc81eb07a"}}],"id":"6fcbdfec-895e-47a1-9ef7-69e13ef35c05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Imagine-key sk_your_secret_key_here","type":"default"},{"key":"Origin","value":"yourdomain.com","type":"default"},{"key":"Content-Type","value":"application/json","type":"default"}],"body":{"mode":"raw","raw":"{\n \"product\": \"XXX\",\n \"job_detail_list\": [\n {\n \"req_type\": \"3d_model_viewer\"\n },\n {\n \"req_type\": \"ar\"\n },\n {\n \"req_type\": \"360_degree_spin\"\n },\n {\n \"req_type\": \"Product Image\",\n \"image_type\": \"silo\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.imagine.io/v1/product/job/","description":"Endpoint: POST /v1/product/job/
Authentication: Secret Key required
Submit a content generation job for a product. Specify which content types to generate.
\nProduct must be created via Create Product
\n3D model and thumbnail must be uploaded to S3
\nMark Upload Success must have been called
\nAuthorization: Imagine-key sk_your_secret_key_here
Origin: yourdomain.com
Content-Type: application/json
{\n \"status\": true,\n \"data\": {\n \"unicode\": \"XXX\"\n },\n \"message\": \"Product automated processing has been scheduled.\",\n \"api_hits_available\": 995\n}\n\nCall Get Product Content Status to monitor processing
\nRetrieve generated content using the Get Shared Content API when processing is complete
\nEndpoint: GET /v1/product/status/
Authentication: Secret Key or Public Key
Check the generation status for a product's content. Use this to monitor progress of content generation jobs and determine when assets are ready.
\nAuthorization: Imagine-key sk_your_secret_key_here or Imagine-key pk_your_public_key_here
Origin: yourdomain.com
\n\nNote: Provide at least one of
\nunicode,gtin,sku_id, orsalsify_id. If multiple are provided, lookup precedence is:unicode→gtin→sku_id→salsify_id.
content_type Values\n\nOmit
\ncontent_typeto get status for all content types.
Status values differ by content type:
\n{\n \"unicode\": \"XXX\",\n \"gtin\": \"9877664537\",\n \"name\": \"Astronaut v2\",\n \"main_asset_name\": \"astronaut_v2\",\n \"sku_id\": \"SKU-002\",\n \"created_at\": \"2026-02-06T19:11:08.125900+05:30\",\n \"product_ar_status\": \"Done\",\n \"product_3d_status\": \"Done\",\n \"product_silo_images_status\": [\n {\n \"id\": 117075,\n \"name\": \"Astronaut v2 - Silo Black Matte Floor - Silo Cam\",\n \"status\": \"Done\"\n }\n ],\n \"product_threesixty_status\": [\n {\n \"id\": 5445,\n \"status\": \"Done\"\n }\n ],\n \"api_hits_available\": 986\n}\n\nDone or FailedOnce status shows Done for desired content:
Call Get Shared Content to retrieve production-ready URLs
\nIntegrate the generated assets into your application
\nproduct_ar_status (status of AR),product_3d_status (status of 3D Model Viewer),product_silo_images_status (status of Silo Images),product_threesixty_status (status of 360 Degree Spin)
\n","type":"text/plain"},"key":"content_type","value":""}],"variable":[]}},"response":[{"id":"18e6d79b-9c97-453c-a6c8-92be88cc1808","name":"✅ 200 - OK (example)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Imagine-key pk_your_public_key_here","type":"default"},{"key":"Origin","value":"yourdomain.com","type":"default"}],"url":{"raw":"https://api.imagine.io/v1/product/status/?unicode=XXX&content_type=","host":["https://api.imagine.io"],"path":["v1","product","status",""],"query":[{"key":"unicode","value":"XXX"},{"key":"gtin","value":"","disabled":true},{"key":"sku_id","value":"","disabled":true},{"key":"name","value":"","disabled":true},{"key":"main_asset_name","value":"","disabled":true},{"key":"content_type","value":"","description":"product_ar_status (status of AR),product_3d_status (status of 3D Model Viewer),product_silo_images_status (status of Silo Images),product_threesixty_status (status of 360 Degree Spin)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"unicode\": \"ddd233ee-c968-43bc-9e51-4758d946223a\",\n \"gtin\": \"3210987654321\",\n \"name\": \"Astronaut Space Suit Model V1\",\n \"main_asset_name\": \"astronaut_suit\",\n \"sku_id\": \"SKU-ASTRONAUT-00001\",\n \"created_at\": \"2026-02-16T16:39:49.974021+05:30\",\n \"product_ar_status\": \"Done\",\n \"product_3d_status\": \"Done\",\n \"product_silo_images_status\": [\n {\n \"id\": 29594794,\n \"name\": \"Astronaut Space Suit Model V1 - Silo Leaf - Silo Cam\",\n \"status\": \"Done\"\n },\n {\n \"id\": 29594800,\n \"name\": \"Astronaut Space Suit Model V1 - Black bg - Camera1\",\n \"status\": \"Done\"\n },\n {\n \"id\": 29594795,\n \"name\": \"Astronaut Space Suit Model V1 - Silo Coffee Gradient - Silo Cam\",\n \"status\": \"Done\"\n },\n {\n \"id\": 29594799,\n \"name\": \"Astronaut Space Suit Model V1 - Silo Leaf - Silo Cam\",\n \"status\": \"Done\"\n },\n {\n \"id\": 29594797,\n \"name\": \"Astronaut Space Suit Model V1 - Dynamic Lighting Silo Scene - CAMERA 1\",\n \"status\": \"Done\"\n }\n ],\n \"product_threesixty_status\": [\n {\n \"id\": 5025,\n \"status\": \"Done\"\n }\n ],\n \"api_hits_available\": 982\n}"}],"_postman_id":"dc6f9a7c-93ba-4b77-b445-29ca75f48483"},{"name":"Get Shared Content","event":[{"listen":"test","script":{"exec":["pm.test(\"HTTP 200 OK\", () => pm.expect(pm.response.code).to.eql(200));"],"type":"text/javascript","packages":{},"requests":{},"id":"7e65f2ad-f64c-414e-b946-e0bbb39a97fb"}}],"id":"be73a7dc-157b-497b-85f7-595e5e228c50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Imagine-key pk_your_public_key_here","type":"default"},{"key":"Origin","value":"yourdomain.com","type":"default"}],"url":"https://api.imagine.io/v1/product/shared-content/?unicode=XXX","description":"Endpoint: GET /v1/product/shared-content/
Authentication: Secret Key or Public Key
Retrieve production-ready content URLs and assets for a product. This endpoint returns all successfully generated content that's ready to be integrated into your application.
\nAuthorization: Imagine-key sk_your_secret_key_here or Imagine-key pk_your_public_key_here
Origin: yourdomain.com
\n\nNote: Provide at least one of
\nunicode,gtin,sku_id, orsalsify_id. If multiple are provided, lookup precedence is:unicode→gtin→sku_id→salsify_id.
\n\nTip: Omit
\ncontent_typeto get all available content for the product in a single request.
The product_silo_images field has special behavior:
Empty array ([]): Returned when no silo images have been requested or none have completed rendering yet.
Array with objects: Only completed silo images are included. Each object contains:
\nid — Unique image identifier
name — Descriptive name of the render setup
image_url — Presigned CDN URL to the full-resolution image
thumbnail_url — Presigned CDN URL to the thumbnail image
\n\nKey behavior: Silo images are appended to the list only when their rendering is complete. Images still processing, failed, or disabled are not included.
\n
thumbnail_url, image_url): Image and thumbnail URLs are presigned and expire after 7 days. You can refresh them at any time by calling the Get Shared Content API again. Each refresh call deducts one API credit (api_hits_available), and the newly returned URLs are valid for another 7 days from the time of that call.product_ar_status (status of AR),product_3d_status (status of 3D Model Viewer),product_silo_images_status (status of Silo Images),product_threesixty_status (status of 360 Degree Spin)
\n","type":"text/plain"},"key":"content_type","value":null}],"variable":[]}},"response":[{"id":"da26f027-b439-4cdd-9666-4e0037129312","name":"✅ 200 - OK (example)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Imagine-key pk_your_public_key_here","type":"default"},{"key":"Origin","value":"yourdomain.com","type":"default"}],"url":{"raw":"https://api.imagine.io/v1/product/shared-content/?unicode=XXX","host":["https://api.imagine.io"],"path":["v1","product","shared-content",""],"query":[{"key":"unicode","value":"XXX"},{"key":"gtin","value":"12214235346","disabled":true},{"key":"sku_id","value":"","disabled":true},{"key":"name","value":"","disabled":true},{"key":"main_asset_name","value":"","disabled":true},{"key":"content_type","value":null,"description":"product_ar_status (status of AR),product_3d_status (status of 3D Model Viewer),product_silo_images_status (status of Silo Images),product_threesixty_status (status of 360 Degree Spin)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"unicode\": \"ddd233ee-c968-43bc-9e51-4758d946223a\",\n \"gtin\": \"3210987654321\",\n \"sku_id\": \"SKU-ASTRONAUT-00001\",\n \"salsify_id\": null,\n \"name\": \"Astronaut Space Suit Model V1\",\n \"main_asset_name\": \"astronaut_suit\",\n \"thumbnail_url\": \"https://media.imagine.io/media/private/product/thumbnail/73891/0/thumbnail_THUMBNAIL_73891.jpg?Expires=1771505849&Signature=hg4OVj8uSdQZGKHWI-PERu3UOf9UhuzeEswwQMYvhvwZQGkgVaAI2Us-JVoUSIHowkvSxFbC-61hkapPbSxcenhD4sxuMTvQ6djF6clEdOyDm44~1RAy058BVHAoCiGjB3exYFVIr77RnUvTmpqZheZI~UERHHjYYj9RVYJTjTvZ7QQfV8n4C94VCCuVwA3Rdew83eMKFE7voBjvygK79DT8baePkLO6ADnTTHiTZ9HnSQd5IOBPxpFRN8ayXj3v0VskKgGg3aa4rQ8KNaXsM87T6SX1AXCgRj7fILkEOuZdOuERNCad7EFuQQzlymcfbhqU40mO9Pjf1qCFrz24kQ__&Key-Pair-Id=K3MIEF79PIHRTH\",\n \"product_3d\": \"https://app.imagine.io/product/public/3d-viewer/v2/4000f841-b269-5ec4-a787-35cc790a31b8\",\n \"product_ar\": \"https://app.imagine.io/product/public/ar-viewer/v2/4000f841-b269-5ec4-a787-35cc790a31b8\",\n \"product_threesixty\": \"https://app.imagine.io/product/public/360-viewer/v2/4000f841-b269-5ec4-a787-35cc790a31b8\",\n \"product_silo_images\": [\n {\n \"id\": 29594794,\n \"name\": \"Astronaut Space Suit Model V1 - Silo Leaf - Silo Cam\",\n \"image_url\": \"https://media.imagine.io/media/private/renders_images/18118/23537/2250550/Astronaut%20Space%20Suit%20Model%20V1%20-%20Silo%20Leaf_678976a6_Astronaut%20Space%20Suit%20Model%20V1%20-%20Silo%20Leaf_Silo%20Cam.jpg?Expires=1771505849&Signature=4Ubznz-EsIHRzATJa6Xc7b7kqMnhL3~3l35eMMssuxo93zpkJUHyBXusopQlhys43ikyW9LD5O9g5Tu3hoEeuY8gcwYW1Yrka9Kngt6PrtE9Ahn9Esx9wQvO46vPGTgUAKCDlgko8ahjvn6aJtypTMDcJ2N7OkQEl8Q7NZHUggYyg8N6PDZ8UpZO9YNPbDdeNuXJyf3IxnUdEwA9zYjB9mDQwQyiLagLWm9wFdW3UZYAKL5wCELy2fNY-wCaxlFODNRVFbGSigur6jGK5XeIuycn69jgykSrehrUDDx62ko3CG-cIZuq65KqQp-3OEmKX5uO3yUR4NfBPI1v9OiuSQ__&Key-Pair-Id=K3MIEF79PIHRTH\",\n \"thumbnail_url\": \"https://media.imagine.io/media/private/renders_images/thumbnail/18118/23537/2250550/Astronaut%20Space%20Suit%20Model%20V1%20-%20Silo%20Leaf_f34de713_Astronaut%20Space%20Suit%20Model%20V1%20-%20Silo%20Leaf_Silo%20Cam.jpg?Expires=1771505849&Signature=aLbGzi3IDJegq4T8sc2mvEiykTrmeLFTlx5JAZ3byPxV14NrZfMQfwYRfE8LOPyIWS4T638xc1fSrHin-KRxom0rAeIMlCd~sjs2qKRIneYNrjtGlIMvUY2nAT2I69ZI9F-5bM3YeM1UGduZ6LuMvIAZ0Av~5CwQ4zQeLVg5z3bGXvIXwBtc-72sbUo-8Gn4SNVdg43NJTKqdFtPZ0hLuaBrSkC-o0Socl6mY7A2cum5yu5YiwESE7KZKydYSN1w0IQq98KEzEVyNq~1S8dtLoxMjIZHOghyfvwNZYqLpBzKXZciPfRlFjKhkgmn4kZ-6WLo53K9kewN22DzbujaGA__&Key-Pair-Id=K3MIEF79PIHRTH\"\n },\n {\n \"id\": 29594795,\n \"name\": \"Astronaut Space Suit Model V1 - Silo Coffee Gradient - Silo Cam\",\n \"image_url\": \"https://media.imagine.io/media/private/renders_images/18118/23537/2250552/Astronaut%20Space%20Suit%20Model%20V1%20-%20Silo%20Coffee%20Gradient_a5af1ab2_Astronaut%20Space%20Suit%20Model%20V1%20-%20Silo%20Coffee%20Gradient_Silo%20Ca.jpg?Expires=1771505849&Signature=gPxTWprA5Qb620-uXkKL87LMh1NApWefR0YORb4-NAs5VMhiUjEvu0igF4uRLJuOL0wA2xlEWRHy1O98mEeP3vVZO5WgOUflt6iQ356c3UXI3rciJlcMykJgoMzrnTj9wYvezJaDWpIA4eJSaFwOjfEQFEh6YVMgVsCzBwiJkw-6E6XfSc4fgLQQySvvgXP4vEI01qL6Yeqx9hG844x0pDCKTXdVymREWq6SUsS1VEPwslBOYBFEOQoQ~gggL7AtzGNZBBzlFTMNM5vh4jCrL2KcXvvovfLwEaJ2LEHXzPSf5KFCPdAEm5b6hC1atPNd8E~hSX36XR4hsFodFEW8yA__&Key-Pair-Id=K3MIEF79PIHRTH\",\n \"thumbnail_url\": \"https://media.imagine.io/media/private/renders_images/thumbnail/18118/23537/2250552/Astronaut%20Space%20Suit%20Model%20V1%20-%20Silo%20Coffee%20Gradient_02b2b2d1_Astronaut%20Space%20Suit%20Model%20V1%20-%20Silo%20Coffee%20Gradient_Silo%20Ca.jpg?Expires=1771505849&Signature=PkBTftrxZM81XZp7XWDpdp9XzayiKZZd1o8KtRoE2da7NCzmKELo23lNgsBN-xVwrcx8ojiVSCRREe1QjXwLY6FqRB0KdabSuG-2XUjPvyKcQBMMdR5JgLodFI3b0kW9-MMFxqvYrivnfjsM09Fw3rWTMfzF-ixhSchgVXKutm4jpuTuHIkdnaoZe2NtIUwo33Mr-qGydDcuKjCnwLSDuAmRqjg1lvQ2Uuk3CLoEbJifr4my6Q2BJ05B7afJBABXoGGdg7MqPt5GTEqsFMKbcRj9l41HqMHRrTldl48mHcHQom3TCJP2u07R4ZjfjSavnaOCEIBiG6Wtpx6YOvUnVQ__&Key-Pair-Id=K3MIEF79PIHRTH\"\n },\n {\n \"id\": 29594797,\n \"name\": \"Astronaut Space Suit Model V1 - Dynamic Lighting Silo Scene - CAMERA 1\",\n \"image_url\": \"https://media.imagine.io/media/private/renders_images/18118/23537/2250554/Astronaut%20Space%20Suit%20Model%20V1%20-%20Dynamic%20Lighting%20Silo%20Scene_b7b10a6d_Astronaut%20Space%20Suit%20Model%20V1%20-%20Dynamic%20Lighting%20Silo%20Scene_.jpg?Expires=1771505849&Signature=Ug96o~ls52b0sWK0ynzAK08I3GBh7PxhdLDa9gGa7JbSHvzbnRWZd1ErntI6VXTRMHlBKnqmHhN9okUKg2~ANSVF63zFYsrsnN2-Tia0e9iD3SwFByKegpZ1Q4eMcUH6o2DaCkkVhmNQaD9mUEhfkVLRnsEkOzNSF~K6tSk64bNzrPX7O9dAj8x0XkhcpDWWYAgpHY299~g85~8AFHVzdFPEJzGvt-gg7mJzvAufeKNHjNr9OvW7SwvwktNL3ZS1ZIdN05eH~XOP3U-L35YC8gJ-~n0lRPOWocNx8NMDoR-Dzp~Qi~BK-ckp5ynhyH4ZaM0D-wqWQXMaRtNX4l~tsg__&Key-Pair-Id=K3MIEF79PIHRTH\",\n \"thumbnail_url\": \"https://media.imagine.io/media/private/renders_images/thumbnail/18118/23537/2250554/Astronaut%20Space%20Suit%20Model%20V1%20-%20Dynamic%20Lighting%20Silo%20Scene_8f342892_Astronaut%20Space%20Suit%20Model%20V1%20-%20Dynamic%20Lighting%20Silo%20Scene_.jpg?Expires=1771505849&Signature=qQMB6wNXuCfUm4a-nmGOEfOxjuaNUAmuVsKfmXqQqm6KCY9bHBDEyCgD41OWWTf6qf0HnELYOuFUGrpIHRo85GAtxEWINeQsapfWoov-6474l1bpl3khgQmqLoeVab2Nmg7eo6msD9Ow0QNGfQ8g32TazgRJhAnwxyODmxkQh1JK5IkuwUzPMQB1YA9FJExqpVveVc0v2bGkuaDpBMAX3a5c1dVlcwgsMYjJb-AAkFsveq0m1m2RKLWcn7hR~2OLohy2O~Kq-rpG-EDVxRD770DI3sqTQ5hNx6DHia-JZv8VHV1NmAz0Vm-gPB2tS6L6CGv-~q5DcGqpiOEadT3FMQ__&Key-Pair-Id=K3MIEF79PIHRTH\"\n },\n {\n \"id\": 29594799,\n \"name\": \"Astronaut Space Suit Model V1 - Silo Leaf - Silo Cam\",\n \"image_url\": \"https://media.imagine.io/media/private/renders_images/18118/23537/2250555/Astronaut%20Space%20Suit%20Model%20V1%20-%20Silo%20Leaf_ec60d0e3_Astronaut%20Space%20Suit%20Model%20V1%20-%20Silo%20Leaf_Silo%20Cam.jpg?Expires=1771505849&Signature=fvOWQ8d2-RaF1usERThdp-kW3C5nuTPRMP7wrYAVFIq1a23s1owJ~Dce9VuR937Y2NMKOvyb-q4c55clb6XKDV8ga1A8JHaqmC55lh20d1DenFCHedPAmKhRb6dsmQReVlCfRQbCrti0Z5SpE0PNTQo-nqV3QocPTkIpWVSzVUci8xjDpoJJMmRVACp9GTUP6RJso~j-rfoXpcF1kTWWHdO2KG8YortQFo-y3Lhx2GGo9X5S2d76w1-ds-A4xK1-n0L-3r1NgnSgmOT2Cp0PAbciDW1w9j5VEOb-nDtSUVObTQWgKnMvSN7LSiJzL-cyDg2XIke-bvkonoLoeFiHDQ__&Key-Pair-Id=K3MIEF79PIHRTH\",\n \"thumbnail_url\": \"https://media.imagine.io/media/private/renders_images/thumbnail/18118/23537/2250555/Astronaut%20Space%20Suit%20Model%20V1%20-%20Silo%20Leaf_83fb14ad_Astronaut%20Space%20Suit%20Model%20V1%20-%20Silo%20Leaf_Silo%20Cam.jpg?Expires=1771505849&Signature=cAhIaou~lHkQF3mics7AbqKKwxQqcJD4wmaCPF5qJvh-se3P6AsFe-TzS7MGwxvC~KNPFFRrp53ccKVP-mgWBSrQspEduRi1EwlCZ1qClgz-aiCCgKJADCPwNs2~ysC3EYJ83jzncBGP2uVQ~WT3r9N7oKPmTCL3NoSelA6FlZkmz0Hk4f1-O4kB-iHTzAX4Aowlnz9oULTl2tbJktQN54F-6uf7ZEcQlXUVRVziXqDKB0ZvKflhAOnqbTNGt1qnHDrG2zulc4hXEcUkGVsneKofKvHyG3Em5gvT7ZNVk4ns8mcO8Cw2cH44uQOemPz~Jql9a20gQsVg1QOhJGVRJQ__&Key-Pair-Id=K3MIEF79PIHRTH\"\n },\n {\n \"id\": 29594800,\n \"name\": \"Astronaut Space Suit Model V1 - Black bg - Camera1\",\n \"image_url\": \"https://media.imagine.io/media/private/renders_images/18118/23537/2250556/Astronaut%20Space%20Suit%20Model%20V1%20-%20Black%20bg_2ede55ac_Astronaut%20Space%20Suit%20Model%20V1%20-%20Black%20bg_Camera1.jpg?Expires=1771505849&Signature=hsCKIg0TXe4fPvCH9bY04K8iyRbbhKeck3lJAcyXqq2Rxlxv3YhBebTqAOBmWxymyUVFru1oni8l0-kbSUzQZAavkrEr2dobLQMr8JVRWP-H6eOI0~0-uoHBPicHwAwBZDScA4cb2gKRTYSNRBnn3Uy6vpphnts3EhtK2AI3NXwWROlDtgHlN68gOgj4oul~jnKoDP6Gj2-x5Pauif80bUpHDedRXyBV6VB6s8lNX5CRE5vZO2rIv9DyyCaxyehkRE~KSEgZSDQBOL00GVLmuSI4CwwocnnTU~JFi3Y0qEMvip3Bp6tA3sRKna-aE~193pWRZ0XHehXMm~5xRQvtqQ__&Key-Pair-Id=K3MIEF79PIHRTH\",\n \"thumbnail_url\": \"https://media.imagine.io/media/private/renders_images/thumbnail/18118/23537/2250556/Astronaut%20Space%20Suit%20Model%20V1%20-%20Black%20bg_dc5d5d87_Astronaut%20Space%20Suit%20Model%20V1%20-%20Black%20bg_Camera1.jpg?Expires=1771505849&Signature=b9CTuXtJ1kahfb7Tunc9TNqdcerZ9LZDyTm5tiSLCtZeg4S9~6i~GJaYJL-diOB8L~Gl7NFIKN2xAAxlBNKLSUyj9VHoAebPaMuMaI8IdbHH831GxBtL6ilx9XovBuv41VMAULvGCUqRv-bIZzP6ldwbe2HjnucIC~0I3T0XWGl0wsLbXQLPGKMYO7UPS42brY8Eczuyvkg0xGA7~2r-6M-qhFRwsy9lnh3xtUqCJKxQK9~nc8qPIQxUnC~yDPLBNpVIfd9c5H1tPEriMBmkEa2YDYf8JSZmpzvvAIn85XpZIxaCjs98uiCOPYwSA5k-c9eYQ5U7jqS~mAnIyayyeQ__&Key-Pair-Id=K3MIEF79PIHRTH\"\n }\n ],\n \"api_hits_available\": 983\n}"}],"_postman_id":"be73a7dc-157b-497b-85f7-595e5e228c50"},{"name":"Archive Product Render Content","event":[{"listen":"test","script":{"exec":["pm.test(\"HTTP 200 OK\", () => pm.expect(pm.response.code).to.eql(200));"],"type":"text/javascript","packages":{},"requests":{},"id":"833ea5b8-cccd-4821-bf3c-a4dceb2c32b3"}}],"id":"e7b5c1ee-cf55-4e4e-88e8-426934efcdfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Authorization","value":"Imagine-key sk_your_secret_key_here","type":"default"},{"key":"Origin","value":"yourdomain.com","type":"default"},{"key":"Content-Type","value":"application/json","type":"default"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n 117076\n ],\n \"is_archive\": true,\n \"unicode\": \"XXX\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.imagine.io/v1/product/render-content/archive/","description":"Endpoint: PATCH /v1/product/render-content/archive/
Authentication: Secret Key required (sk_)
Archive (soft-hide) or unarchive specific product render images. Archived content is hidden from listings but not deleted, allowing you to restore it later.
\nAuthorization: Imagine-key sk_your_secret_key_here
Origin: yourdomain.com
Content-Type: application/json
{\n \"ids\": [117076],\n \"is_archive\": true,\n \"unicode\": \"XXX\"\n}\n\n{\n \"status\": true,\n \"data\": {\n \"updated_count\": 1,\n \"ids\": [117076]\n },\n \"message\": \"Product render content archive status updated successfully\",\n \"api_hits_available\": 956\n}\n\nThis section covers how to generate production-ready visual content from your uploaded 3D products and manage the resulting assets.
\nOnce a product has been uploaded and finalized (see Product Upload & Management), you can submit a content generation job to automatically produce multiple output types from your 3D model—all through a single API call.
\n3D Model Viewer — An interactive, browser-based viewer that lets customers rotate, zoom, and inspect your product in 3D. Returns a public URL you can embed directly in your site.
\nAugmented Reality (AR) — AR-ready assets for both Android and iOS, letting customers visualize your product in their environment via their phone camera.
\n360 Degree Spin — An interactive 360° turntable view that provides a complete rotational view of your product from all angles.
\nSilo Images — High-resolution product images rendered on white, transparent, or styled backgrounds. Ideal for eCommerce product pages, catalogs, and marketing assets.
\nSubmit a content job specifying which output types you need (you can request all types at once)
\nThe platform processes your 3D model asynchronously — this typically takes a few minutes
\nPoll the status endpoint to check when each content type is ready
\nRetrieve all generated assets as production-ready URLs
\nOptionally archive or restore specific rendered images
\nAsynchronous Processing: Content generation is not instant. After submitting a job, poll the status API to check progress. Wait at least 3-5 minutes before the first check.
\nImage URLs: Image and thumbnail URLs are presigned and expire after 7 days. You can refresh them at any time by calling the Get Shared Content API again. Each refresh deducts one API credit, and the new URLs are valid for another 7 days.
\nArchive / Unarchive: You can soft-hide specific rendered images without deleting them, and restore them later.
\nFor authentication, shared headers, variables, scopes, polling guidance, and pagination, refer to the Setup & Usage Guide.
\n","_postman_id":"5f5b0264-7bf0-4525-a70a-27559b97d70e"},{"name":"Image Rendering","item":[{"name":"Create Images","event":[{"listen":"test","script":{"exec":["const res = pm.response.json();","pm.test(\"status=true\", function () {"," pm.expect(res.status).to.eql(true);","});","pm.test(\"HTTP 200/202\", () => pm.expect(pm.response.code).to.be.oneOf([200,202]));","if (res.data && res.data.render_id) {"," pm.collectionVariables.set(\"render_id\", res.data.render_id);","}"],"type":"text/javascript","packages":{},"requests":{},"id":"d52d4fa7-df82-49a1-becc-eef85c4c618c"}}],"id":"df5e18c4-b505-44bd-852d-c74e643a28b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Imagine-key sk_your_secret_key_here","type":"default"},{"key":"Origin","value":"yourdomain.com","type":"default"},{"key":"Content-Type","value":"application/json","type":"default"}],"body":{"mode":"raw","raw":"{\n \"scene_id\": 7550,\n \"cameras_to_render\": [\n 8152584,\n 8152586\n ],\n \"units\": \"inches\",\n \"products\": [\n {\n \"sku_id\": \"ASTRONAUT-1\",\n \"position\": [\n 0,\n 0,\n 0\n ],\n \"rotation\": [\n 0,\n 0,\n 0\n ],\n \"material_id\": 500\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.imagine.io/v1/product/create-images/","description":"Create an image render job using a scene / template and product configuration.
\nThis API creates a render job using:
\na template / scene ID
\nmultiple camera angles
\nmultiple products
\nper-product configuration such as:
\nposition
rotation
material_id
Returns a render_id and the list of sku_ids after the render job is accepted.
{\n \"status\": true,\n \"data\": {\n \"render_id\": 2281539,\n \"sku_ids\": [\n \"ASTRONAUT-1\"\n ]\n },\n \"message\": \"Render job has been created and processing has been scheduled.\",\n \"api_hits_available\": 995\n}\n\nUse the returned render_id in Get Images to fetch generated image results, or pass a sku_id (?sku_ids=SKU-001) to retrieve rendered images directly by product.
Public key for fetching silo image results.
\n","type":"text"},{"key":"Origin","value":"yourdomain.com","description":"Origin of the calling application.
\n","type":"text"}],"url":"https://api.imagine.io/v1/product/render-images/?render_id=XXX","description":"Fetch rendered images for a given render_id, with optional filtering using product_id, sku_id, or product_name.
The response can include:
\nfinal image file
\nfilmic file
\ncolor pass file
\nthumbnail
\nfilmic thumbnail
\nrender status (Disabled, Not Done, Processing, Done, Failed)
angle name
\nCreate a render image job and capture the returned render_id
Call this API with that render_id
Use the returned image URLs once rendering is complete
\nEach result typically represents one rendered camera angle
\nIf an image is not yet available, the corresponding field is returned as null
Once rendering is complete, the API returns image URLs
\nImage URLs are pre-signed and expire after 7 days; call the API again to refresh them after expiry. Each refresh deducts one API credit, and the new URLs are valid for another 7 days.
\nThis API can also support fetching results using:
\nproduct_id
\nsku_id
\nproduct_name
\nFetch by product ID:
\nGET /v1/product/render-images/?product_id=73891\n\nFetch by SKU ID:
\nGET /v1/product/render-images/?sku_id=SKU-ASTRONAUT-00001\n\nFetch by product name (case-insensitive partial match):
\nGET /v1/product/render-images/?product_name=astronaut\n\nThis endpoint returns paginated results. See the Pagination section in the Setup & Usage Guide for full details on pagination fields (next_link, total_pages, count, etc.).
Render job identifier returned by the create job API.
\n","type":"text/plain"},"key":"render_id","value":"XXX"}],"variable":[]}},"response":[{"id":"768e0e68-8ff3-4997-9baa-4a50b049ef3b","name":"200 OK - Images Returned","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Imagine-key pk_your_public_key_here","type":"text"},{"key":"Origin","value":"yourdomain.com","type":"text"}],"url":{"raw":"https://api.imagine.io/v1/product/render-images/?render_id=XXX","host":["https://api.imagine.io"],"path":["v1","product","render-images",""],"query":[{"key":"render_id","value":"XXX"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"next_link\": null,\n \"previous_link\": null,\n \"last_page_link\": \"https://api.imagine.io/v1/product/render-images/?render_id=XXX&page=1\",\n \"first_page_link\": \"https://api.imagine.io/v1/product/render-images/?render_id=XXX&page=1\",\n \"current_page_link\": \"https://api.imagine.io/v1/product/render-images/?render_id=XXX&page=1\",\n \"current_page_number\": 1,\n \"count\": 2,\n \"total_pages\": 1,\n \"results\": [\n {\n \"id\": 8372439,\n \"angle_name\": \"silo camera 1\",\n \"file\": \"https://media.imagine.io/media/private/renders_images/XXX/render-image-1.jpg?Expires=XXX&Signature=XXX&Key-Pair-Id=XXX\",\n \"filmic_file\": \"https://media.imagine.io/media/private/renders_images/filmic_images/XXX/render-image-1.jpg?Expires=XXX&Signature=XXX&Key-Pair-Id=XXX\",\n \"color_pass_file\": \"https://media.imagine.io/media/private/renders_images/color_pass/XXX/render-image-1.jpg?Expires=XXX&Signature=XXX&Key-Pair-Id=XXX\",\n \"thumbnail\": \"https://media.imagine.io/media/private/renders_images/thumbnail/XXX/render-image-1.jpg?Expires=XXX&Signature=XXX&Key-Pair-Id=XXX\",\n \"filmic_thumbnail\": \"https://media.imagine.io/media/private/renders_images/filmic_thumbnail/XXX/render-image-1.jpg?Expires=XXX&Signature=XXX&Key-Pair-Id=XXX\",\n \"status\": \"Done\"\n },\n {\n \"id\": 8372438,\n \"angle_name\": \"silo camera 2\",\n \"file\": \"https://media.imagine.io/media/private/renders_images/XXX/render-image-2.jpg?Expires=XXX&Signature=XXX&Key-Pair-Id=XXX\",\n \"filmic_file\": \"https://media.imagine.io/media/private/renders_images/filmic_images/XXX/render-image-2.jpg?Expires=XXX&Signature=XXX&Key-Pair-Id=XXX\",\n \"color_pass_file\": \"https://media.imagine.io/media/private/renders_images/color_pass/XXX/render-image-2.jpg?Expires=XXX&Signature=XXX&Key-Pair-Id=XXX\",\n \"thumbnail\": \"https://media.imagine.io/media/private/renders_images/thumbnail/XXX/render-image-2.jpg?Expires=XXX&Signature=XXX&Key-Pair-Id=XXX\",\n \"filmic_thumbnail\": \"https://media.imagine.io/media/private/renders_images/filmic_thumbnail/XXX/render-image-2.jpg?Expires=XXX&Signature=XXX&Key-Pair-Id=XXX\",\n \"status\": \"Done\"\n }\n ],\n \"api_hits_available\": 988\n}"},{"id":"7d965d58-9bd9-47bf-b5b4-8535e730c2b6","name":"200 OK - Images Not Done","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Imagine-key pk_your_public_key_here","type":"text"},{"key":"Origin","value":"yourdomain.com","type":"text"}],"url":{"raw":"https://api.imagine.io/v1/product/render-images/?render_id=XXX","host":["https://api.imagine.io"],"path":["v1","product","render-images",""],"query":[{"key":"render_id","value":"XXX"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"next_link\": null,\n \"previous_link\": null,\n \"last_page_link\": \"http://staging-api.imagine.io/v1/product/render-images/?render_id=823150&page=1\",\n \"first_page_link\": \"http://staging-api.imagine.io/v1/product/render-images/?render_id=823150&page=1\",\n \"current_page_link\": \"http://staging-api.imagine.io/v1/product/render-images/?render_id=823150&page=1\",\n \"current_page_number\": 1,\n \"count\": 2,\n \"total_pages\": 1,\n \"results\": [\n {\n \"id\": 2032529,\n \"angle_name\": \"cam 2\",\n \"file\": null,\n \"filmic_file\": null,\n \"color_pass_file\": null,\n \"thumbnail\": null,\n \"filmic_thumbnail\": null,\n \"status\": \"Not Done\"\n },\n {\n \"id\": 2032530,\n \"angle_name\": \"cam 1\",\n \"file\": null,\n \"filmic_file\": null,\n \"color_pass_file\": null,\n \"thumbnail\": null,\n \"filmic_thumbnail\": null,\n \"status\": \"Not Done\"\n }\n ],\n \"api_hits_available\": 955\n}"}],"_postman_id":"c0a75589-736c-4cdd-acbe-748a6ff0ee45"}],"id":"f477edc9-153e-426b-b4ac-4eee1d28799d","description":"Place your products into professionally designed scenes (also called templates) to generate photorealistic rendered images — with full control over camera angles, product positioning, rotation, and material options. This workflow enables you to produce lifestyle imagery, marketing visuals, and catalog-ready product shots at scale, entirely through the API.
\nThese APIs allow you to:
\nTrigger render jobs based on a template / scene
\nConfigure multiple camera angles
\nPlace multiple products with position, rotation, and style customization
\nRetrieve generated images using a render_id, product_id, sku_id, or product_name
Create Render Job from Template
\nSend the template / scene data, selected camera angles, and product configuration
\nReturns a render_id
Get rendered Images by Render ID
\nUse the render_id returned from the “Create Render Job from Template”
Returns the rendered images and their data
\nEach rendered camera angle returns:
\nStandard image — The final rendered output
\nFilmic image — A version with filmic tone mapping applied
\nColor pass — A flat-color reference pass (when available)
\nThumbnails — Smaller preview versions of each output
\nRender status — Track whether each image is Not Done, Processing, Done, or Failed
For authentication, shared headers, variables, scopes, polling guidance, and pagination, refer to the Setup & Usage Guide.
\n","_postman_id":"f477edc9-153e-426b-b4ac-4eee1d28799d"},{"name":"Zapier Integration","item":[{"name":"Zapier Prerequisites","item":[],"id":"c15c00e0-580a-4b3b-85b5-bb090f0a3c04","description":"To use the API, you must generate an API token.
\nProcedure:
\n1. Log in to your application account. (APP)
\n2. Access the \"Settings\" menu.
\n3. Proceed to the \"API\" tab.
\n4. Click the \"Generate Token\" button.
\n5. Include this token in the Authorization header of your API requests, using the format \"Zapier XXXX\".
\nSecurity Notice:
\n* Treat your API token as a password.
* Do not share your token with unauthorized individuals.
* Store the token securely.
* If you suspect your token has been compromised, regenerate it immediately.EndFragment
Unlock the full potential of Imagine.io by seamlessly connecting it with thousands of applications via Zapier. Automate your visual content creation and distribution, eliminating manual tasks and ensuring consistent, efficient workflows.
\nSeamless Data Transfer: Effortlessly move generated assets and associated data between Imagine.io and your favorite tools.
\nCentralized Storage: Automatically store assets in cloud storage services like Google Drive.
\nDigital Asset Management (DAM): Connect with DAM systems like Canto for organized asset libraries.
\nIncreased Productivity: Eliminate repetitive tasks and focus on creative work.
\nConsistent Asset Distribution: Ensure assets are delivered to the right places, at the right time.
\nLeverage Zapier's powerful automation to create \"Zaps\" that connect Imagine.io with a vast ecosystem of applications. Examples include:
\nAction: Imagine.io generates an image, which is then automatically uploaded to Google Drive.
\nAction: A generated asset is added to a Canto library with relevant metadata.
\nVisit the Imagine.io Zapier Integration Page: https://zapier.com/apps/imagineio/integrations
\nExplore Available Triggers and Actions: Discover the various ways you can connect Imagine.io with other applications.
\nCreate Your Zaps: Use Zapier's intuitive interface to build custom automation workflows.
\nConnect Your Accounts: Authenticate your Imagine.io and other application accounts within Zapier.
\nTest and Deploy: Ensure your Zaps are working correctly and activate them to automate your workflows.
\nE-commerce: Automatically generate product images based on new product listings in your online store.
\nMarketing: Create social media visuals based on campaign data from your CRM.
\nDesign Teams: Streamline asset delivery to clients by automatically uploading generated visuals to shared folders.
\nContent Creation: Automate the creation of visual content for blog posts and articles.
\nWhile direct API documentation for Imagine.io may vary, the Zapier integration acts as a bridge, utilizing Imagine.io's underlying API capabilities. Through Zapier, you can:
\nAccess Imagine.io's asset generation features.
\nPass data to and from Imagine.io.
\nTrigger actions within Imagine.io based on external events.
\nFor specific API details or advanced integrations beyond Zapier's capabilities, please contact Imagine.io support.
\n