# Adobe Firefly Services

> Make and edit pictures and short videos with Adobe Firefly: generate images from a prompt or your custom models, expand, fill and upscale pictures, and put products into new scenes or your own photos.

App · 12 actions. Web page: https://docs.lodol.com/docs/integrations/adobe-firefly-services

## Actions

### Cancel job

Stop a Firefly job that hasn't finished yet.

**Inputs**

- Job ID (`job_id`, text, required): The Firefly job, from an earlier step's job_id.

**Outputs**

- `cancelled` (true/false): Always true once Firefly accepts it
- `job_id` (text): The job cancelled

**Example output**

```json
{
  "cancelled": true,
  "job_id": "urn:ff:jobs:eso851211:86ffe2ea-d765-4bd3-b2fd-568ca8fc36ac"
}
```

### Expand image

Make a picture larger or change its shape, with Firefly filling in the new space, optionally from a prompt. The results are saved as files.

**Inputs**

- Picture (`image`, text, required): The picture to expand. Upload it, pick a file from an earlier step, or give its link or an upload id from 'Upload image'.
- Width (`width`, number): The result's width in pixels, up to 3999. Defaults to 2048. From 1 to 3999.
- Height (`height`, number): The result's height in pixels, up to 3999. Defaults to 2048. From 1 to 3999.
- Prompt (`prompt`, text): What to put in the new space. Leave empty to continue the picture.
- Horizontal position (`horizontal_position`, text): Where the original picture sits across the result. One of: `center` (Center (default)), `left`, `right`. Default: `center`.
- Vertical position (`vertical_position`, text): Where the original picture sits up and down the result. One of: `center` (Center (default)), `top`, `bottom`. Default: `center`.
- Number of pictures (`number_of_images`, number): How many versions to make, 1 to 4. Defaults to 1. From 1 to 4.
- Wait for it to finish (`wait`, true/false): On (the default), the step waits for Firefly and returns what it made. Off, it returns the job id at once, to collect later with 'Get job'. Default: `true`.

**Outputs**

- `content_type` (text): The first saved file's type
- `document_ref` (text): The first saved file
- `documents` (list): Every picture or video, saved as a file in this workspace
- `error_code` (text): Firefly's error code when the job did not succeed
- `filename` (text): The first saved file's name
- `image_count` (number): How many pictures
- `images` (list): The pictures Firefly made
- `job_id` (text): The Firefly job, for 'Get job' or 'Cancel job'
- `message` (text): Firefly's reason when the job did not succeed
- `progress` (number): How far the job has got, in percent, when Firefly says
- `seed` (number): The seed of the first picture, or of the video
- `size_bytes` (number): The first saved file's size in bytes
- `status` (text): pending, running, succeeded, failed, cancelled, cancel_pending or timeout
- `url` (text): Where Lodol serves the first saved file
- `video_url` (text): Firefly's link to the video it made; it expires after about an hour

**Example output**

```json
{
  "content_type": "image/jpeg",
  "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
  "documents": [
    {
      "content_type": "image/jpeg",
      "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
      "filename": "adobe-firefly-image-1.jpg",
      "size_bytes": 1843201,
      "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678"
    }
  ],
  "error_code": null,
  "filename": "adobe-firefly-image-1.jpg",
  "image_count": 1,
  "images": [
    {
      "seed": 2142812600,
      "url": "https://pre-signed-firefly-prod.s3-accelerate.amazonaws.com/images/0c5c80a3-7189-4bd3-a52e-87b36e4fc47b"
    }
  ],
  "job_id": "urn:ff:jobs:eso851211:86ffe2ea-d765-4bd3-b2fd-568ca8fc36ac",
  "message": null,
  "progress": 100,
  "seed": 2142812600,
  "size_bytes": 1843201,
  "status": "succeeded",
  "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678",
  "video_url": null
}
```

### Fill image

Replace part of a picture, marked by a mask, with what a prompt describes, or remove what is there. The results are saved as files.

**Inputs**

