Composite Operations

Generate object composite

Changed on

Combines your image and images generated by Firefly to create an image composite, or scene. The images that Firefly generates are based on a text prompt that you provide. You can upload an image with or without an image mask, such as a product photo, but for a successful result one of the following conditions must be true: <ul> <li>The request size is larger than the input image, OR</li> <li>The image contains a transparent layer/channel, OR</li> <li>A mask is provided</li> </ul>

post/v3/images/generate-object-composite-async

Request

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

Request body

contentClass'photo' | 'art'

The content class of the image.

numVariationsinteger

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

promptstring required

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

seedsinteger[]

Array of seed image IDs. These reference images help ensure consistent image generation across multiple API calls.

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

  • 8bb5f0c4193fRevision 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

  • 9f9e7e4a32e8Revision changes
    • info

      api tag Common Operations removed