Firefly API (V3)

Download OpenAPI specification:Download

REST API for Adobe Firefly for enterprise usage

Fill Image - Model 3Deprecated

Fills an area of an image based on images that Firefly generates based on your prompt. We call this part of an image an image, and this mask defines the area which should be filled. For example you can have an circular mask defined on an image and Firefly can generate the image of a planet in that area.

SecurityX-Api-Key and AccessToken
Request
Request Body schema: application/json
required
numVariations
integer (The number of variations) [ 1 .. 4 ]

The number of variations to generate. numVariations will default to the number of seeds, or to 1 if seeds is not specified.

seeds
Array of integers (The seed of each variation) [ 1 .. 4 ] items unique
Default: [0]

Array of seed(s) that ensure consistent image generation across multiple API calls. For example, you can use the same seed to generate a similar image with different styles. If specified alongside with numVariations, the number of seeds must be the equal to numVariations

prompt
string (The prompt) [ 1 .. 1024 ] characters

The prompt used to generate the image. The longer the prompt - the better

negativePrompt
string (Avoid prompt) <= 1024 characters

Inference will try to generate against this prompt

required
object (Input Image)

Input image to fill with generative content. You can either use a url or an uploadId as the source for the uploaded image. Supported formats are, image/jpeg, image/png, image/webp.
Note: Only allow listed domains are allowed to be accepted as input URL in the request. The allow-listed domains are as follows:

  • amazonaws.com
  • windows.net
  • dropboxusercontent.com

promptBiasingLocaleCode
string (The locale used for image generations)
Default: "en-US"

A hyphen-separated string combining the ISO 639-1 language code and the ISO 3166-1 region, such as "en-US". When a locale is set, the prompt will be biased to generate more relevant content for that region. The locale will be auto-detected if not specified based on the user's profile and Accept-Language header.

Responses
200

Successful Response

400

Bad Request

403

Forbidden

408

Request Timeout

415

Unsupported Media Type

422

Unprocessable Entity

429

Too Many Requests

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

post/v3/images/fill
Request samples
application/json
{
  • "numVariations": 1,
  • "seeds": [
    ],
  • "prompt": "string",
  • "negativePrompt": "string",
  • "image": {},
  • "promptBiasingLocaleCode": "en-US"
}
Response samples
application/json
{
  • "size": {
    },
  • "outputs": []
}