- Picture (`image`, text, required): The picture to change. Upload it, pick a file from an earlier step, or give its link or an upload id from 'Upload image'.
- Mask (`mask`, text, required): A black-and-white picture the same size, white where Firefly should fill. Upload it, pick a file from an earlier step, or give its link or an upload id from 'Upload image'.
- Prompt (`prompt`, text): What to put in the masked area. Leave empty to remove what is there.
- Fill outside the mask (`invert_mask`, true/false): On fills everything except the white area instead. Default: `false`.
- Avoid (`negative_prompt`, text): Things to keep out of the picture, such as text or people.
- Number of pictures (`number_of_images`, number): How many versions to make, 1 to 4. Defaults to 1. From 1 to 4.
- Size (`size`, text): The result's shape and size, in pixels. One of: `2048x2048` (Square, 2048 × 2048 (default)), `1024x1024` (Small square, 1024 × 1024), `2304x1792` (Landscape 4:3, 2304 × 1792), `1792x2304` (Portrait 3:4, 1792 × 2304), `2688x1536` (Widescreen 16:9, 2688 × 1536), `1344x768` (Wide 7:4, 1344 × 768), `1152x896` (Landscape 9:7, 1152 × 896), `896x1152` (Portrait 7:9, 896 × 1152). Default: `2048x2048`.
- Wait for it to finish (`wait`, true/false): On (the default), the step waits for Firefly and returns what it made. Off, it returns the job id at once, to collect later with 'Get job'. Default: `true`.

**Outputs**

- `content_type` (text): The first saved file's type
- `document_ref` (text): The first saved file
- `documents` (list): Every picture or video, saved as a file in this workspace
- `error_code` (text): Firefly's error code when the job did not succeed
- `filename` (text): The first saved file's name
- `image_count` (number): How many pictures
- `images` (list): The pictures Firefly made
- `job_id` (text): The Firefly job, for 'Get job' or 'Cancel job'
- `message` (text): Firefly's reason when the job did not succeed
- `progress` (number): How far the job has got, in percent, when Firefly says
- `seed` (number): The seed of the first picture, or of the video
- `size_bytes` (number): The first saved file's size in bytes
- `status` (text): pending, running, succeeded, failed, cancelled, cancel_pending or timeout
- `url` (text): Where Lodol serves the first saved file
- `video_url` (text): Firefly's link to the video it made; it expires after about an hour

**Example output**

```json
{
  "content_type": "image/jpeg",
  "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
  "documents": [
    {
      "content_type": "image/jpeg",
      "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
      "filename": "adobe-firefly-image-1.jpg",
      "size_bytes": 1843201,
      "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678"
    }
  ],
  "error_code": null,
  "filename": "adobe-firefly-image-1.jpg",
  "image_count": 1,
  "images": [
    {
      "seed": 2142812600,
      "url": "https://pre-signed-firefly-prod.s3-accelerate.amazonaws.com/images/0c5c80a3-7189-4bd3-a52e-87b36e4fc47b"
    }
  ],
  "job_id": "urn:ff:jobs:eso851211:86ffe2ea-d765-4bd3-b2fd-568ca8fc36ac",
  "message": null,
  "progress": 100,
  "seed": 2142812600,
  "size_bytes": 1843201,
  "status": "succeeded",
  "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678",
  "video_url": null
}
```

### Generate images

Make up to four pictures from a prompt, optionally in chosen styles, after a style or composition reference picture, or with your own custom model. The pictures are saved as files.

**Inputs**

