Products

Embed products into a scene

Changed on

Try out this capability in Bria's sandbox

Description

Integrate and embed one or more products into a predefined scene at precise user-defined coordinates. This endpoint ensures the product matches the scene's lighting, perspective, and aesthetics.

Note on Product Cutout & Scaling: Please use Product Cutput endpoint first, to create a presice cutout of your product. Crucially, the provided coordinates (x, y, width, height) are applied to the resulting tight cutout of the product, not the original source image. To avoid stretching or distortion, developers should ensure the requested width/height matches the aspect ratio of the actual product object rather than the original canvas.

post/image/edit/product/integrate

Request

  • Base URL: https://engine.prod.bria-api.com/v2
  • URL: https://engine.prod.bria-api.com/v2/image/edit/product/integrate
  • Auth: API key in header api_token

Request body

scenestring required

Publicly available URL or Base64-encoded image of the scene where the product will be embedded. Accepted formats are jpeg, jpg, png, webp.

seedinteger

Seed for deterministic generation. Uses a random seed if omitted.

visual_input_content_moderationboolean

If true, returns 422 on visual input moderation failure for scene or product.

visual_output_content_moderationboolean

If true, returns 422 on visual output moderation failure.

Response

Successful operation. Returns the generated image.

Changes

    • warning

      deleted the header request parameter api_token

    • info

      api tag Products added

    • info

      api tag Product Endpoints removed

    • info

      added the non-success response with the status

    • info

      added the success response with the status