Adobe Firefly modules

In an Adobe Workfront Fusion scenario, you can automate workflows that use Adobe Firefly, as well as connect it to multiple third-party applications and services.

If you need instructions on creating a scenario, see the articles under Create a scenario: article index.

For information about modules, see the articles under Modules: article index.

Access requirements

Expand to view access requirements for the functionality in this article.
table 0-row-2 1-row-2 2-row-2 3-row-2 layout-auto html-authored no-header
Adobe Workfront package

Any Adobe Workfront Workflow package and any Adobe Workfront Automation and Integration package

Workfront Ultimate

Workfront Prime and Select packages, with an additional purchase of Workfront Fusion.

Adobe Workfront licenses

Standard

Work or higher

Adobe Workfront Fusion license

Operation-based: No Workfront Fusion license requirement

Connector-based (legacy): Workfront Fusion for Work Automation and Integration

Product If your organization has a Select or Prime Workfront package that does not include Workfront Automation and Integration, your organization must purchase Adobe Workfront Fusion.

For more detail about the information in this table, see Access requirements in documentation.

For information on Adobe Workfront Fusion licenses, see Adobe Workfront Fusion licenses.

Prerequisites

Before you can use the Adobe Firefly connector, you must ensure that the following prerequisites are met:

  • You must have an active Adobe Firefly account.

Adobe Firefly API information

The Adobe Firefly connector uses the following:

API tag
v1.4.24

Create a connection to Adobe Firefly

To create a connection for your Adobe Firefly modules:

  1. In any module, click Add next to the Connection box.

  2. Fill in the following fields:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 layout-auto html-authored no-header
    Connection name Enter a name for this connection.
    Environment Select whether you are connecting to a production or non-production environment.
    Type Select whether you are connecting to a service account or a personal account.
    Client ID Enter your Adobe Client ID. This can be found in the Credentials details section of the Adobe Developer Console.
    Client Secret Enter your Adobe Client Secret. This can be found in the Credentials details section of the Adobe Developer Console.
  3. Click Continue to save the connection and return to the module.

Adobe Firefly modules and their fields

When you configure Adobe Firefly modules, Workfront Fusion displays the fields listed below. Along with these, additional Adobe Firefly fields might display, depending on factors such as your access level in the app or service. A bolded title in a module indicates a required field.

If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another.

Map toggle

Expand an image

This action module expands an image, optionally with content from a prompt you provide.

This module works with the Firefly API V3 Async. The previous version of this module has been deprecated and will be removed in the near future.

Connection
For instructions on creating a connection to Adobe Firefly, see Create a connection to Adobe Firefly in this article.
Prompt
Enter or map a prompt for the content with which you want to expand the image. If no prompt is provided, the image will be expanded with content matching the original image.
Number of variations
Enter a number between 1-4. The module will generate this number of expanded image variations.
Source

Select how you are providing the source file:

  • File

    Select a source file from a previous module, or map the source file's Reference image file name and reference image file.

  • Presigned URL

    Enter or map the URL of the source image.

Expanded image format
Select the file format that the expanded image will be saved as.
Expand by

Select whether you want to expand the image by using image placement or by using a mask.

  • Placement

    Enter the horizontal and vertial alignment, and the inset of the placed image from the edges.

  • Mask

    Select the source file for the mask, and whether the mask should be inverted.

Size
Select the height and width that you want the expanded image to be.
Seeds
For each image that the module will generate, click Add item and enter or map an integer. You can use this same seed in another Expand an image module to generate a similar image with different styles. The number of seeds you add must be equal to the Number of variations field.

Expand an image (deprecated)

This module has been deprecated and will be removed in the near future. Use the Expand an image module instead.

Fill an image

This action module fills the masked area of an image, optionally with content from a prompt you provide.

This module works with the Firefly API V3 Async. The previous version of this module has been deprecated and will be removed in the near future.

Connection
For instructions on creating a connection to Adobe Firefly, see Create a connection to Adobe Firefly in this article.
Image > Source

Select how you are providing the image source file:

  • File

    Select a source file from a previous module, or map the source file's Reference image file name and reference image file.

  • Presigned URL

    Enter or map the URL of the source image.

Mask > Source

Select how you are providing the mask source file:

  • File

    Select a source file from a previous module, or map the source file's Reference image file name and reference image file.

  • Presigned URL

    Enter or map the URL of the source image.

