Generate a square studio or transparent cover from an item image
The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.
bearerAuthAuthorizationBearer <inv_ token>id*stringuuidIdempotency-Key?stringUUID identifying one queue operation; safe to reuse for retries.
uuidX-Organization-ID?stringOrganization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.
uuidapplication/json- body
sourceMediaId?stringImage to use as the visual reference. Defaults to the first non-AI image, then falls back to the first image.
uuidprompt?stringOptional replacement for the built-in studio or transparent-cover prompt. Omit it to use the matching server default.
length <= 5000modelId?stringAn ID returned by GET /ai/image-models. Omit it to use the deployment default.
length <= 240maximumImageSize?integerMaximum requested longest edge in pixels. Models use the largest supported standard square size at or below this value; transparent covers are capped at 2048 for safe processing.
1024102420484096transparentBackground?booleanWhen true, store a transparent PNG instead of an opaque JPEG.
falsetransparencyMethod?stringGreenscreen uses one generated chroma-key pass. Difference matting uses aligned white and black passes for higher-quality alpha, including translucent details and soft shadows.
"difference-matting""greenscreen""difference-matting"Cover generated or completed response replayed
curl -X POST 'https://inventory.example.com/api/v1/resources/497f6eca-6276-4993-bfeb-53cbbbba6f08/cover' \ -H 'Content-Type: application/json' \ -d '{}'