Common Operations

Generate images based on a text prompt. You may also include a reference image and Firefly will try to mimic the characteristics, such as color scheme, lighting, layout of objects in the image, etc.

post/v3/images/generate-async

Request

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

Headers

x-model-version'image3' | 'image3_custom' | 'image4_standard' | 'image4_ultra' | 'image4_custom'

Specify the Firefly model version to use for the image generation. When a custom model is used, a customModelId must also be passed in the request body.

Request body

contentClass'photo' | 'art'

The content class of the image.

customModelIdstring

Include the specific custom model ID when a custom model type is designated in the x-model-version header parameter.

negativePromptstring

A negative prompt of things Firefly will try to avoid generating in the image. Not supported for Firefly Custom Models on Image Model 3 or Firefly Custom Models on Image Model 4.

numVariationsinteger

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

promptstring required

A text prompt to support the generation of an image. 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 (like en-US). When a locale is set, the prompt will be biased to generate more relevant content for that region. If not specified, the locale will be auto-detected based on your profile and the accepted language header.

seedsinteger[]

An array of seed image IDs. These reference images help ensure consistent image generation across multiple API calls. For example, use the same seed to generate a similar image in different styles. If specified along with <code>numVariations</code>, the number of seeds provided must equal <code>numVariations</code>.

upsamplerType'default' | 'low_creativity'

Only supported with the model version image4_custom. The default setting upscales generated images to 2k. The low_creativity setting refines the image generation by removing distortions, smoothing textures, and sometimes adding details (like freckles to faces in close-up). This setting is recommended for generating images with human subjects.

visualIntensityinteger

Adjust the overall intensity of your photo's characteristics, such as contrast, shadow, and hue. This is not supported with the model version image4_custom.

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: 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 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