canonical: https://jentic.com/apis/dynamicmockups.com/dynamicmockups

# Dynamic Mockups API

Jentic publishes the only available OpenAPI specification for the Dynamic Mockups API, keeping it validated and agent-ready. Dynamic Mockups exposes a single render endpoint that applies design assets to smart objects inside pre-built mockup templates and returns a rendered image URL. It is intended for print-on-demand catalogues, e-commerce product previews, and design-tool integrations that need many product images generated programmatically from one design.

## For AI agents

Generate a mockup render by mapping design assets onto smart objects in a chosen mockup template, returning an image URL ready for product listings or marketing assets.

## Scope

Does not edit mockup templates, manage smart-object definitions, or host design assets - use for rendering finished mockup images from existing templates only.

## Capabilities

- Render a mockup by sending a mockup UUID and asset URLs for each smart object
- Apply multiple design assets in a single request to multi-object mockup templates
- Receive a hosted image URL pointing at the rendered output for immediate use
- Pass through design transformations (placement, scaling) defined on the smart object
- Authenticate via x-api-key header for use in server-side automation

## Use cases

### Print-on-Demand Product Catalogue Generation

When a designer uploads new artwork, an automation pipeline calls the Dynamic Mockups render endpoint for each product template (t-shirt, mug, hoodie) so the storefront has finished mockup images by the time the SKU is published. Rendering happens server-side from a UUID + asset URL, so the pipeline scales without running Photoshop.

Example prompt: POST to /renders with mockup_uuid for the t-shirt template and the new design PNG URL for the front smart object, then store the returned image URL on the SKU

### Marketing Asset Generation for Campaigns

A campaign tool ingests a fresh design and produces banner-ready mockups across phone case, sticker, and poster templates in a single batch. Because each render takes a single API call and returns a hosted image URL, the tool can issue a fan-out of requests in parallel and assemble the campaign without manual export work.

Example prompt: Issue parallel POSTs to /renders with the same design URL but different mockup UUIDs (phone-case, sticker, poster) and collect the rendered image URLs

### Live Design-Tool Preview

A web-based design tool calls the render endpoint each time the user updates their artwork to show a live mockup preview on the configured product. The single endpoint design keeps the integration thin, and the smart-object mapping ensures the preview matches the print-ready output exactly.

Example prompt: On each design save, POST to /renders with the latest design asset URL and the active mockup UUID, then update the preview pane with the returned image

### Agent-Driven Mockup Creation via Jentic

An AI agent helping a seller list a new product takes the seller's design file, calls Dynamic Mockups through Jentic to generate a hosted mockup image, and attaches the URL to the new product in the storefront. The agent searches Jentic for 'create a product mockup', loads the render schema, and executes the call without handling the API key directly.

Example prompt: Use Jentic to search 'create a mockup render', load the render operation, and execute it with mockup_uuid and the design PNG URL

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/renders` | Create a mockup render from a template UUID and design assets |

## Key resources

- **Renders** — Single endpoint that accepts a mockup UUID plus a smart-object-to-asset mapping and returns a hosted image URL for the rendered mockup

## Why Jentic

- **Setup:** Wiring the Dynamic Mockups API by hand means handling its x-api-key auth and building the render request with its smart-object-to-asset mapping yourself. Through Jentic you install once, import Dynamic Mockups from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Dynamic Mockups takes the template and asset mapping in the request body, so you limit the agent to the operations it needs. Since this API exposes a single render operation, generating a mockup is the only thing the agent can call.
- **Credential handling:** Your Dynamic Mockups API key is stored once, encrypted, by your own Jentic One instance and injected into the x-api-key header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a mockup render', and Jentic returns the render operation with its input schema, including the smart-object-to-asset mapping shape, so the agent calls the right endpoint without browsing the docs.

## Related APIs

- **DynaPictures API** — Template-based image generation focused on personalised banners and social images rather than product mockups
- **DynTube API** — Pair video-product mockups: render a still mockup with Dynamic Mockups and host the explainer video with DynTube
- **E-goi Marketing API** — Push generated mockup images into email campaigns via E-goi after rendering

## FAQ

### Why is there no official OpenAPI spec for the Dynamic Mockups API?

Dynamic Mockups does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call the Dynamic Mockups API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Dynamic Mockups API use?

The API uses an API key passed in the x-api-key header. Through Jentic, the key is stored encrypted in the vault and injected at execution time, so the agent calls /renders with a scoped Jentic token instead of holding the raw Dynamic Mockups key.

### Can I render multiple products from a single Dynamic Mockups API call?

Each POST to /renders produces one mockup render against one mockup_uuid, but the request body accepts multiple smart-object-to-asset mappings so a multi-object template (e.g. front and back of a t-shirt) is rendered in one call. For different products, issue parallel calls with different mockup UUIDs.

### What are the rate limits for the Dynamic Mockups API?

The OpenAPI spec does not declare a numeric rate limit. Plan-based limits apply on the Dynamic Mockups account level - if you need high throughput for catalogue generation, batch parallel calls per minute and back off on 429 responses.

### How do I generate a mockup through Jentic?

Run pip install jentic, search for 'create a mockup render', load the operation for POST /renders, then execute it with the mockup_uuid for the template and the design asset URL keyed by smart-object name. The response includes a hosted image URL ready to attach to a product listing.

### Where do I find the mockup UUIDs to use in the render call?

Mockup UUIDs are created and managed in the Dynamic Mockups web app rather than via this API - this OpenAPI spec only covers the render step. Once a template is configured in the dashboard, copy its UUID and the smart-object names into the /renders request body.

### Can I limit what my agent is allowed to do with the Dynamic Mockups API?

Yes. Because you run Jentic One yourself, your own rules decide which Dynamic Mockups operations and credentials the agent may use. This API exposes a single render operation (POST /renders), so the only thing the agent can call is generating a mockup from a template UUID and its smart-object-to-asset mapping. The API key is held by your instance and injected at execution time, so the agent renders mockups without ever seeing the raw key.