Photo mockups

Render a photo mockup

Renders artwork onto a previously created photo mockup identified by the path mockup_id. Artwork can target a saved print area or a whole product surface, and a product offers both. The mockup must be in 'ready' status. Costs 5 credits. Returns CDN URL(s) of the rendered image.

post/api/v1/sudoai/2d-mockups/{mockup_id}/render

Request

  • Base URL: https://api.sudomock.com
  • URL: https://api.sudomock.com/api/v1/sudoai/2d-mockups/{mockup_id}/render
  • Auth: API key in header x-api-key

Path parameters

mockup_idstring required

Id of the photo mockup the artwork is rendered onto.

Request body

is_asyncboolean

If true, the render 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 rendered image URL on success. If false (default), the render runs synchronously and returns the result.

Example request

{
  "export_options": {
    "image_format": "webp",
    "image_size": 1920,
    "quality": 95
  },
  "print_areas": [
    {
      "adjustments": {
        "blend_mode": "multiply",
        "opacity": 90
      },
      "artwork_url": "https://example.com/design.png",
      "placement": {
        "fit": "fit",
        "position": "center"
      },
      "uuid": "223e4567-e89b-12d3-a456-426614174001"
    }
  ]
}

Response

Successful Response

successboolean

Success status

Example response

{
  "data": {
    "print_files": [
      {
        "duration_ms": 1840,
        "export_format": "webp",
        "export_path": "https://cdn.sudomock.com/mockup-assets/renders/2d/893ea326-278b-480b-b130-87dd6aee06dc/ac0a5f31-6d2e-4d1b-9c4c-1e7f2b6a5d08.webp"
      }
    ],
    "render_uuid": "ac0a5f31-6d2e-4d1b-9c4c-1e7f2b6a5d08"
  },
  "success": true
}

Changes

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