edit-workflow

Material Swap

Changed on

Re-renders masked regions of a product photo in the materials shown in reference images, preserving the product's construction and everything outside the masks. Upload the image, up to 4 masks, and the materials using multipart/form-data. Returns a generation_id; poll GET /v2/generations/{generation_id} or supply a webhook_url.

post/v2/tool/material-swap

Request

  • Base URL: https://api.ideogram.ai
  • URL: https://api.ideogram.ai/v2/tool/material-swap
  • Auth: API key in header Api-Key

Query parameters

dry_runboolean

When true, the request is validated and priced but not run: nothing is generated, stored, or billed, and no safety review is performed. The response is a PriceQuote object instead of the usual response for this endpoint. Send exactly the request you would send to generate, so the quote reflects the same options.

Response

Material swap accepted for asynchronous processing.

generation_idstring required

URL-safe base64 ID accepted by the generation polling endpoint.

Changes

  • 3ee00ffa31d6Revision changes
    • breaking

      removed the media type application/json from the request body

    • breaking

      the request property became required

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      api operation id post_material_swap removed and replaced with editWorkflow_post_material_swap

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      request body became optional

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

  • 919a744eb885Revision changes
    • info

      added the new optional request property // (media type: multipart/form-data)

    • info

      added the new optional request property // (media type: application/json)

    • info

      added the new optional request property // (media type: multipart/form-data)

    • info

      added the new optional request property // (media type: application/json)

    • info

      added the new optional request property // (media type: multipart/form-data)

    • info

      added the new optional request property // (media type: application/json)