PhotoMaker Image to Image
About
Generate Image
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
Migrate to @fal-ai/client
The @fal-ai/serverless-client
package has been deprecated in favor of @fal-ai/client
. Please check the migration guide for more information.
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("fal-ai/photomaker", {
input: {
image_archive_url: "https://storage.googleapis.com/falserverless/model_tests/photomaker/elon.zip",
prompt: "instagram photo, portrait photo of a man img, colorful, perfect face, natural skin, hard shadows, film grain"
},
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#
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_KEY"
});
Protect your API Key
When running code on the client-side (e.g. in a browser, mobile app or GUI applications), make sure to not expose your FAL_KEY
. Instead, use a server-side proxy to make requests to the API. For more information, check out our server-side integration guide.
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("fal-ai/photomaker", {
input: {
image_archive_url: "https://storage.googleapis.com/falserverless/model_tests/photomaker/elon.zip",
prompt: "instagram photo, portrait photo of a man img, colorful, perfect face, natural skin, hard shadows, film grain"
},
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("fal-ai/photomaker", {
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("fal-ai/photomaker", {
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);
Auto uploads
The client will auto-upload the file for you if you pass a binary object (e.g. File
, Data
).
Read more about file handling in our file upload guide.
5. Schema#
Input#
image_archive_url
string
* requiredThe URL of the image archive containing the images you want to use.
prompt
string
* requiredThe prompt to use for generating the image. Be as descriptive as possible for best results.
base_pipeline
BasePipelineEnum
The base pipeline to use for generating the image. Default value: "photomaker"
Possible enum values: photomaker, photomaker-style
initial_image_url
string
Optional initial image for img2img
initial_image_strength
float
How much noise to add to the latent image. O for no noise, 1 for maximum noise. Default value: 0.5
style
StyleEnum
Default value: "Photographic"
Possible enum values: (No style), Cinematic, Disney Character, Digital Art, Photographic, Fantasy art, Neonpunk, Enhance, Comic book, Lowpoly, Line art
negative_prompt
string
The negative prompt to use.Use it to address details that you don't want
in the image. This could be colors, objects, scenery and even the small details
(e.g. moustache, blurry, low resolution). Default value: ""
num_inference_steps
integer
Increasing the amount of steps tells Stable Diffusion that it should take more steps
to generate your final result which can increase the amount of detail in your image. Default value: 50
style_strength
integer
Default value: 20
num_images
integer
Number of images to generate in one request. Note that the higher the batch size,
the longer it will take to generate the images. Default value: 1
guidance_scale
float
The CFG (Classifier Free Guidance) scale is a measure of how close you want
the model to stick to your prompt when looking for a related image to show you. Default value: 5
seed
integer
The same seed and the same prompt given to the same version of Stable Diffusion will output the same image every time.
{
"image_archive_url": "https://storage.googleapis.com/falserverless/model_tests/photomaker/elon.zip",
"prompt": "instagram photo, portrait photo of a man img, colorful, perfect face, natural skin, hard shadows, film grain",
"base_pipeline": "photomaker",
"initial_image_strength": 0.5,
"style": "Photographic",
"negative_prompt": "nsfw, lowres, bad anatomy, bad hands, text, error, missing fingers, extra digit, fewer digits, cropped, worst quality, low quality, normal quality, jpeg artifacts, signature, watermark, username, blurry",
"num_inference_steps": 50,
"style_strength": 20,
"num_images": 1,
"guidance_scale": 5,
"seed": 42
}
Output#
seed
integer
* required{
"images": [
{
"file_size": 1785567,
"height": 1024,
"file_name": "87374b9db2b74f5792839b19d9b29a9a.png",
"content_type": "image/png",
"url": "https://storage.googleapis.com/falserverless/model_tests/photomaker/elon-output.png",
"width": 1024
}
]
}
Other types#
Image#
url
string
* requiredThe 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.
width
integer
The width of the image in pixels.
height
integer
The height of the image in pixels.