{ "opencollection": "1.0.0", "info": { "name": "API Reference subpackage_datasets subpackage_generate API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_generate", "type": "folder" }, "items": [ { "info": { "name": "Generate with Ideogram 3.0", "type": "http" }, "http": { "method": "POST", "url": "https://api.ideogram.ai/v1/ideogram-v3/generate", "headers": [ { "name": "Api-Key", "value": "" } ], "body": { "type": "multipart-form", "data": [ { "name": "prompt", "type": "text", "value": "" }, { "name": "seed", "type": "text", "value": "" }, { "name": "resolution", "type": "text", "value": "" }, { "name": "aspect_ratio", "type": "text", "value": "" }, { "name": "rendering_speed", "type": "text", "value": "" }, { "name": "magic_prompt", "type": "text", "value": "" }, { "name": "negative_prompt", "type": "text", "value": "" }, { "name": "num_images", "type": "text", "value": "" }, { "name": "color_palette", "type": "text", "value": "" }, { "name": "style_codes", "type": "text", "value": "" }, { "name": "style_type", "type": "text", "value": "" }, { "name": "style_preset", "type": "text", "value": "" }, { "name": "custom_model_uri", "type": "text", "value": "" }, { "name": "style_reference_images", "type": "text", "value": "" }, { "name": "character_reference_images", "type": "text", "value": "" }, { "name": "character_reference_images_mask", "type": "text", "value": "" } ] } }, "docs": "Generates images synchronously based on a given prompt and optional parameters using the Ideogram 3.0 model.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.\n" }, { "info": { "name": "Generate with Ideogram 3.0 (Transparent Background)", "type": "http" }, "http": { "method": "POST", "url": "https://api.ideogram.ai/v1/ideogram-v3/generate-transparent", "headers": [ { "name": "Api-Key", "value": "" } ], "body": { "type": "multipart-form", "data": [ { "name": "prompt", "type": "text", "value": "" }, { "name": "seed", "type": "text", "value": "" }, { "name": "upscale_factor", "type": "text", "value": "" }, { "name": "aspect_ratio", "type": "text", "value": "" }, { "name": "rendering_speed", "type": "text", "value": "" }, { "name": "magic_prompt", "type": "text", "value": "" }, { "name": "negative_prompt", "type": "text", "value": "" }, { "name": "num_images", "type": "text", "value": "" } ] } }, "docs": "Generates images with transparent background synchronously based on a given prompt and optional parameters using\nthe Ideogram 3.0 model. Images will be generated using maximum supported resolution at the specified aspect ratio\nto allow best results with upscaler. The selected resolution is written to the response, not the upscaled final\nresolution.\n\n`rendering_speed=FLASH` is not supported for transparent-background generation; the request will return a 400.\nUse `TURBO`, `DEFAULT`, or `QUALITY` " }, { "info": { "name": "Inpaint with Ideogram 3.0", "type": "http" }, "http": { "method": "POST", "url": "https://api.ideogram.ai/v1/ideogram-v3/inpaint", "headers": [ { "name": "Api-Key", "value": "" } ], "body": { "type": "multipart-form", "data": [ { "name": "image", "type": "text", "value": "" }, { "name": "mask", "type": "text", "value": "" }, { "name": "prompt", "type": "text", "value": "" }, { "name": "magic_prompt", "type": "text", "value": "" }, { "name": "num_images", "type": "text", "value": "" }, { "name": "seed", "type": "text", "value": "" }, { "name": "rendering_speed", "type": "text", "value": "" }, { "name": "style_type", "type": "text", "value": "" }, { "name": "style_preset", "type": "text", "value": "" }, { "name": "color_palette", "type": "text", "value": "" }, { "name": "style_codes", "type": "text", "value": "" }, { "name": "style_reference_images", "type": "text", "value": "" }, { "name": "character_reference_images", "type": "text", "value": "" }, { "name": "character_reference_images_mask", "type": "text", "value": "" } ] } }, "docs": "Inpaint a given image synchronously using the provided mask with Ideogram 3.0. The mask indicates which part of the image\nshould be edited, while the prompt and chosen style can further guide the edit.\n\nSupported image formats include JPEG, PNG, and WebP.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.\n" }, { "info": { "name": "Remix with Ideogram 3.0", "type": "http" }, "http": { "method": "POST", "url": "https://api.ideogram.ai/v1/ideogram-v3/remix", "headers": [ { "name": "Api-Key", "value": "" } ], "body": { "type": "multipart-form", "data": [ { "name": "image", "type": "text", "value": "" }, { "name": "prompt", "type": "text", "value": "" }, { "name": "image_weight", "type": "text", "value": "" }, { "name": "seed", "type": "text", "value": "" }, { "name": "resolution", "type": "text", "value": "" }, { "name": "aspect_ratio", "type": "text", "value": "" }, { "name": "rendering_speed", "type": "text", "value": "" }, { "name": "magic_prompt", "type": "text", "value": "" }, { "name": "negative_prompt", "type": "text", "value": "" }, { "name": "num_images", "type": "text", "value": "" }, { "name": "color_palette", "type": "text", "value": "" }, { "name": "style_codes", "type": "text", "value": "" }, { "name": "style_type", "type": "text", "value": "" }, { "name": "style_preset", "type": "text", "value": "" }, { "name": "style_reference_images", "type": "text", "value": "" }, { "name": "character_reference_images", "type": "text", "value": "" }, { "name": "character_reference_images_mask", "type": "text", "value": "" } ] } }, "docs": "Remix provided images synchronously based on a given prompt and optional parameters with the Ideogram 3.0 model.\n\nInput images are cropped to the chosen aspect ratio before being remixed.\n\nSupported image formats include JPEG, PNG, and WebP.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.\n" }, { "info": { "name": "Reframe with Ideogram 3.0", "type": "http" }, "http": { "method": "POST", "url": "https://api.ideogram.ai/v1/ideogram-v3/reframe", "headers": [ { "name": "Api-Key", "value": "" } ], "body": { "type": "multipart-form", "data": [ { "name": "image", "type": "text", "value": "" }, { "name": "resolution", "type": "text", "value": "" }, { "name": "num_images", "type": "text", "value": "" }, { "name": "seed", "type": "text", "value": "" }, { "name": "rendering_speed", "type": "text", "value": "" }, { "name": "style_preset", "type": "text", "value": "" }, { "name": "color_palette", "type": "text", "value": "" }, { "name": "style_codes", "type": "text", "value": "" }, { "name": "style_reference_images", "type": "text", "value": "" } ] } }, "docs": "Reframe a square image to a chosen resolution with Ideogram 3.0. The supported image formats include JPEG, PNG, and WebP.\n\nImage links are available for a limited period of time; if you would like to keep the image, you must download it.\n" }, { "info": { "name": "Replace Background with Ideogram 3.0", "type": "http" }, "http": { "method": "POST", "url": "https://api.ideogram.ai/v1/ideogram-v3/replace-background", "headers": [ { "name": "Api-Key", "value": "" } ], "body": { "type": "multipart-form", "data": [ { "name": "image", "type": "text", "value": "" }, { "name": "prompt", "type": "text", "value": "" }, { "name": "magic_prompt", "type": "text", "value": "" }, { "name": "num_images", "type": "text", "value": "" }, { "name": "seed", "type": "text", "value": "" }, { "name": "rendering_speed", "type": "text", "value": "" }, { "name": "style_preset", "type": "text", "value": "" }, { "name": "color_palette", "type": "text", "value": "" }, { "name": "style_codes", "type": "text", "value": "" }, { "name": "style_reference_images", "type": "text", "value": "" } ] } }, "docs": "Replace the background of a given image synchronously using a prompt with Ideogram 3.0. The foreground subject\nwill be identified and kept, while the background is replaced based on the prompt and chosen style.\nSupported image formats include JPEG, PNG, and WebP.\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.\n" }, { "info": { "name": "Remove Background", "type": "http" }, "http": { "method": "POST", "url": "https://api.ideogram.ai/v1/remove-background", "headers": [ { "name": "Api-Key", "value": "" } ], "body": { "type": "multipart-form", "data": [ { "name": "image", "type": "text", "value": "" } ] } }, "docs": "Remove the background of a given image synchronously. The foreground subject\nis identified and returned on a transparent background. Supported image formats include JPEG,\nPNG, and WebP.\nImage links are available for a limited period of time; if you would like to keep the image,\nyou must download it.\n" }, { "info": { "name": "Layerize Text", "type": "http" }, "http": { "method": "POST", "url": "https://api.ideogram.ai/v1/ideogram-v3/layerize-text", "headers": [ { "name": "Api-Key", "value": "" } ], "body": { "type": "multipart-form", "data": [ { "name": "image", "type": "text", "value": "" }, { "name": "prompt", "type": "text", "value": "" }, { "name": "seed", "type": "text", "value": "" } ] } }, "docs": "Analyzes an image to detect text regions, then returns each detected text block with its position, content, font information, and styling.\n\nThe response includes a text-erased base image (background with all text removed) and a flat list of detected text blocks.\n\nSupported image formats include JPEG, PNG, and WebP (max size 10MB).\n\nImage links are available for a limited period of time; if you would like to keep the image, you must download it.\n" }, { "info": { "name": "Edit images with a prompt", "type": "http" }, "http": { "method": "POST", "url": "https://api.ideogram.ai/v1/edit", "headers": [ { "name": "Api-Key", "value": "" } ], "body": { "type": "multipart-form", "data": [ { "name": "prompt", "type": "text", "value": "" }, { "name": "images", "type": "text", "value": "" }, { "name": "image_urls", "type": "text", "value": "" }, { "name": "num_images", "type": "text", "value": "" }, { "name": "seed", "type": "text", "value": "" }, { "name": "magic_prompt", "type": "text", "value": "" }, { "name": "resolution", "type": "text", "value": "" }, { "name": "aspect_ratio", "type": "text", "value": "" }, { "name": "transparent_background", "type": "text", "value": "" } ] } }, "docs": "Edit one or more images using a text prompt. Provide images via file upload\nor Ideogram image URLs, and describe the desired edit in your prompt.\n\nSupported image formats include JPEG, PNG, and WebP.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.\n" }, { "info": { "name": "Upscale", "type": "http" }, "http": { "method": "POST", "url": "https://api.ideogram.ai/upscale", "headers": [ { "name": "Api-Key", "value": "" } ], "body": { "type": "multipart-form", "data": [ { "name": "image_request", "type": "text", "value": "" }, { "name": "image_file", "type": "text", "value": "" } ] } }, "docs": "Upscale provided images synchronously with an optional prompt.\n\nSupported image formats include JPEG, PNG, and WebP.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.\n" }, { "info": { "name": "Generate (legacy)", "type": "http" }, "http": { "method": "POST", "url": "https://api.ideogram.ai/generate", "headers": [ { "name": "Api-Key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates images synchronously based on a given prompt and optional parameters.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.\n" }, { "info": { "name": "Edit with Ideogram 3.0 (legacy)", "type": "http" }, "http": { "method": "POST", "url": "https://api.ideogram.ai/v1/ideogram-v3/edit", "headers": [ { "name": "Api-Key", "value": "" } ], "body": { "type": "multipart-form", "data": [ { "name": "image", "type": "text", "value": "" }, { "name": "mask", "type": "text", "value": "" }, { "name": "prompt", "type": "text", "value": "" }, { "name": "magic_prompt", "type": "text", "value": "" }, { "name": "num_images", "type": "text", "value": "" }, { "name": "seed", "type": "text", "value": "" }, { "name": "rendering_speed", "type": "text", "value": "" }, { "name": "style_type", "type": "text", "value": "" }, { "name": "style_preset", "type": "text", "value": "" }, { "name": "color_palette", "type": "text", "value": "" }, { "name": "style_codes", "type": "text", "value": "" }, { "name": "style_reference_images", "type": "text", "value": "" }, { "name": "character_reference_images", "type": "text", "value": "" }, { "name": "character_reference_images_mask", "type": "text", "value": "" } ] } }, "docs": "Legacy: use [`POST /v1/ideogram-v3/inpaint`](/api-reference/api-reference/inpaint-v3) instead. This endpoint will be removed in a future release.\n\nEdit a given image synchronously using the provided mask with Ideogram 3.0. The mask indicates which part of the image\nshould be edited, while the prompt and chosen style can further guide the edit.\n\nSupported image formats include JPEG, PNG, and WebP.\n\nImages links are available for a limited period of time; if you would like to keep the image, you m" }, { "info": { "name": "Edit (legacy)", "type": "http" }, "http": { "method": "POST", "url": "https://api.ideogram.ai/edit", "headers": [ { "name": "Api-Key", "value": "" } ], "body": { "type": "multipart-form", "data": [ { "name": "image_file", "type": "text", "value": "" }, { "name": "mask", "type": "text", "value": "" }, { "name": "prompt", "type": "text", "value": "" }, { "name": "model", "type": "text", "value": "" }, { "name": "magic_prompt_option", "type": "text", "value": "" }, { "name": "num_images", "type": "text", "value": "" }, { "name": "seed", "type": "text", "value": "" }, { "name": "style_type", "type": "text", "value": "" } ] } }, "docs": "Edit a given image synchronously using the provided mask. The mask indicates which part of the image\nshould be edited, while the prompt and chosen style type can further guide the edit.\n\nSupported image formats include JPEG, PNG, and WebP.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.\n" }, { "info": { "name": "Remix (legacy)", "type": "http" }, "http": { "method": "POST", "url": "https://api.ideogram.ai/remix", "headers": [ { "name": "Api-Key", "value": "" } ], "body": { "type": "multipart-form", "data": [ { "name": "image_request", "type": "text", "value": "" }, { "name": "image_file", "type": "text", "value": "" } ] } }, "docs": "Remix provided images synchronously based on a given prompt and optional parameters.\n\nInput images are cropped to the chosen aspect ratio before being remixed.\n\nSupported image formats include JPEG, PNG, and WebP.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.\n" }, { "info": { "name": "Reframe (legacy)", "type": "http" }, "http": { "method": "POST", "url": "https://api.ideogram.ai/reframe", "headers": [ { "name": "Api-Key", "value": "" } ], "body": { "type": "multipart-form", "data": [ { "name": "image_file", "type": "text", "value": "" }, { "name": "resolution", "type": "text", "value": "" }, { "name": "model", "type": "text", "value": "" }, { "name": "num_images", "type": "text", "value": "" }, { "name": "seed", "type": "text", "value": "" }, { "name": "style_type", "type": "text", "value": "" } ] } }, "docs": "Reframe a square image to a chosen resolution. The supported image formats include JPEG, PNG, and WebP.\n\nImage links are available for a limited period of time; if you would like to keep the image, you must download it.\n" } ] } ], "bundled": true }