MockAnything AI API
API key required for authentication.
The request must accept JSON responses.
API key required for authentication.
YOUR_API_KEY_HEREText prompt used to AI-generate the mockup image. Required unless image_url or image_file is provided.
URL of an existing image to use as the mockup image. Required unless prompt or image_file is provided.
Whether to run prompt enhancement before generation. Only applies to the prompt flow.
AI model used for generation. Defaults to the standard model when omitted. Only applies to the prompt flow.
Optional mockup name shown in the dashboard and returned in the mockup.name field.
Optional UUID of the catalog the mockup belongs to. Defaults to the workspace's default catalog.
Template creation started.
trueTemplate creation startedBad request due to invalid input parameters (e.g. missing prompt/image_url/image_file, invalid model, unsupported image type).
Unauthorized request, invalid or missing API key.
No credits available, or the authenticated user does not have access to the provided catalog or collection.
The provided catalog_uuid or a collections[].uuid could not be found.
Failed to start AI generation or upload the provided image.
API key required for authentication.
The task_id returned from POST /mock-anything/create.
f6d7fb41-d32c-4fc3-8db9-37843d3476cfThe request must accept JSON responses.
API key required for authentication.
YOUR_API_KEY_HERETask status retrieved successfully. Response shape depends on task state.
Unauthorized request, invalid or missing API key.
Failed to retrieve task status from the rendering service.
API key required for authentication.
Search term matched against POD product names.
gildanThe request must accept JSON responses.
API key required for authentication.
YOUR_API_KEY_HEREPOD products matching the query.
trueBad request. query is missing or empty.
Unauthorized request, invalid or missing API key.
Failed to fetch POD products.
Overview
Workflow
Three ways to create a mockup
Polling for completion
Using your new mockup
Grounding the AI with a product
Catalogs and collections
Choosing a model
Rate Limit
Last updated