Prompt
Enter or map a prompt for the content with which you want to fill the image. If no prompt is provided, the image will be filled with content matching the original image.
Number of variations
Enter a number between 1-4. The module will generate this number of filled image variations.
Filled image format
Select the file format that the filled image will be saved as.
Seeds
For each image that the module will generate, click Add item and enter or map an integer. You can use this same seed in another Expand an image module to generate a similar image with different styles. The number of seeds you add must be equal to the Number of variations field.
Size
Select the size that you want the filled image to be.
Locale

If a locale is provided, the module generates content more relevant to the specified locale.

Locale must be provided in ISO 639-1 language code and ISO 3166-1 region.

Example: en-US

Fill an image (deprecated)

This module has been deprecated and will be removed in the near future. Use the Fill an image module instead.

Generate adaptive composite

This action module composites a subject image seamlessly into a background image at a masked location. You can control how strongly shadows are applied, how the object’s lighting and color are harmonized with the background, and whether the original background details are preserved within the masked area.

Connection
For instructions on creating a connection to Adobe Firefly, see Create a connection to Adobe Firefly in this article.
Background > Image > Source

Select how you are providing the background image. The background image is the destination scene where the object will be composited.

  • Upload Image

    Upload the background image, or map the image file from a previous module.

  • Image URL

    Enter or map the URL of the background image.

Background > Fill Area Mask > Source

Select how you are providing the fill area mask. The fill area mask indicates the area of the background where the object will be placed.

  • Upload Image

    Upload the fill area mask image, or map the image file from a previous module.

  • Image URL

    Enter or map the URL of the fill area mask image.

Object > Image > Source

Select how you are providing the object image. The object image is the source image of the object to composite into the background.

  • Upload Image

    Upload the object image, or map the image file from a previous module.

  • Image URL

    Enter or map the URL of the object image.

Object > Mask > Source

Select how you are providing the object mask. The object mask is the segmentation mask for the object.

  • Upload Image

    Upload the object mask image, or map the image file from a previous module.

  • Image URL

    Enter or map the URL of the object mask image.

Number of Variations
Enter a number between 1 and 3. The module generates this number of composite variations.
Seeds*
Click Add item to add a seed value, then enter or map an integer. Use one seed per variation. The count of seed values must match the Number of Variations value if both are provided.
Harmonization*
Enter a number between 0 and 1 to control how much the object's colors and lighting are adjusted to match the background. 0.0 applies minimal harmonization and 1.0 applies maximum harmonization.
Shadow Intensity*
Enter a number between 0 and 1 to control shadow intensity in the composited result. Lower values reduce the shadow.
Preserve Background*

Select whether to preserve the original background details within the masked area during compositing.

  • Yes

    The original background details within the masked area are preserved during compositing.

  • No

    The original background details within the masked area are not preserved during compositing.

  • Not defined

    Use the default behavior for this option.

Output > Media Type*
Select the file format that the generated composite will be saved as.
  • These fields are advanced fields, and do not display unless you select Show advanced settings.

Generate an image

This action module generates and image based on a prompt you provide. You can also provide an optional reference image, and the generated image will match the style of the reference image.

This module works with the Firefly API V3 Async. The previous version of this module has been deprecated and will be removed in the near future.

Connection
For instructions on creating a connection to Adobe Firefly, see Create a connection to Adobe Firefly in this article.
Prompt
Enter or map a prompt for the image you want to generate. More detail in the prompt will allow you more control over what appears in the image.
Model version
Select the Firefly model version that you want to use to generate the image.
Number of variations
Enter a number between 1-4. The module will generate this number of image variations.
Generated image format
Select the file format that the expanded image will be saved as. If you select default, the file format will be JPEG if no reference image is provided. If a reference image is provided, the file format of the generated image will be the same as the reference image.
Structure > Image reference

Select how you are providing the source file for the new image's structure:

  • File

    Select a source file from a previous module, or map the source file's Reference image file name and reference image file.

  • Presigned URL

    Enter or map the URL of the source image.

Structure > Strength
Enter a number between 0 and 100 to control how strictly Firefly follows the source image's structure. Higher numbers mean that Firefly follows the image more strictly.
Style > Image reference

Select how you are providing the source file for the new image's style:

  • File

    Select a source file from a previous module, or map the source file's Reference image file name and reference image file.

  • Presigned URL

    Enter or map the URL of the source image.

