PSD mockups

Create a mockup from a PSD

Ingests a PSD file from URL, extracts layers and smart objects, generates thumbnails.

post/api/v1/psd/upload

Request

  • Base URL: https://api.sudomock.com
  • URL: https://api.sudomock.com/api/v1/psd/upload
  • Auth: API key in header x-api-key

Request body

psd_file_urlstring required

URL to the PSD file to upload. HTTP/HTTPS URLs only. Supports up to Adobe's official PSD file size limit, 300s download timeout.

psd_namestring nullable

Name for the mockup template (auto-generated if not provided)

is_asyncboolean

If true, the upload is QUEUED and the call returns 202 immediately with a job_id (poll GET /api/v1/jobs/{job_id}, or receive a webhook if one is configured); result_url carries the new mockup_uuid on success. If false (default), the upload runs synchronously and returns the mockup.

Example request

{
  "psd_file_url": "https://example.com/heavyweight-tee.psd",
  "psd_name": "Heavyweight tee front"
}

Response

Successful Response

successboolean

Success status

messagestring

Optional message about the operation

Example response

{
  "data": {
    "collections": [],
    "group_layers": [],
    "height": 5000,
    "name": "Heavyweight tee front",
    "smart_objects": [
      {
        "blend_mode": "multiply",
        "layer_name": "Front print",
        "name": "Front print",
        "position": {
          "height": 3413,
          "width": 3000,
          "x": 512,
          "y": 730
        },
        "print_area_presets": [
          {
            "name": "Default",
            "position": {
              "height": 3413,
              "width": 3000,
              "x": 0,
              "y": 0
            },
            "size": {
              "height": 3413,
              "width": 3000
            },
            "thumbnails": [],
            "uuid": "d07f5b18-2c94-4e83-a6b1-95f3c8e27a40"
          }
        ],
        "quad": [
          [
            512,
            742
          ],
          [
            3512,
            730
          ],
          [
            3499,
            4143
          ],
          [
            524,
            4131
          ]
        ],
        "size": {
          "height": 3413,
          "width": 3000
        },
        "uuid": "b41a7e52-93c8-4d61-8f07-2ae5c9d04713"
      }
    ],
    "text_layers": [],
    "thumbnail": "https://cdn.sudomock.com/mockup-assets/8f2c1d90-6b4e-4a37-9e55-0d1c7a3f21b8/thumbnails/thumb_720.webp",
    "thumbnails": [
      {
        "url": "https://cdn.sudomock.com/mockup-assets/8f2c1d90-6b4e-4a37-9e55-0d1c7a3f21b8/thumbnails/thumb_720.webp",
        "width": 720
      },
      {
        "url": "https://cdn.sudomock.com/mockup-assets/8f2c1d90-6b4e-4a37-9e55-0d1c7a3f21b8/thumbnails/thumb_480.webp",
        "width": 480
      },
      {
        "url": "https://cdn.sudomock.com/mockup-assets/8f2c1d90-6b4e-4a37-9e55-0d1c7a3f21b8/thumbnails/thumb_240.webp",
        "width": 240
      }
    ],
    "uuid": "8f2c1d90-6b4e-4a37-9e55-0d1c7a3f21b8",
    "width": 4000
  },
  "message": "",
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.