- Prompt (`prompt`, text, required): Describe the picture you want. The more detail, the better.
- Model (`model`, text): Which Firefly model makes the pictures. One of: `image4_standard` (Image 4 (default)), `image4_ultra` (Image 4 Ultra: the most detail, takes longer), `image3` (Image 3), `image4_custom` (My custom model, trained on Image 4), `image3_custom` (My custom model, trained on Image 3). Default: `image4_standard`.
- Custom model (`custom_model_id`, text): Your custom model, when the model is one of yours. For a subject model, name its subject in the prompt. Only when Model is My custom model, trained on Image 3 or My custom model, trained on Image 4.
- Number of pictures (`number_of_images`, number): How many versions to make, 1 to 4. Defaults to 1. From 1 to 4.
- Size (`size`, text): The pictures' shape and size, in pixels. One of: `2048x2048` (Square, 2048 × 2048 (default)), `2304x1792` (Landscape 4:3, 2304 × 1792), `1792x2304` (Portrait 3:4, 1792 × 2304), `2688x1536` (Widescreen 16:9, 2688 × 1536), `1440x2560` (Tall 9:16, 1440 × 2560), `1024x1024` (Small square, 1024 × 1024), `2688x1512` (Widescreen 16:9, 2688 × 1512), `1344x768` (Wide 7:4, 1344 × 768), `1344x756` (Wide 7:4, 1344 × 756), `1152x896` (Landscape 9:7, 1152 × 896), `896x1152` (Portrait 7:9, 896 × 1152). Default: `2048x2048`.
- Look (`content_class`, text): Whether the result looks like a photo or like art. One of: `auto` (Let Firefly decide (default)), `photo`, `art`. Default: `auto`.
- Style presets (`style_presets`, list): Styles to apply, such as Watercolor or Golden hour. All chosen apply together. One or more of: `graphic`, `wireframe`, `vector_look` (Vector look), `bw` (Black and white), `cool_colors` (Cool tone), `golden`, `monochromatic`, `muted_color` (Muted color), `pastel_color` (Pastel color), `toned_image` (Toned image), and 142 more.
- Style strength (`style_strength`, number): How closely to follow the style presets or style picture, 1 to 100. From 1 to 100.
- Style reference picture (`style_reference_image`, text): A picture whose look (colors, lighting, mood) to copy. Upload it, pick a file from an earlier step, or give its link or an upload id from 'Upload image'.
- Composition reference picture (`composition_reference_image`, text): A picture whose layout and shapes to follow. Upload it, pick a file from an earlier step, or give its link or an upload id from 'Upload image'.
- Composition strength (`composition_strength`, number): How closely to follow the composition picture, 0 to 100. From 0 to 100.
- Avoid (`negative_prompt`, text): Things to keep out of the picture, such as text or people.
- Visual intensity (`visual_intensity`, number): How strong the contrast, shadows and colors are, 2 to 10. Not for custom models on Image 4. From 2 to 10.
- Wait for it to finish (`wait`, true/false): On (the default), the step waits for Firefly and returns what it made. Off, it returns the job id at once, to collect later with 'Get job'. Default: `true`.

**Outputs**

- `content_type` (text): The first saved file's type
- `document_ref` (text): The first saved file
- `documents` (list): Every picture or video, saved as a file in this workspace
- `error_code` (text): Firefly's error code when the job did not succeed
- `filename` (text): The first saved file's name
- `image_count` (number): How many pictures
- `images` (list): The pictures Firefly made
- `job_id` (text): The Firefly job, for 'Get job' or 'Cancel job'
- `message` (text): Firefly's reason when the job did not succeed
- `progress` (number): How far the job has got, in percent, when Firefly says
- `seed` (number): The seed of the first picture, or of the video
- `size_bytes` (number): The first saved file's size in bytes
- `status` (text): pending, running, succeeded, failed, cancelled, cancel_pending or timeout
- `url` (text): Where Lodol serves the first saved file
- `video_url` (text): Firefly's link to the video it made; it expires after about an hour

**Example output**

```json
{
  "content_type": "image/jpeg",
  "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
  "documents": [
    {
      "content_type": "image/jpeg",
      "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
      "filename": "adobe-firefly-image-1.jpg",
      "size_bytes": 1843201,
      "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678"
    }
  ],
  "error_code": null,
  "filename": "adobe-firefly-image-1.jpg",
  "image_count": 1,
  "images": [
    {
      "seed": 2142812600,
      "url": "https://pre-signed-firefly-prod.s3-accelerate.amazonaws.com/images/0c5c80a3-7189-4bd3-a52e-87b36e4fc47b"
    }
  ],
  "job_id": "urn:ff:jobs:eso851211:86ffe2ea-d765-4bd3-b2fd-568ca8fc36ac",
  "message": null,
  "progress": 100,
  "seed": 2142812600,
  "size_bytes": 1843201,
  "status": "succeeded",
  "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678",
  "video_url": null
}
```

### Generate similar images

Make up to four new pictures like one you give. They are saved as files.

**Inputs**

