✨ NEW: Turn Prompts into Pro Video with Kling 2.5
DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Product Photoshoot Image to Image

easel-ai/product-photoshoot
Create product advertisements with an example image of the product
Inference
Commercial use
Partner
PlaygroundAPI

About

Shoot

1. Calling the API#

Install the client#

The client provides a convenient way to interact with the model API.

npm install --save @fal-ai/client

Setup your API Key#

Set FAL_KEY as an environment variable in your runtime.

export FAL_KEY="YOUR_API_KEY"

Submit a request#

The client API handles the API submit protocol. It will handle the request status updates and return the result when the request is completed.

import { fal } from "@fal-ai/client";

const result = await fal.subscribe("easel-ai/product-photoshoot", {
  input: {
    product_image: "https://images.easelai.com/product/special-k.webp",
    scene: "an image with a cheerful young boy sitting at a wooden kitchen table, wearing a bright blue sweatshirt, eating cereal from a white bowl with a spoon.",
    product_placement: "on a silver tray on the left side of the image"
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});
console.log(result.data);
console.log(result.requestId);

2. Authentication#

The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.

API Key#

In case your app is running in an environment where you cannot set environment variables, you can set the API Key manually as a client configuration.
import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

3. Queue#

Submit a request#

The client API provides a convenient way to submit requests to the model.

import { fal } from "@fal-ai/client";

const { request_id } = await fal.queue.submit("easel-ai/product-photoshoot", {
  input: {
    product_image: "https://images.easelai.com/product/special-k.webp",
    scene: "an image with a cheerful young boy sitting at a wooden kitchen table, wearing a bright blue sweatshirt, eating cereal from a white bowl with a spoon.",
    product_placement: "on a silver tray on the left side of the image"
  },
  webhookUrl: "https://optional.webhook.url/for/results",
});

Fetch request status#

You can fetch the status of a request to check if it is completed or still in progress.

import { fal } from "@fal-ai/client";

const status = await fal.queue.status("easel-ai/product-photoshoot", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
  logs: true,
});

Get the result#

Once the request is completed, you can fetch the result. See the Output Schema for the expected result format.

import { fal } from "@fal-ai/client";

const result = await fal.queue.result("easel-ai/product-photoshoot", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);

4. Files#

Some attributes in the API accept file URLs as input. Whenever that's the case you can pass your own URL or a Base64 data URI.

Data URI (base64)#

You can pass a Base64 data URI as a file input. The API will handle the file decoding for you. Keep in mind that for large files, this alternative although convenient can impact the request performance.

Hosted files (URL)#

You can also pass your own URLs as long as they are publicly accessible. Be aware that some hosts might block cross-site requests, rate-limit, or consider the request as a bot.

Uploading files#

We provide a convenient file storage that allows you to upload files and use them in your requests. You can upload files using the client API and use the returned URL in your requests.

import { fal } from "@fal-ai/client";

const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

Read more about file handling in our file upload guide.

5. Schema#

Input#

product_image Image* required

An image of the product to be featured in the photoshoot.

product_description string

A brief description of the product. Default value: ""

scene string* required

Description of the scene in which the product is placed. (Minimum 64 characters.)

product_placement string* required

Describe how the product is placed in the scene.

magic_blend_enabled boolean

Enable Magic Blend to enhance the integration of the product into the scene. Default value: true

output_format OutputFormatEnum

The desired output format for the generated image. Default value: "4:3"

Possible enum values: 1:1 (2k), 4:3, 16:9, 9:16, 1:1 (1k, Turbo)

{
  "product_image": "https://images.easelai.com/product/special-k.webp",
  "product_description": "a box of cereal.",
  "scene": "an image with a cheerful young boy sitting at a wooden kitchen table, wearing a bright blue sweatshirt, eating cereal from a white bowl with a spoon.",
  "product_placement": "on a silver tray on the left side of the image",
  "magic_blend_enabled": true,
  "output_format": "4:3"
}

Output#

image Image* required

The resulting image of the product in the scene.

{
  "image": {
    "url": "https://images.easelai.com/product/product_photshoot_demo.jpg"
  }
}

Other types#

Image#

url string* required

The URL where the file can be downloaded from.

content_type string

The mime type of the file.

file_name string

The name of the file. It will be auto-generated if not provided.

file_size integer

The size of the file in bytes.

file_data string

File data

width integer

The width of the image in pixels.

height integer

The height of the image in pixels.