↑↓ Navigate enter Open esc Close
Dashboard
MODEL ID ideogram:4@5
live

Ideogram 3.0 Replace Background

Ideogram
by Ideogram

Ideogram 3.0 Replace Background removes and swaps image backgrounds while preserving key foreground subjects. Ideal for product mockups, marketing assets, and design overlays where consistent scenes and fast iteration matter for teams and creators.

Ideogram 3.0 Replace Background

API Options

Platform-level options for task execution and delivery.

taskType

string required value: imageInference

Identifier for the type of task being performed

taskUUID

string required UUID v4

UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.

outputType

string default: URL

Image output type.

Allowed values 3 values

outputFormat

string default: JPG

Specifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities.

  • `JPG`: Best for photorealistic images with smaller file sizes (no transparency).
  • `PNG`: Lossless compression, supports high quality and transparency (alpha channel).
  • `WEBP`: Modern format providing superior compression and transparency support.
**Transparency**: If you are using features like background removal or LayerDiffuse that require transparency, you must select a format that supports an alpha channel (e.g., `PNG`, `WEBP`, `TIFF`). `JPG` does not support transparency.
Allowed values 3 values

outputQuality

integer min: 20 max: 99 default: 95

Compression quality of the output. Higher values preserve quality but increase file size.

webhookURL

string URI

Specifies a webhook URL where JSON responses will be sent via HTTP POST when generation tasks complete. For batch requests with multiple results, each completed item triggers a separate webhook call as it becomes available.

Learn more 1 resource

deliveryMethod

string default: sync

Determines how the API delivers task results.

Allowed values 2 values
Returns complete results directly in the API response.
Returns an immediate acknowledgment with the task UUID. Poll for results using getResponse.
Learn more 1 resource

uploadEndpoint

string URI

Specifies a URL where the generated content will be automatically uploaded using the HTTP PUT method. The raw binary data of the media file is sent directly as the request body. For secure uploads to cloud storage, use presigned URLs that include temporary authentication credentials.

Common use cases:

  • Cloud storage: Upload directly to S3 buckets, Google Cloud Storage, or Azure Blob Storage using presigned URLs.
  • CDN integration: Upload to content delivery networks for immediate distribution. 
// S3 presigned URL for secure upload
https://your-bucket.s3.amazonaws.com/generated/content.mp4?X-Amz-Signature=abc123&X-Amz-Expires=3600

// Google Cloud Storage presigned URL
https://storage.googleapis.com/your-bucket/content.jpg?X-Goog-Signature=xyz789

// Custom storage endpoint
https://storage.example.com/uploads/generated-image.jpg

The content data will be sent as the request body to the specified URL when generation is complete.

safety

object

Content safety checking configuration for image generation.

Properties 2 properties
safety » checkContent

checkContent

boolean default: false

Enable or disable content safety checking. When enabled, defaults to fast mode.

safety » mode

mode

string default: none

Safety checking mode for image generation.

Allowed values 2 values
Disables checking.
Performs a single check.

ttl

integer min: 60

Time-to-live (TTL) in seconds for generated content. Only applies when outputType is URL.

includeCost

boolean default: false

Include task cost in the response.

numberResults

integer min: 1 max: 20 default: 1

Number of results to generate. Each result uses a different seed, producing variations of the same parameters.

Inputs

Input resources for the task (images, audio, etc). These must be nested inside the inputs object.
inputs » seedImage

seedImage

string required

Image used as a starting point for the generation (UUID, URL, Data URI, or Base64).

Learn more 3 resources

Generation Parameters

Core parameters for controlling the generated content.

model

string required value: ideogram:4@5

Identifier of the model to use for generation.

Learn more 3 resources

positivePrompt

string required min: 1 max: 2000

Text prompt describing elements to include in the generated output.

Learn more 2 resources

Provider Settings

Parameters specific to this model provider. These must be nested inside the providerSettings.ideogram object.
providerSettings » ideogram » magicPrompt

magicPrompt

string default: AUTO

Automatic prompt enhancement.

Allowed values 3 values
Content-based enhancement.
Always enhance.
No enhancement.
providerSettings » ideogram » renderingSpeed

renderingSpeed

string default: DEFAULT

Generation speed/quality tradeoff.

Allowed values 3 values
Fastest generation.
Balanced speed and quality.
Best quality.
providerSettings » ideogram » styleCode

styleCode

string min: 8 max: 8

Predefined style code (8-char hex).

providerSettings » ideogram » stylePreset

stylePreset

string

Artistic style preset.

Allowed values 62 values
providerSettings » ideogram » styleReferenceImages

styleReferenceImages

array of strings min items: 1max items: 4

Reference images for visual style transfer. The model extracts and applies the artistic style from these images.

providerSettings » ideogram » styleType

styleType

string default: AUTO

Visual style and rendering approach.

Allowed values 7 values
Automatically selects the most appropriate style.
Versatile style suitable for most content types.
Photorealistic rendering with natural lighting and textures.
Optimized for graphic design, logos, and typography.
Three-dimensional rendering with depth and modeling effects.
Anime/manga visual style.
Stylized rendering for fictional and fantasy content.
Ask AI
Send feedback