- Picture (`image`, text, required): The picture to make more like. Upload it, pick a file from an earlier step, or give its link or an upload id from 'Upload image'.
- Model (`model`, text): Which Firefly model makes the pictures. One of: `image4_standard` (Image 4 (default)), `image4_ultra` (Image 4 Ultra: the most detail, takes longer), `image3` (Image 3). Default: `image4_standard`.
- Number of pictures (`number_of_images`, number): How many versions to make, 1 to 4. Defaults to 1. From 1 to 4.
- Size (`size`, text): The pictures' shape and size, in pixels. One of: `2048x2048` (Square, 2048 × 2048 (default)), `2304x1792` (Landscape 4:3, 2304 × 1792), `1792x2304` (Portrait 3:4, 1792 × 2304), `2688x1536` (Widescreen 16:9, 2688 × 1536), `1440x2560` (Tall 9:16, 1440 × 2560), `1024x1024` (Small square, 1024 × 1024), `2688x1512` (Widescreen 16:9, 2688 × 1512), `1344x768` (Wide 7:4, 1344 × 768), `1344x756` (Wide 7:4, 1344 × 756), `1152x896` (Landscape 9:7, 1152 × 896), `896x1152` (Portrait 7:9, 896 × 1152). Default: `2048x2048`.
- Wait for it to finish (`wait`, true/false): On (the default), the step waits for Firefly and returns what it made. Off, it returns the job id at once, to collect later with 'Get job'. Default: `true`.

**Outputs**

- `content_type` (text): The first saved file's type
- `document_ref` (text): The first saved file
- `documents` (list): Every picture or video, saved as a file in this workspace
- `error_code` (text): Firefly's error code when the job did not succeed
- `filename` (text): The first saved file's name
- `image_count` (number): How many pictures
- `images` (list): The pictures Firefly made
- `job_id` (text): The Firefly job, for 'Get job' or 'Cancel job'
- `message` (text): Firefly's reason when the job did not succeed
- `progress` (number): How far the job has got, in percent, when Firefly says
- `seed` (number): The seed of the first picture, or of the video
- `size_bytes` (number): The first saved file's size in bytes
- `status` (text): pending, running, succeeded, failed, cancelled, cancel_pending or timeout
- `url` (text): Where Lodol serves the first saved file
- `video_url` (text): Firefly's link to the video it made; it expires after about an hour

**Example output**

```json
{
  "content_type": "image/jpeg",
  "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
  "documents": [
    {
      "content_type": "image/jpeg",
      "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
      "filename": "adobe-firefly-image-1.jpg",
      "size_bytes": 1843201,
      "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678"
    }
  ],
  "error_code": null,
  "filename": "adobe-firefly-image-1.jpg",
  "image_count": 1,
  "images": [
    {
      "seed": 2142812600,
      "url": "https://pre-signed-firefly-prod.s3-accelerate.amazonaws.com/images/0c5c80a3-7189-4bd3-a52e-87b36e4fc47b"
    }
  ],
  "job_id": "urn:ff:jobs:eso851211:86ffe2ea-d765-4bd3-b2fd-568ca8fc36ac",
  "message": null,
  "progress": 100,
  "seed": 2142812600,
  "size_bytes": 1843201,
  "status": "succeeded",
  "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678",
  "video_url": null
}
```

### Generate video

Make a five-second video from a prompt, optionally starting or ending on a picture you give. The video is saved as a file.

**Inputs**

- Prompt (`prompt`, text, required): Describe the video: what happens, where, and how it looks.
- Size (`size`, text): The video's shape and size, in pixels. One of: `1920x1080` (Widescreen 16:9, 1920 × 1080 (default)), `1280x720` (Widescreen 16:9, 1280 × 720), `960x540` (Widescreen 16:9, 960 × 540), `1080x1920` (Tall 9:16, 1080 × 1920), `720x1280` (Tall 9:16, 720 × 1280), `540x960` (Tall 9:16, 540 × 960), `1080x1080` (Square, 1080 × 1080), `720x720` (Square, 720 × 720), `540x540` (Square, 540 × 540). Default: `1920x1080`.
- First frame (`first_frame`, text): A picture for the video to start on. Upload it, pick a file from an earlier step, or give its link or an upload id from 'Upload image'.
- Last frame (`last_frame`, text): A picture for the video to end on. Upload it, pick a file from an earlier step, or give its link or an upload id from 'Upload image'.
- Camera movement (`camera_motion`, text): How the camera moves. One of: `camera pan left` (Pan left), `camera pan right` (Pan right), `camera zoom in` (Zoom in), `camera zoom out` (Zoom out), `camera tilt up` (Tilt up), `camera tilt down` (Tilt down), `camera locked down` (Locked down (no movement)), `camera handheld` (Handheld).
- Camera angle (`shot_angle`, text): Where the camera looks from. One of: `aerial shot` (Aerial), `eye_level shot` (Eye level), `high angle shot` (High angle), `low angle shot` (Low angle), `top-down shot` (Top down).
- Shot (`shot_size`, text): How close the camera is. One of: `close-up shot` (Close-up), `extreme close-up`, `medium shot` (Medium), `long shot` (Long), `extreme long shot` (Extreme long).
- Style (`style`, text): The video's look. One of: `cinematic`, `anime`, `3d`, `fantasy`, `claymation`, `line art`, `stop motion`, `2d`, `vector art`, `black and white`.
- Wait for it to finish (`wait`, true/false): On (the default), the step waits for Firefly and returns what it made. Off, it returns the job id at once, to collect later with 'Get job'. Default: `true`.