Structure > Strength
Enter a number between 0 and 100 to control how strictly Firefly follows the source image's style. Higher numbers mean that Firefly follows the image more strictly.
Style > Presets

If you want to use a preset style, click Add item and enter or map the style that you want to use.

For a list of preset styles, see Image Model Styles in the Adobe developer documentation.

Negative prompt
Enter or map the words that you want to avoid in the generated content.
Content class

Select whether you want the generated image to be more like a photo, or more like created art.

  • Photo

    Enter values for the Aperture, Shutter speed (in seconds), and field of view (in millimeters).

Seed
For each image that the module will generate, click Add item and enter or map an integer. You can use this same seed in another Expand an image module to generate a similar image with different styles. The number of seeds you add must be equal to the Number of variations field.
Size
Select the size that you want the generated image to be.
Visual intensity
Enter or map an integer that represents the overall intensity of the photo's existing visual characteristics.
Locale

If a locale is provided, the module generates content more relevant to the specified locale.

Locale must be provided in ISO 639-1 language code and ISO 3166-1 region.

Example: en-US

Tileable
Enable this option to generate an image that can be repeated infinitely in every direction.

Generate an image (deprecated)

This module has been deprecated and will be removed in the near future. Use the Generate an image module instead.

Generate an object composite

This action module combines images generated by Firefly to create an image composite.

Connection
For instructions on creating a connection to Adobe Firefly, see Create a connection to Adobe Firefly in this article.
Prompt
Enter or map a prompt for the image you want to generate. More detail in the prompt will allow you more control over what appears in the image.
Number of variations
Enter a number between 1-4. The module will generate this number of image variations.
Content classs
Select whether you want the generated image to be more like a photo or like art.
Image > Source

Select how you are providing the source file for the new image's structure:

  • File

    Select a source file from a previous module, or map the source file's Reference image file name and reference image file.

  • Presigned URL

    Enter or map the URL of the source image.

Generated image format
Select the file format that the expanded image will be saved as. If you select default, the file format will be JPEG if no reference image is provided. If a reference image is provided, the file format of the generated image will be the same as the reference image.
Style > Image reference

Select how you are providing the source file for the new image's style:

  • File

    Select a source file from a previous module, or map the source file's Reference image file name and reference image file.

  • Presigned URL

    Enter or map the URL of the source image.

Structure > Strength
Enter a number between 0 and 100 to control how strictly Firefly follows the source image's style. Higher numbers mean that Firefly follows the image more strictly.
Style > Presets

If you want to use a preset style, click Add item and enter or map the style that you want to use.

For a list of preset styles, see Image Model Styles in the Adobe developer documentation.

Size
Select the size that you want the generated composite to be.

Generate images with Image5

This action module generates an image using the Adobe Firefly Image5 model. You provide a text prompt and, optionally, a reference image to guide the generation.

Connection
For instructions on creating a connection to Adobe Firefly, see Create a connection to Adobe Firefly in this article.
Prompt
Enter or map a description of the image you want to generate. The prompt must be between 1 and 1500 characters. More detail in the prompt allows you more control over what appears in the image.
Aspect Ratio
Select the shape of the generated image. If a reference image is provided, select Auto.
Resolution
Select the resolution of the generated image. Higher resolutions take longer to generate.
Reference Image
Optionally provide one reference image to guide the generation. Click Add item and provide the image. When you use a reference image, set Aspect Ratio to Auto.
Seed*
Click Add item and enter or map an integer to reproduce a specific generation result. Leave empty to generate a random result.
Prompt Reasoning*

Select the prompt reasoning strategy used during generation.

  • Quality - Generates image description

    Generates an image description in the module's output.

  • Speed - Faster generation, no description

    Generates the image faster, but leaves the image description empty.

Locale*

Enter or map a language and region code to tailor the generated content to a specific country and language.

Locale must be provided in ISO 639-1 language code and ISO 3166-1 region.

Example: en-US

Number of Variations*
Enter the number of images to generate per request. Currently, only 1 is supported. To generate multiple images, send separate requests.
Model*
Select the Firefly model that you want to use to generate the image.
Limit
Enter or map the maximum number of results that you want the module to work with during one execution cycle.

*These fields are advanced, and do not display unless you select Show advanced settings.

Generate precise composite

This action module places a subject in the masked region of a background image and applies generative harmonization so the subject blends naturally with the background.

