Download OpenAPI specification:Download
REST API for Adobe Firefly for enterprise usage
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.
required | object (InputImageV3) The image to expand. You can either use a url or an
|
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. |
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 |
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:
|
Successful Response
Bad Request
Forbidden
Request Timeout
Request Entity Too Large
Unsupported Media Type
Unprocessable Entity
Too Many Requests
Internal Server Error
{- "image": {
}, - "negativePrompt": "string",
- "numVariations": 1,
- "prompt": "string",
- "promptBiasingLocaleCode": "string",
- "seeds": [
- 0
], - "size": {
- "height": 2048,
- "width": 2048
}
}
{- "cancelUrl": "string",
- "jobId": "string",
- "statusUrl": "string"
}
jobId required | string (title job urn id) Unique identifier for the submitted job |
Successful Response
Not Found
Validation Error
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'
{- "error_code": "some_error_code",
- "jobId": "ede28272-5726-4179-84f0-020250966e32",
- "message": "some_message",
- "status": "cancel_pending"
}
jobId required | string (title job urn id) Unique identifier for the submitted job |
Successful Response
Not Found
Conflict
Gone
Validation Error
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'
null