**Outputs**

- `content_type` (text): The first saved file's type
- `document_ref` (text): The first saved file
- `documents` (list): Every picture or video, saved as a file in this workspace
- `error_code` (text): Firefly's error code when the job did not succeed
- `filename` (text): The first saved file's name
- `image_count` (number): How many pictures
- `images` (list): The pictures Firefly made
- `job_id` (text): The Firefly job, for 'Get job' or 'Cancel job'
- `message` (text): Firefly's reason when the job did not succeed
- `progress` (number): How far the job has got, in percent, when Firefly says
- `seed` (number): The seed of the first picture, or of the video
- `size_bytes` (number): The first saved file's size in bytes
- `status` (text): pending, running, succeeded, failed, cancelled, cancel_pending or timeout
- `url` (text): Where Lodol serves the first saved file
- `video_url` (text): Firefly's link to the video it made; it expires after about an hour

**Example output**

```json
{
  "content_type": "video/mp4",
  "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
  "documents": [
    {
      "content_type": "video/mp4",
      "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
      "filename": "adobe-firefly-video.mp4",
      "size_bytes": 6291456,
      "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678"
    }
  ],
  "error_code": null,
  "filename": "adobe-firefly-video.mp4",
  "image_count": 0,
  "images": [],
  "job_id": "urn:ff:jobs:eso851211:86ffe2ea-d765-4bd3-b2fd-568ca8fc36ac",
  "message": null,
  "progress": 100,
  "seed": 1180232,
  "size_bytes": 6291456,
  "status": "succeeded",
  "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678",
  "video_url": "https://pre-signed-firefly-prod.s3.amazonaws.com/videos/5d1f0a7c-2e44-4c55-8b0d-0f9a6e2b7c31"
}
```

### Get job

Check a Firefly job. Once it has succeeded, its pictures or video are saved as files and returned.

**Inputs**

- Job ID (`job_id`, text, required): The Firefly job, from an earlier step's job_id.

**Outputs**

- `content_type` (text): The first saved file's type
- `document_ref` (text): The first saved file
- `documents` (list): Every picture or video, saved as a file in this workspace
- `error_code` (text): Firefly's error code when the job did not succeed
- `filename` (text): The first saved file's name
- `image_count` (number): How many pictures
- `images` (list): The pictures Firefly made
- `job_id` (text): The Firefly job, for 'Get job' or 'Cancel job'
- `message` (text): Firefly's reason when the job did not succeed
- `progress` (number): How far the job has got, in percent, when Firefly says
- `seed` (number): The seed of the first picture, or of the video
- `size_bytes` (number): The first saved file's size in bytes
- `status` (text): pending, running, succeeded, failed, cancelled, cancel_pending or timeout
- `url` (text): Where Lodol serves the first saved file
- `video_url` (text): Firefly's link to the video it made; it expires after about an hour

**Example output**

```json
{
  "content_type": "image/jpeg",
  "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
  "documents": [
    {
      "content_type": "image/jpeg",
      "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
      "filename": "adobe-firefly-image-1.jpg",
      "size_bytes": 1843201,
      "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678"
    }
  ],
  "error_code": null,
  "filename": "adobe-firefly-image-1.jpg",
  "image_count": 1,
  "images": [
    {
      "seed": 2142812600,
      "url": "https://pre-signed-firefly-prod.s3-accelerate.amazonaws.com/images/0c5c80a3-7189-4bd3-a52e-87b36e4fc47b"
    }
  ],
  "job_id": "urn:ff:jobs:eso851211:86ffe2ea-d765-4bd3-b2fd-568ca8fc36ac",
  "message": null,
  "progress": 100,
  "seed": 2142812600,
  "size_bytes": 1843201,
  "status": "succeeded",
  "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678",
  "video_url": null
}
```