Connection
For instructions on creating a connection to Adobe Firefly, see Create a connection to Adobe Firefly in this article.
Background > Image > Source

Select how you are providing the background image. The background image is the destination scene where the object will be composited.

  • Upload Image

    Upload the background image, or map the image file from a previous module.

  • Image URL

    Enter or map the URL of the background image.

Background > Fill Area Mask > Source

Select how you are providing the fill area mask. The fill area mask indicates the area of the background where the object will be placed.

  • Upload Image

    Upload the fill area mask image, or map the image file from a previous module.

  • Image URL

    Enter or map the URL of the fill area mask image.

Object > Image > Source

Select how you are providing the object image. The object image is the source image of the object to composite into the background.

  • Upload Image

    Upload the object image, or map the image file from a previous module.

  • Image URL

    Enter or map the URL of the object image.

Number of Variations
Enter a number between 1 and 3. The module generates this number of composite variations.
Seeds*
Click Add item to add a seed value, then enter or map an integer. Use one seed per variation. The count of seed values must match the Number of Variations value if both are provided.
Blend*
Enter a number between 0 and 1 to control the blend between the harmonized and original appearance of the object. 0.0 applies full harmonization, and 1.0 preserves the original object's appearance.
Output > Media Type*
Select the file format that the generated composite will be saved as.
  • These fields are advanced fields, and do not display unless you select Show advanced settings.

Generate similar images

This action module generates images similar to the source image you specify.

Connection
For instructions on creating a connection to Adobe Firefly, see Create a connection to Adobe Firefly in this article.
Number of variations
Enter a number between 1-4. The module will generate this number of image variations.
Model version
Select the Firefly model version that you want to use to generate the images.
Generated image format
Select the file format that the expanded image will be saved as. If you select default, the file format will be JPEG if no reference image is provided. If a reference image is provided, the file format of the generated image will be the same as the reference image.
Image > Source

Select how you are providing the source file for the new image's structure:

  • File

    Select a source file from a previous module, or map the source file's Reference image file name and reference image file.

  • Presigned URL

    Enter or map the URL of the source image.

Style > Image reference

Select how you are providing the source file for the new image's style:

  • File

    Select a source file from a previous module, or map the source file's Reference image file name and reference image file.

  • Presigned URL

    Enter or map the URL of the source image.

Size
Select the size that you want the generated composite to be.
Seeds
For each image that the module will generate, click Add item and enter or map an integer. You can use this same seed in another Expand an image module to generate a similar image with different styles. The number of seeds you add must be equal to the Number of variations field.
Tileable
Enable this option to generate an image that can be repeated infinitely in every direction.

Generate video

This action module generates a video from a text prompt. You can also provide one or more reference images to guide the video generation.

Connection
For instructions on creating a connection to Adobe Firefly, see Create a connection to Adobe Firefly in this article.
Prompt
Enter or map a description of the video you want to generate. More detail in the prompt allows you more control over what appears in the video.
Image > Conditions
Optionally provide one or more reference images to guide the video generation. Click Add item for each reference image.
Sizes
Click Add item and enter or map the dimensions of the generated video.
Bit Rate Factor*
Enter a number between 0 and 63 to specify the bit rate factor of the generated video.
Video Settings > Camera Motion*
Select the camera motion that you want to use in the generated video.
Video Settings > Prompt Style*
Select the prompt style that you want to use for the generated video.
Video Settings > Shot Angle*
Select the shot angle that you want to use in the generated video.
Video Settings > Shot Size*
Select the shot size that you want to use in the generated video.
Limit
Enter or map the maximum number of results that you want the module to work with during one execution cycle.
  • These fields are advanced fields, and do not display unless you select Show advanced settings.

Make a custom API call

This action module makes a custom call to the Firefly API.

For specific available APIs, see Adobe Firefly API in the Adobe Developer documentation.

Connection
For instructions on creating a connection to Adobe Firefly, see Create a connection to Adobe Firefly in this article.
URL
Enter a path relative to https://firefly-api.adobe.io/.
Method
Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods.
Headers

Add the headers of the request in the form of a standard JSON object.

For example, {"Content-type":"application/json"}

Workfront Fusion adds authorization headers automatically.

Body

Add the body content for the API call in the form of a standard JSON object.

Note:

When using conditional statements such as if in your JSON, put the quotation marks outside of the conditional statement.

recommendation-more-help
workfront-fusion-help-workfront-fusion