Video mockups

Render a video mockup

Animates a mockup: produces a still render from the given smart objects, then animates it. Returns 202 with a job_id to poll (GET /api/v1/jobs/{job_id}).

post/api/v1/renders/video

Request

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

Request body

mockup_uuidstring nullable

RENDER MODE: UUID of the mockup to animate (from GET /api/v1/psd-mockups or POST /api/v1/psd/upload). Required in render mode; omit in raw-image mode.

image_urlstring nullable

RAW-IMAGE MODE: a public https png/jpg URL to animate directly (general image-to-video, no render). Supply this OR (mockup_uuid + smart_objects), never both.

webhookobject nullable

Completion events (video.succeeded, video.failed) are delivered to the webhook endpoints on your account that subscribe to them. GET /api/v1/jobs/{job_id} stays the source of truth.

Example request

{
  "mockup_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "smart_objects": [
    {
      "asset": {
        "fit": "fill",
        "url": "https://example.com/user-design.png"
      },
      "uuid": "223e4567-e89b-12d3-a456-426614174001"
    }
  ],
  "video": {
    "audio": false,
    "duration_seconds": 4,
    "motion": "ambient",
    "advanced_model": null
  }
}

Response

Successful Response

job_idstring required

Identifier of the accepted job, used to poll its status.

kind'video' required

The kind of work accepted, which is always a video.

status'queued' | 'dispatched' | 'running' | 'succeeded' | 'failed' | 'cancelled' required

State of the job when this response was returned.

status_urlstring required

Path to poll for this job's status.

modelstring required

The video model chosen for this clip.

outcome_tierstring required

The quality level this clip is produced at.

estimated_creditsinteger nullable

Credits this clip costs, which is null only when an accepted job's original quote is no longer known.

duration_secondsinteger required

Length of the clip in seconds.

audioboolean required

Whether the clip is produced with sound.

Example response

{
  "audio": false,
  "duration_seconds": 4,
  "estimated_credits": 38,
  "job_id": "5f1c0b2a-7d43-4e9a-8c16-0b5d3f7a2e94",
  "kind": "video",
  "model": "veo-3.1-fast",
  "outcome_tier": "standard",
  "status": "queued",
  "status_url": "/api/v1/jobs/5f1c0b2a-7d43-4e9a-8c16-0b5d3f7a2e94"
}

Changes

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