### List custom models

List the custom models your organization trained in Firefly and shared with this connection. Gets one page; to see more, run it again starting from the next page it gives.

**Inputs**

- State (`state`, text): Which models to include. One of: `published` (Published (default)), `all`, `ready`, `unpublished`, `queued`, `training`, `failed`, `cancelled`. Default: `published`.
- Order (`sort`, text): How to sort the models. One of: `recently_changed` (Most recently changed first (default)), `newest` (Newest first), `name` (By name, A to Z). Default: `recently_changed`.
- Page size (`limit`, number): How many to return, 1 to 50. Defaults to 20. From 1 to 50.
- Start from (`start`, number): The 'next_start' from an earlier page, to get the page after it. At least 0.

**Outputs**

- `count` (number): How many on this page
- `custom_models` (list): The custom models
- `next_start` (number): Pass as 'Start from' for the next page; empty on the last one
- `total` (number): How many there are in all, when Firefly says

**Example output**

```json
{
  "count": 1,
  "custom_models": [
    {
      "asset_id": "urn:aaid:sc:VA6C2:4b2c1d07-2f1e-4a6b-9a3d-9a7d0f0e1c11",
      "asset_name": "acme-mascot",
      "base_model": "image",
      "base_model_version": "image4_custom",
      "concept_id": "acmebot",
      "created_at": "2026-10-02T14:21:00Z",
      "display_name": "Acme mascot",
      "published_state": "published",
      "sample_prompt": "acmebot waving on a beach",
      "training_mode": "subject",
      "updated_at": "2026-10-03T09:10:00Z",
      "version": "1"
    }
  ],
  "next_start": null,
  "total": 1
}
```

### Place object in a photo

Put an object, such as a product, into a photo you already have, turned and lit to match. The results are saved as files.

**Inputs**

- Photo (`background_image`, text, required): The photo to place the object in. Upload it, pick a file from an earlier step, or give its link or an upload id from 'Upload image'.
- Placement mask (`placement_mask`, text, required): A black-and-white picture the size of the photo, white where the object goes. Upload it, pick a file from an earlier step, or give its link or an upload id from 'Upload image'.
- Object (`object_image`, text, required): The object to place. Upload it, pick a file from an earlier step, or give its link or an upload id from 'Upload image'.
- Object mask (`object_mask`, text): A black-and-white picture, white over the object, when its picture has a background. Upload it, pick a file from an earlier step, or give its link or an upload id from 'Upload image'.
- Match lighting (`match_lighting`, number): How much to change the object's colors and light to match the photo, 0 to 100. Firefly's default is 60. From 0 to 100.
- Shadow strength (`shadow_strength`, number): How strong the object's shadow is, 0 to 100. Firefly's default is 100. From 0 to 100.
- Keep the photo's details (`keep_background_details`, true/false): On keeps what is already in the photo where the object goes. Default: `false`.
- Number of pictures (`number_of_images`, number): How many versions to make, 1 to 3. Defaults to 1. From 1 to 3.
- File type (`output_format`, text): The results' file type. One of: `image/png` (PNG (default)), `image/jpeg` (JPEG), `image/webp` (WebP), `image/jxl` (JPEG XL). Default: `image/png`.
- Wait for it to finish (`wait`, true/false): On (the default), the step waits for Firefly and returns what it made. Off, it returns the job id at once, to collect later with 'Get job'. Default: `true`.

**Outputs**

- `content_type` (text): The first saved file's type
- `document_ref` (text): The first saved file
- `documents` (list): Every picture or video, saved as a file in this workspace
- `error_code` (text): Firefly's error code when the job did not succeed
- `filename` (text): The first saved file's name
- `image_count` (number): How many pictures
- `images` (list): The pictures Firefly made
- `job_id` (text): The Firefly job, for 'Get job' or 'Cancel job'
- `message` (text): Firefly's reason when the job did not succeed
- `progress` (number): How far the job has got, in percent, when Firefly says
- `seed` (number): The seed of the first picture, or of the video
- `size_bytes` (number): The first saved file's size in bytes
- `status` (text): pending, running, succeeded, failed, cancelled, cancel_pending or timeout
- `url` (text): Where Lodol serves the first saved file
- `video_url` (text): Firefly's link to the video it made; it expires after about an hour

