Common Operations

Generates a fill in an area of an image based on a text prompt. A mask defines the area of the image to be filled.

post/v3/images/fill-async

Request

  • Base URL: https://firefly-api.adobe.io
  • URL: https://firefly-api.adobe.io/v3/images/fill-async
  • Auth: API key in header x-api-key and HTTP bearer

Request body

negativePromptstring

An optional text prompt up to 1024 characters. Avoid these characteristics in the generated image. Not supported for Firefly Custom Models on Image Model 3 or Firefly Custom Models on Image Model 4.

numVariationsinteger

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

promptstring

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

promptBiasingLocaleCodestring

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.

seedsinteger[]

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 along with <code>numVariations</code>, the number of seeds must equal <code>numVariations</code>.

Response

Accepted

cancelUrlstring required

The URL to cancel the job.

jobIdstring required

The ID of the job.

statusUrlstring required

The URL to check the status of the job.

Changes

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      added subschema #1 subschema #2 to the /// response property oneOf list for the response status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new cai_assertion_violation_error enum value to the response property for the response status

    • info

      removed subschema #1 subschema #2 from the /// response property anyOf list for the response status

    • info

      removed the access_error enum value from the response property for the response status

    • info

      removed the bad_request enum value from the response property for the response status

    • info

      removed the empty_input_body enum value from the response property for the response status

    • info

      removed the invalid_content_type enum value from the response property for the response status

    • info

      removed the rate_limited enum value from the response property for the response status

    • info

      removed the runtime_error enum value from the response property for the response status

    • info

      removed the timeout_error enum value from the response property for the response status

    • breaking

      added the new required request property (media type: multipart/form-data)

    • breaking

      added the new required request property (media type: application/json)

    • breaking

      added the new required request property (media type: application/json)

    • breaking

      added the new required request property (media type: multipart/form-data)

    • breaking

      the request's body type changed from no type to object (media type: application/json)

    • breaking

      the request's body type changed from no type to object (media type: multipart/form-data)

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • warning

      added the new access_error enum value to the response property for the response status

    • warning

      added the new access_error enum value to the response property for the response status

    • warning

      added the new access_error enum value to the response property for the response status

    • warning

      added the new access_error enum value to the response property for the response status

    • warning

      added the new access_error enum value to the response property for the response status

    • warning

      added the new access_error enum value to the response property for the response status

    • warning

      added the new access_error enum value to the response property for the response status

    • warning

      added the new bad_request enum value to the response property for the response status

    • warning

      added the new bad_request enum value to the response property for the response status

    • warning

      added the new bad_request enum value to the response property for the response status

    • warning

      added the new bad_request enum value to the response property for the response status

    • warning

      added the new bad_request enum value to the response property for the response status

    • warning

      added the new bad_request enum value to the response property for the response status

    • warning

      added the new bad_request enum value to the response property for the response status

    • warning

      added the new empty_input_body enum value to the response property for the response status

    • warning

      added the new empty_input_body enum value to the response property for the response status

    • warning

      added the new empty_input_body enum value to the response property for the response status

    • warning

      added the new empty_input_body enum value to the response property for the response status

    • warning

      added the new empty_input_body enum value to the response property for the response status

    • warning

      added the new empty_input_body enum value to the response property for the response status

    • warning

      added the new empty_input_body enum value to the response property for the response status

    • warning

      added the new invalid_content_type enum value to the response property for the response status

    • warning

      added the new invalid_content_type enum value to the response property for the response status

    • warning

      added the new invalid_content_type enum value to the response property for the response status

    • warning

      added the new invalid_content_type enum value to the response property for the response status

    • warning

      added the new invalid_content_type enum value to the response property for the response status

    • warning

      added the new invalid_content_type enum value to the response property for the response status

    • warning

      added the new invalid_content_type enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new runtime_error enum value to the response property for the response status

    • warning

      added the new runtime_error enum value to the response property for the response status

    • warning

      added the new runtime_error enum value to the response property for the response status

    • warning

      added the new runtime_error enum value to the response property for the response status

    • warning

      added the new runtime_error enum value to the response property for the response status

    • warning

      added the new runtime_error enum value to the response property for the response status

    • warning

      added the new runtime_error enum value to the response property for the response status

    • warning

      added the new timeout_error enum value to the response property for the response status

    • warning

      added the new timeout_error enum value to the response property for the response status

    • warning

      added the new timeout_error enum value to the response property for the response status

    • warning

      added the new timeout_error enum value to the response property for the response status

    • warning

      added the new timeout_error enum value to the response property for the response status

    • warning

      added the new timeout_error enum value to the response property for the response status

    • warning

      added the new timeout_error enum value to the response property for the response status

    • warning

      added the new validation_error enum value to the response property for the response status

    • warning

      added the new validation_error enum value to the response property for the response status

    • warning

      added the new validation_error enum value to the response property for the response status

    • warning

      added the new validation_error enum value to the response property for the response status

    • warning

      added the new validation_error enum value to the response property for the response status

    • warning

      added the new validation_error enum value to the response property for the response status

    • warning

      added the new validation_error enum value to the response property for the response status

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status