edit-workflow

Product Color Change

Changed on

Recolors the masked regions of the product photo, each to its own target color, while preserving the product's geometry, materials, prints, logos, and shading, and keeping every region outside the masks unchanged.

The request is processed asynchronously. Poll GET /v1/generations/{generation_id} with the returned generation_id until the generation is completed or failed.

Supply the product photo as raw image bytes via multipart/form-data.

Supply the masks marking the regions to recolor as raw masks bytes, paired by position with colors — up to 4 regions; a single-region edit is a one-item list. Every mask must have the same pixel dimensions as the product photo. White pixels mark the region to recolor; black pixels are preserved. Alpha-only masks are also supported: opaque pixels mark the region to recolor and transparent pixels are preserved.

post/v2/tool/colorways

Request

  • Base URL: https://api.ideogram.ai
  • URL: https://api.ideogram.ai/v2/tool/colorways
  • 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

Colorway accepted for asynchronous processing.

generation_idstring required

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

Changes

  • 52511913bd75Revision changes
    • breaking

      removed the enum value HIGH of the request property

    • breaking

      removed the enum value LOW of the request property

    • breaking

      removed the enum value MEDIUM of the request property

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added the new optional query request parameter dry_run

    • info

      added the new high enum value to the request property

    • info

      added the new low enum value to the request property

    • info

      added the new medium enum value to the request property

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • de120c38c7a2Revision changes
    • warning

      deleted the header request parameter Api-Key

    • info

      the endpoint scheme security ApiKeyAuth was added to the API