**Example output**

```json
{
  "content_type": "image/png",
  "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
  "documents": [
    {
      "content_type": "image/png",
      "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
      "filename": "adobe-firefly-image-1.png",
      "size_bytes": 1843201,
      "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678"
    }
  ],
  "error_code": null,
  "filename": "adobe-firefly-image-1.png",
  "image_count": 1,
  "images": [
    {
      "seed": 2142812600,
      "url": "https://pre-signed-firefly-prod.s3-accelerate.amazonaws.com/images/0c5c80a3-7189-4bd3-a52e-87b36e4fc47b"
    }
  ],
  "job_id": "urn:ff:jobs:eso851211:86ffe2ea-d765-4bd3-b2fd-568ca8fc36ac",
  "message": null,
  "progress": 100,
  "seed": 2142812600,
  "size_bytes": 1843201,
  "status": "succeeded",
  "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678",
  "video_url": null
}
```

### Put product in a new scene

Place a product photo into a scene Firefly makes from a prompt, with matching light and shadows. The product needs a transparent background, a mask, or a result larger than the photo. The results are saved as files.

**Inputs**

- Product photo (`image`, text, required): The product to place. Upload it, pick a file from an earlier step, or give its link or an upload id from 'Upload image'.
- Scene (`prompt`, text, required): Describe the scene to put the product in.
- Product mask (`mask`, text): A black-and-white picture, white over the product, when the photo has no transparent background. Upload it, pick a file from an earlier step, or give its link or an upload id from 'Upload image'.
- Look (`content_class`, text): Whether the result looks like a photo or like art. One of: `auto` (Let Firefly decide (default)), `photo`, `art`. Default: `auto`.
- Size (`size`, text): The result's shape and size, in pixels. One of: `2048x2048` (Square, 2048 × 2048 (default)), `1024x1024` (Small square, 1024 × 1024), `2304x1792` (Landscape 4:3, 2304 × 1792), `1792x2304` (Portrait 3:4, 1792 × 2304), `2688x1536` (Widescreen 16:9, 2688 × 1536), `1344x768` (Wide 7:4, 1344 × 768), `1152x896` (Landscape 9:7, 1152 × 896), `896x1152` (Portrait 7:9, 896 × 1152). Default: `2048x2048`.
- Horizontal position (`horizontal_position`, text): Where the original picture sits across the result. One of: `center` (Center (default)), `left`, `right`. Default: `center`.
- Vertical position (`vertical_position`, text): Where the original picture sits up and down the result. One of: `center` (Center (default)), `top`, `bottom`. Default: `center`.
- Style presets (`style_presets`, list): Styles to apply, such as Watercolor or Golden hour. All chosen apply together. One or more of: `graphic`, `wireframe`, `vector_look` (Vector look), `bw` (Black and white), `cool_colors` (Cool tone), `golden`, `monochromatic`, `muted_color` (Muted color), `pastel_color` (Pastel color), `toned_image` (Toned image), and 142 more.
- Style strength (`style_strength`, number): How closely to follow the style presets or style picture, 1 to 100. From 1 to 100.
- Style reference picture (`style_reference_image`, text): A picture whose look (colors, lighting, mood) to copy. Upload it, pick a file from an earlier step, or give its link or an upload id from 'Upload image'.
- Number of pictures (`number_of_images`, number): How many versions to make, 1 to 4. Defaults to 1. From 1 to 4.
- Wait for it to finish (`wait`, true/false): On (the default), the step waits for Firefly and returns what it made. Off, it returns the job id at once, to collect later with 'Get job'. Default: `true`.

**Outputs**

- `content_type` (text): The first saved file's type
- `document_ref` (text): The first saved file
- `documents` (list): Every picture or video, saved as a file in this workspace
- `error_code` (text): Firefly's error code when the job did not succeed
- `filename` (text): The first saved file's name
- `image_count` (number): How many pictures
- `images` (list): The pictures Firefly made
- `job_id` (text): The Firefly job, for 'Get job' or 'Cancel job'
- `message` (text): Firefly's reason when the job did not succeed
- `progress` (number): How far the job has got, in percent, when Firefly says
- `seed` (number): The seed of the first picture, or of the video
- `size_bytes` (number): The first saved file's size in bytes
- `status` (text): pending, running, succeeded, failed, cancelled, cancel_pending or timeout
- `url` (text): Where Lodol serves the first saved file
- `video_url` (text): Firefly's link to the video it made; it expires after about an hour

