Sign in
edit-workflow

Design one Swan S logo candidate

Creates one isolated logo candidate using either a shoe swatch or a supplied style reference. For 3D reference designs, choose split or full coverage with design_variant. Send a separate request for each candidate; each request completes and is billed independently. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed.

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

Request body

logo_style'3d' | 'flat' required
source_mode'shoe_swatch' | 'user_reference' required

Use a shoe color swatch or an uploaded logo reference as the style source.

design_variant'split_coverage' | 'full_coverage'

Required for 3D user_reference designs. Omit for other designs.

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

The quality tier for the image 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",
  "flat_silhouette_asset_identifier": {
    "asset_type": "RESPONSE",
    "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
  },
  "private": true,
  "webhook_url": "https://api.example.com/webhooks/ideogram",
  "source_mode": "shoe_swatch",
  "logo_specification_asset_identifier": {
    "asset_type": "RESPONSE",
    "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
  },
  "design_variant": "split_coverage",
  "style_source_asset_identifier": {
    "asset_type": "RESPONSE",
    "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
  },
  "geometry_hero_asset_identifier": {
    "asset_type": "RESPONSE",
    "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
  },
  "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