Generate images
generate_imageGenerate images from text prompts using Adobe Firefly Services. Returns Adobe output URLs, supports async jobs, and consumes credits.
Instructions
Generate images. Consumes Firefly Services credits. Returns Adobe output URLs. Set wait=false to return an async job.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| n | No | Compatibility alias for numVariations. Do not supply both. | |
| size | No | The desired width and height for the final image, in pixels. Supported sizes for the output images with `image3` are: Square (1:1) - width 2048px, height 2048px Square (1:1) - width 1024px, height 1024px Landscape (4:3) - width 2304px, height 1792px Portrait (3:4) - width 1792px, height 2304px Widescreen (16:9) - width 2688px, height 1536px Widescreen (16:9) - width 2688px, height 1512px (7:4) - width 1344px, height 768px (7:4) - width 1344px, height 756px (9:7) - width 1152px, height 896px (7:9) - width 896px, height 1152px Supported sizes for the output images with `image4` are: (1:1) - width 2048px, height 2048px (4:3) - width 2304px, height 1792px (3:4) - width 1792px, height 2304px (16:9) - width 2688px, height 1536px (9:16) - width 1440px, height 2560px . | |
| wait | No | Wait for completion, default true. Set false to return the job immediately. | |
| seeds | No | An array of seed image IDs. These reference images help ensure consistent image generation across multiple API calls. For example, use the same seed to generate a similar image in different styles. If specified along with numVariations, the number of seeds provided must equal numVariations. | |
| style | No | An object with the reference image details for style. | |
| width | No | Compatibility alias: provide together with height instead of size. | |
| height | No | Compatibility alias: provide together with width instead of size. | |
| prompt | Yes | A text prompt to support the generation of an image. The longer the prompt the better Firefly performs. | |
| confirm | No | Must be true to spend Firefly Services credits for the operation the user requested. | |
| download | No | Download completed media to FIREFLY_OUTPUT_DIR, default false. Requires wait=true. | |
| structure | No | An object with the reference image details for structure. | |
| contentClass | No | Directs the style of a generated image to be photographic or like fine art. | |
| customModelId | No | Include the specific custom model ID when a custom model type is designated in the `x-model-version` header parameter. | |
| numVariations | No | The number of variations to generate. numVariations defaults to the number of seed images, or to 1 if you do not specify `seeds`. | |
| upsamplerType | No | Only supported with the model version `image4_custom`. The `default` setting upscales generated images to 2k. The `low_creativity` setting refines the image generation by removing distortions, smoothing textures, and sometimes adding details (like freckles to faces in close-up). This setting is recommended for generating images with human subjects. | default |
| negativePrompt | No | A negative prompt of things Firefly will try to avoid generating in the image. Not supported for Firefly Custom Models on Image Model 3 or Firefly Custom Models on Image Model 4. | |
| visualIntensity | No | Adjust the overall intensity of your photo's characteristics, such as contrast, shadow, and hue. This is not supported with the model version `image4_custom`. | |
| promptBiasingLocaleCode | No | A hyphen-separated string combining the ISO 639-1 language code and the ISO 3166-1 region (like en-US). When a locale is set, the prompt will be biased to generate more relevant content for that region. If not specified, the locale will be auto-detected based on your profile and the accepted language header. |