**Example output**

```json
{
  "content_type": "image/jpeg",
  "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
  "documents": [
    {
      "content_type": "image/jpeg",
      "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
      "filename": "adobe-firefly-image-1.jpg",
      "size_bytes": 1843201,
      "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678"
    }
  ],
  "error_code": null,
  "filename": "adobe-firefly-image-1.jpg",
  "image_count": 1,
  "images": [
    {
      "seed": 2142812600,
      "url": "https://pre-signed-firefly-prod.s3-accelerate.amazonaws.com/images/0c5c80a3-7189-4bd3-a52e-87b36e4fc47b"
    }
  ],
  "job_id": "urn:ff:jobs:eso851211:86ffe2ea-d765-4bd3-b2fd-568ca8fc36ac",
  "message": null,
  "progress": 100,
  "seed": 2142812600,
  "size_bytes": 1843201,
  "status": "succeeded",
  "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678",
  "video_url": null
}
```

### Upload image

Send a picture to Firefly's storage once, to use its upload id in several steps. The id works for 7 days.

**Inputs**

- Picture (`image`, text, required): Upload it, pick a file from an earlier step, or give its link.

**Outputs**

- `expires_in_days` (number): How many days the id works for
- `upload_id` (text): The upload id, for any picture field

**Example output**

```json
{
  "expires_in_days": 7,
  "upload_id": "0c5c80a3-7189-4bd3-a52e-87b36e4fc47b"
}
```

### Upscale image

Make a picture 2, 3, 4 or 6 times larger while keeping it sharp and true to the original. The result is saved as a file.

**Inputs**

- Picture (`image`, text, required): The picture to make larger. Upload it, pick a file from an earlier step, or give its link or an upload id from 'Upload image'.
- How much larger (`upscale_factor`, text): How many times larger each side becomes. One of: `2` (2 times larger (default)), `3` (3 times larger), `4` (4 times larger), `6` (6 times larger). Default: `2`.
- Wait for it to finish (`wait`, true/false): On (the default), the step waits for Firefly and returns what it made. Off, it returns the job id at once, to collect later with 'Get job'. Default: `true`.

**Outputs**

- `content_type` (text): The first saved file's type
- `document_ref` (text): The first saved file
- `documents` (list): Every picture or video, saved as a file in this workspace
- `error_code` (text): Firefly's error code when the job did not succeed
- `filename` (text): The first saved file's name
- `image_count` (number): How many pictures
- `images` (list): The pictures Firefly made
- `job_id` (text): The Firefly job, for 'Get job' or 'Cancel job'
- `message` (text): Firefly's reason when the job did not succeed
- `progress` (number): How far the job has got, in percent, when Firefly says
- `seed` (number): The seed of the first picture, or of the video
- `size_bytes` (number): The first saved file's size in bytes
- `status` (text): pending, running, succeeded, failed, cancelled, cancel_pending or timeout
- `url` (text): Where Lodol serves the first saved file
- `video_url` (text): Firefly's link to the video it made; it expires after about an hour

**Example output**

```json
{
  "content_type": "image/jpeg",
  "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
  "documents": [
    {
      "content_type": "image/jpeg",
      "document_ref": "doc_8f14e45fceea167a5a36dedd4bea2543",
      "filename": "adobe-firefly-image-1.jpg",
      "size_bytes": 1843201,
      "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678"
    }
  ],
  "error_code": null,
  "filename": "adobe-firefly-image-1.jpg",
  "image_count": 1,
  "images": [
    {
      "seed": null,
      "url": "https://firefly-prod.s3.amazonaws.com/upscale/7e3b5c1a-4b2d-4a8e-9f61-1d2c3b4a5e6f"
    }
  ],
  "job_id": "urn:ff:jobs:eso851211:86ffe2ea-d765-4bd3-b2fd-568ca8fc36ac",
  "message": null,
  "progress": 100,
  "seed": null,
  "size_bytes": 1843201,
  "status": "succeeded",
  "url": "/actions/core/serve-document/doc_8f14e45fceea167a5a36dedd4bea2543?teamId=665f1c2b9a1e4b0012345678",
  "video_url": null
}
```
