Sign in
edit-workflow

Install a Swan S logo on a shoe

Installs the selected logo onto the ordered shoe views, preserving the shoe and chosen camera framing. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed.

post/v2/tool/swan-s-logo-install

Request body

logo_style'3d' | 'flat' required
aspect_ratiostring required
num_images1 | 2 | 4

Number of images to create.

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

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

privateboolean

When true or omitted, keep outputs private. 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

{
  "logo_style": "3d",
  "aspect_ratio": "aspect_ratio",
  "private": true,
  "webhook_url": "https://api.example.com/webhooks/ideogram",
  "logo_asset_identifier": {
    "asset_type": "RESPONSE",
    "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
  },
  "logo_specification_asset_identifier": {
    "asset_type": "RESPONSE",
    "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
  },
  "shoe_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"
    }
  ],
  "num_images": 0,
  "quality": null
}

Response

Accepted for asynchronous processing.

generation_idstring required

URL-safe base64 ID accepted by GET /v1/generations/{generation_id}.

Example response

{
  "generation_id": "generation_id"
}

Changes

Changed in 2 of the 33 revisions of this API.34

  • 4e95197be44a33See the full diff
    • ▲

      removed the enum value HIGH of the request property

      request-property-enum-value-removed

    • ▲

      removed the enum value LOW of the request property

      request-property-enum-value-removed

    • ▲

      removed the enum value MEDIUM of the request property

      request-property-enum-value-removed

    • ○

      added the new high enum value to the request property

      request-property-enum-value-added

    • ○

      added the new low enum value to the request property

      request-property-enum-value-added

    • ○

      added the new medium 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