Skip to main content
POST

Authorizations

x-api-key
string
header
required

API key with sm_ prefix. Get your key at https://sudomock.com/dashboard/api-keys

Body

application/json

The PSD to ingest and what to call it.

psd_file_url
string
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.

Minimum string length: 1
Example:

"https://example.com/heavyweight-tee.psd"

psd_name
string | null

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

Maximum string length: 255
Example:

"Heavyweight tee front"

is_async
boolean
default:false

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.

Response

200 - application/json

Successful Response

The ingested mockup with every layer you can address in a render. specification

data
UploadResponseData · object
required

Response data

success
boolean
default:true

Success status

message
string
default:""

Optional message about the operation

warnings
UploadWarning · object[] | null

Non-fatal advisories about this upload (e.g. hidden smart object layers that are not exposed for personalization). Omitted when none.