Skip to main content
Use POST /api/v1/images/ghost-mannequin to remove a visible mannequin from a product photo and return a hosted generated image URL.

Authentication

Send an OmniCommerce API key with the catalog:enrich scope:

Request

imageUrl must be a public HTTP(S) URL. Data URIs are rejected so image payloads are not embedded in API calls. productTitle, categoryName, and categoryId are optional context fields. When provided, they are passed to the image-edit prompt only to help preserve the correct garment or product type.

Generation Settings

The endpoint uses the same working generation settings as the product UI flow:
Each successful generation is recorded in the organization AI usage ledger as image_generation with feature ghost_mannequin_image_edit.

Response

The image value is the generated remote HTTP(S) URL stored by OmniCommerce.

Errors

  • 400 - invalid JSON, missing imageUrl, non-HTTP URL, or data URI input.
  • 401 - missing or invalid API key.
  • 403 - API key does not have catalog:enrich.
  • 502 - image generation failed or the generated result could not be downloaded.