Firefly API (V3)

Download OpenAPI specification:Download

REST API for Adobe Firefly for enterprise usage

Fill Image Async - Model 3

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.

Performs this asynchronously, meaning you make your request and provide an image with your text prompt and on success, returns a jobID, status endpoint and endpoint to cancel the request. You can later poll the status endpoint to get updates on whether the job completes and to get the image.

SecurityX-Api-Key and AccessToken
Request
Request Body schema:
required
required
object (InputImageV3)

The image to expand. You can either use a url or an uploadID as the source for the image. Firefly only allows these listed domains as input URL in the request:

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

required
object (InputMaskV3)

Required. Selected areas of a background image that Firefly uses to fill the source image.

negativePrompt
string (Avoid prompt) <= 1024 characters

An optional text prompt up to 1024 characters. Avoid these characteristics in the generated image.

numVariations
integer (The number of variations) [ 1 .. 4 ]

Generate this number of variations. numVariations defaults to the number of seed images, or to 1 if you do not specify seeds.

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

An optional text prompt up to 1024 characters. The longer the prompt the better Firefly performs.

promptBiasingLocaleCode
string (The locale used to generate an image)

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 your profile and the accepted language header.

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

Array of seed image IDs. These reference images help 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 equal to numVariations.

object (The size)
Default: {"height":2048,"width":2048}

The desired width and height for the final expanded 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

Responses
202

Successful Response

400

Bad Request

403

Forbidden

408

Request Timeout

413

Request Entity Too Large

415

Unsupported Media Type

422

Unprocessable Entity

429

Too Many Requests

500

Internal Server Error

post/v3/images/fill-async
Request samples
{
  • "image": {},
  • "mask": {},
  • "negativePrompt": "string",
  • "numVariations": 1,
  • "prompt": "string",
  • "promptBiasingLocaleCode": "string",
  • "seeds": [
    ],
  • "size": {
    }
}
Response samples
application/json
{
  • "cancelUrl": "string",
  • "jobId": "string",
  • "statusUrl": "string"
}

Get Result - Async

SecurityX-Api-Key and AccessToken
Request
path Parameters
jobId
required
string (title job urn id)

Unique identifier for the submitted job

Responses
200

Successful Response

404

Not Found

422

Validation Error

get/v3/status/{jobId}
Request samples
curl -i -X GET \
  'https://firefly-api.adobe.io/v3/status/{jobId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "error_code": "some_error_code",
  • "jobId": "ede28272-5726-4179-84f0-020250966e32",
  • "message": "some_message",
  • "status": "cancel_pending"
}

Cancel Job - Async

SecurityX-Api-Key and AccessToken
Request
path Parameters
jobId
required
string (title job urn id)

Unique identifier for the submitted job

Responses
200

Successful Response

404

Not Found

409

Conflict

410

Gone

422

Validation Error

put/v3/cancel/{jobId}
Request samples
curl -i -X PUT \
  'https://firefly-api.adobe.io/v3/cancel/{jobId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
null