Open Inventory / Docs
EndpunkteAiResourcesIdCover

Generate a square studio or transparent cover from an item image

Die API läuft auf deiner Anwendungsinstanz. Schemas und Feldnamen stammen unverändert aus der OpenAPI-Spezifikation. Browsergebundene Aufrufe benötigen eine Sitzung auf der Instanz.

POST
/resources/{id}/cover

Authentifizierung

bearerAuth
headerAuthentifizierungBearer <inv_ token>

Pfadparameter

id*string
Formatuuid

Header-Parameter

Idempotency-Key?string

UUID identifying one queue operation; safe to reuse for retries.

Formatuuid
X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Anfrageinhalt

application/json
  1. body
sourceMediaId?string

Image to use as the visual reference. Defaults to the first non-AI image, then falls back to the first image.

Formatuuid
prompt?string

Optional replacement for the built-in studio or transparent-cover prompt. Omit it to use the matching server default.

Längelength <= 5000
modelId?string

An ID returned by GET /ai/image-models. Omit it to use the deployment default.

Längelength <= 240
maximumImageSize?integer

Maximum 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.

Standard1024
Mögliche Werte102420484096
transparentBackground?boolean

When true, store a transparent PNG instead of an opaque JPEG.

Standardfalse
transparencyMethod?string

Greenscreen uses one generated chroma-key pass. Difference matting uses aligned white and black passes for higher-quality alpha, including translucent details and soft shadows.

Standard"difference-matting"
Mögliche Werte"greenscreen""difference-matting"

Antwortinhalt

Cover generated or completed response replayed

Beispielanfrage
curl -X POST 'https://inventory.example.com/api/v1/resources/497f6eca-6276-4993-bfeb-53cbbbba6f08/cover' \  -H 'Content-Type: application/json' \  -d '{}'
Beispielantwort
Leer