---
title: "Transfer a shoe upper onto a preserved sole"
method: POST
path: "/v2/tool/sole-swap"
tags: ["edit-workflow"]
---

# Transfer a shoe upper onto a preserved sole

`POST /v2/tool/sole-swap`

Uses the sole-donor shoe as the output canvas, preserving its sole, camera,
background, and lighting while transferring the upper from ordered references.

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

## Request body

- SoleSwapRequest
  - `base_asset_identifier` AssetIdentifier, required — An identifier for an ideogram asset.
    - `asset_type` 'ASSET' | 'CANVAS_ASSET' | 'LAYERED_ASSET' | 'RESPONSE' | 'UPLOAD', required
    - `asset_id` string, required
  - `upper_asset_identifiers` AssetIdentifier[], required — Ordered upper-donor references. Put the primary upper view first, then additional angles of the same upper to transfer.
    - `asset_type` 'ASSET' | 'CANVAS_ASSET' | 'LAYERED_ASSET' | 'RESPONSE' | 'UPLOAD', required
    - `asset_id` string, required
  - `instruction` string — Optional additional direction for the sole swap.
  - `aspect_ratio` string — Output aspect ratio. When omitted, the closest supported ratio is derived from the sole-donor base image.
  - `base_generation_size` '1k' | '2k' | '4k' — Output resolution tier. Defaults to 2k.
  - `quality` 'low' | 'medium' | 'high' — The quality tier for the edit. Higher tiers may improve detail and take longer to complete.
  - `seed` integer — Random seed. Set for reproducible generation.
  - `num_images` 1 | 2 | 4 — Number of sole-swap images to create.
  - `private` boolean — 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_url` string, 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.

## Response `200`

Sole swap accepted for asynchronous processing.

- SoleSwapResponse — Acknowledgement that the workflow was accepted.
  - `generation_id` string, required — URL-safe base64 ID accepted by the generation polling endpoint.

## Other responses

- `400` — Invalid input provided.
- `401` — Unauthorized.
- `402` — Insufficient credits or quota.
- `403` — This account or mini app is not authorized to use Sole Swap.
- `404` — An input asset was not found or is not readable.
- `422` — The instruction did not pass prompt safety checks.
- `429` — Too many requests.

## Changes

- **2026-09-27** `987f73fc82de` — 4 info
  - added the optional property `max_inflight_requests` to the response with the `402` status
  - added the optional property `max_inflight_requests` to the response with the `429` status
  - added the optional property `task_completion_speed` to the response with the `402` status
  - added the optional property `task_completion_speed` to the response with the `429` status
- **2026-09-19** `4e95197be44a` — 6 breaking, 7 info
  - removed the enum value `1K` of the request property `base_generation_size`
  - removed the enum value `2K` of the request property `base_generation_size`
  - removed the enum value `4K` of the request property `base_generation_size`
  - removed the enum value `HIGH` of the request property `quality`
  - …9 more
- **2026-09-16** `a235a15c0235` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/ideogram/apis/ideogram-openapi-3-0/changes/v2/tool/sole-swap/post.md)

---

[API](https://skmtc.dev/ideogram/apis/ideogram-openapi-3-0.md) · [All operations](https://skmtc.dev/ideogram/apis/ideogram-openapi-3-0/llms.txt) · [OpenAPI document](https://skmtc.dev/ideogram/apis/ideogram-openapi-3-0/revisions/987f73fc82de?raw)