Generate object composite
generate_object_compositeComposite an object onto an image using a prompt and optional mask, returning Adobe output URLs. Set wait=false for async jobs.
Instructions
Generate object composite. 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. | |
| mask | No | Selected areas of a background image that Firefly uses to fill the source image. | |
| size | No | The desired width and height for the final image in pixels. The supported sizes for the output images 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 (7:4) - width 1344px, height 768px (9:7) - width 1152px, height 896px (7:9) - width 896px, height 1152px . | |
| wait | No | Wait for completion, default true. Set false to return the job immediately. | |
| image | No | The image to expand. Use a URL or an uploadID as the source for the image. Firefly only allows these listed domains for input URLs in the request: amazonaws.com windows.net dropboxusercontent.com storage.googleapis.com . | |
| seeds | No | Array of seed image IDs. These reference images help ensure consistent image generation across multiple API calls. If specified along with numVariations, the number of seeds must equal numVariations. | |
| style | No | ||
| 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 up to 1024 characters. The longer the prompt the better Firefly performs. | |
| confirm | No | Must be true to spend Firefly Services credits for the operation the user requested. | |
| maskUrl | No | Compatibility URL alias for mask.source.url. | |
| download | No | Download completed media to FIREFLY_OUTPUT_DIR, default false. Requires wait=true. | |
| imageUrl | No | Compatibility URL alias for image.source.url. | |
| placement | No | The position of the source image after Firefly adjusts it. The value describes the horizontal and vertical placement and dimensions of the image in the output. Note you cannot use placement for source images when you also apply a mask image. | |
| contentClass | No | The content class of the image. | |
| numVariations | No | Generate this number of variations. Defaults to the number of seed images, or to 1 if you do not specify seeds. |