Images

Start a product-mockup generation (async)

Places one or more product images into a generated scene.

ASYNCHRONOUS, and NOT through the normal job endpoint: it returns a job_id that is polled with GET /v1/images/mockup-status, not with GET /v1/jobs/{id}. Give the product image as a library file uuid (file_uuid), or INLINE as base64 (images, or the single-image imageData + mimeType pair).

post/v1/images/mockup

Request

  • Base URL: https://contentmaschine.ai/api
  • URL: https://contentmaschine.ai/api/v1/images/mockup
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://contentmaschine.ai/api/oauth/authorize, token URL https://contentmaschine.ai/api/oauth/token)

Request body

promptstring required

What the mockup scene should show.

file_uuidstring uuid

Uuid of a library image to place in the scene. Use this or the inline images / imageData.

imageDatastring

Single-image alternative to images: a base64 payload. Requires mimeType.

mimeTypestring

Mime type of imageData.

variabilityinteger

How many variations to produce. Defaults to 1.

modelVariantstring

Model variant. Defaults to standard.

modelOptionsobject

Per-model options; see GET /v1/models.

Response

Queued. Poll GET /v1/images/mockup-status with the returned job_id.

successboolean
dataobject
timestampstring date-time

Example response

{
  "success": true
}

Changes

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