Embroidery Effect API

Create Embroidery Effect

post

Processes an image to generate an embroidery effect. Requires either an image URL or base64-encoded image data.

Authorizations

x-api-keystringRequired

API key required for authentication.

Header parameters

Acceptstring · enumRequired

The request must accept JSON responses.

Possible values:

x-api-keystringRequired

API key required for authentication.

Example: YOUR_API_KEY_HERE

Body

image_urlstring · uriOptional

URL of the image to process. Either image_url or image_data_b64 must be provided.

Example: https://example.com/my-design.png

image_data_b64stringOptional

Base64-encoded image data. Either image_url or image_data_b64 must be provided.

Example: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==

Responses

200

Embroidery effect successfully generated.

application/json

successbooleanOptional

Indicates if the API call was successful.

Example: true

messagestringOptional

A message about the API response.

400

Bad request due to invalid input parameters. Either image_url or image_data_b64 must be provided.

401

Unauthorized request, invalid or missing API key.

403

Insufficient credits for this action.

application/json

500

Failed to process embroidery request.

application/json

post/tools/embroidery

POST /api/v1/tools/embroidery HTTP/1.1
Host: app.dynamicmockups.com
x-api-key: YOUR_API_KEY_HERE
Accept: application/json
Content-Type: application/json
Content-Length: 165

{
  "image_url": "https://example.com/my-design.png",
  "image_data_b64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
}

{
  "data": {
    "export_path": "https://app-dynamicmockups-psd-engine-production.s3.eu-central-1.amazonaws.com/embroidery/example.png"
  },
  "success": true,
  "message": ""
}

Overview

The Embroidery Tool transforms any image into a realistic embroidery or stitched effect. It's ideal to transform an existing artwork image into embroidery and render it on the selected mockup template.

The embroidery versions of designs are often needed for print-on-demand products.

Provide artwork from a public URL or Base64

Provide your image via image_url using a public URL, or image_data_b64 using a base64-encoded string. Only one input method is required per request. Supported formats include PNG, JPG, and WEBP.

Output

The API returns an export_path containing a URL to the generated embroidery image. This output URL is temporary and should be downloaded or saved into permanent storage.

You can use the returned embroidery image in your mockup renders or save it to your asset library for later use.

Credit cost

This endpoint consumes 6 credits per successful request. Credits are only deducted after successful processing.

Tips for best results

For best results, use high-contrast images with clean edges. Simpler designs with fewer colors produce more realistic embroidery effects.

Try it out in the API Playground

Visit our API Playground link to try the Embroidery effect in real time.

Embroidery Effect - Dynamic Mockups API Playgroundplayground.dynamicmockups.com