Sign in
edit-workflow

Edit a product image using an instruction and ordered references

Edits the base image while preserving details the instruction does not change. Image 1 is the base; reference images are numbered from image 2 in the supplied order. Resolve image mentions to these numbers before submitting. Descriptions identify the selected view or reference.

Poll GET /v1/generations/{generation_id} with the returned generation_id until the workflow completes or fails.

post/v2/tool/skechers-style-editor

Request body

resolved_instructionstring required

Edit instructions with known image mentions resolved to image numbers.

base_descriptionstring

Optional description of the selected base image or named view.

reference_descriptionsstring[]

One nonempty description per reference image, in the same order.

aspect_ratiostring

Output ratio. When omitted, derive the nearest supported ratio from the base.

base_generation_size'1k' | '2k' | '4k'

Output resolution tier; corresponds to the app's low, medium, and high settings.

quality'low' | 'medium' | 'high'

The quality tier for the edit. Higher tiers may improve detail and take longer to complete.

num_images1 | 2 | 4

Number of edited images to create.

privateboolean

When true or omitted, the output is kept private to your account. Set to false to publish the output to the public feed. Enterprise accounts always generate privately.

webhook_urlstring uri

HTTPS URL that Ideogram delivers the generated result to. Ideogram sends a JSON POST to this URL once all images for the request have finished generating. The body mirrors the synchronous generate response: request_id, created, and a data array containing every generated image (url, prompt, resolution, seed, is_image_safe). Each delivery is signed with Ed25519 and verifiable against the public keys at https://api.ideogram.ai/v1/.well-known/jwks.json. Must be HTTPS; private and loopback hosts and the cloud metadata service are rejected.

Example request

{
  "base_description": "base_description",
  "aspect_ratio": 61,
  "private": true,
  "reference_asset_identifiers": [
    {
      "asset_type": "RESPONSE",
      "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
    },
    {
      "asset_type": "RESPONSE",
      "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
    },
    {
      "asset_type": "RESPONSE",
      "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
    },
    {
      "asset_type": "RESPONSE",
      "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
    },
    {
      "asset_type": "RESPONSE",
      "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
    }
  ],
  "webhook_url": "https://api.example.com/webhooks/ideogram",
  "base_generation_size": "2k",
  "base_asset_identifier": "",
  "reference_descriptions": [
    "reference_descriptions",
    "reference_descriptions",
    "reference_descriptions",
    "reference_descriptions",
    "reference_descriptions"
  ],
  "resolved_instruction": "resolved_instruction",
  "num_images": 0,
  "quality": null
}

Response

Style edit accepted for asynchronous processing.

generation_idstring required

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

Example response

{
  "generation_id": "generation_id"
}

Changes

Changed in 3 of the 33 revisions of this API.36

  • c891acf371ed1See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 4e95197be44a34See the full diff
    • ▲

      removed the enum value 1K of the request property

      request-property-enum-value-removed

    • ▲

      removed the enum value 2K of the request property

      request-property-enum-value-removed

    • ▲

      removed the enum value 4K of the request property

      request-property-enum-value-removed

    • ○

      the request property default value changed from 2K to 2k

      request-property-default-value-changed

    • ○

      added the new 1k enum value to the request property

      request-property-enum-value-added

    • ○

      added the new 2k enum value to the request property

      request-property-enum-value-added

    • ○

      added the new 4k enum value to the request property

      request-property-enum-value-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a235a15c02351See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog