Media generation

Generate website images

Generates up to eight images in one batch. Items run concurrently, may use same-website image references, and successful outputs become ordinary website assets. An item with background: "transparent" stores each output as a native transparent PNG without a separate opaque copy.

post/mediaGeneration

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/mediaGeneration
  • Auth: HTTP bearer

Request body

websiteIdstring required
idempotencyKeystring

Send the same key when retrying one request so it never generates or bills twice. Omit for a new request.

Response

The completed image-generation result.

version1 required
kind'image_generation' required
websiteIdstring required
status'ready' | 'partial' | 'failed' required
creditsChargednumber required

Changes

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