DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Easel Avatar Text to Image

easel-ai/easel-avatar
Create scenes with one or two people using just selfies and text prompt (without LoRAs)
Inference
Commercial use
Partner
PlaygroundAPIExamples

About

Avatar

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/easel-avatar", {
  input: {
    face_image_0: "https://images.easelai.com/avatar_fal/male/male.png",
    gender_0: "male",
    prompt: "at the Met Gala, dressed in very fancy outfits, captured in a full body shot"
  },
  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/easel-avatar", {
  input: {
    face_image_0: "https://images.easelai.com/avatar_fal/male/male.png",
    gender_0: "male",
    prompt: "at the Met Gala, dressed in very fancy outfits, captured in a full body shot"
  },
  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/easel-avatar", {
  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/easel-avatar", {
  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#

face_image_0 Image* required

The face image with which the scene is generated.

gender_0 UsergenderEnum* required

The gender of the person in the face image

Possible enum values: male, female, non-binary

face_image_1 Image

(Optional) The second face image used to generate a two-person scene.

gender_1 SecondusergenderEnum

The gender of the person in the second face image Default value: "female"

Possible enum values: male, female, non-binary

prompt string* required

The prompt to generate the scene

style OutputStyleEnum

The style of the generated image. Hyperrealistic: more photorealistic and aesthetic, better text rendering; Realistic: photorealistic, better text rendering. Stylistic: softer, more artistic Default value: "hyperRealistic"

Possible enum values: hyperRealistic, realistic, stylistic

{
  "face_image_0": "https://images.easelai.com/avatar_fal/male/male.png",
  "gender_0": "male",
  "face_image_1": "https://images.easelai.com/avatar_fal/female/female.png",
  "gender_1": "female",
  "prompt": "at the Met Gala, dressed in very fancy outfits, captured in a full body shot",
  "style": "hyperRealistic"
}

Output#

image Image* required

The generated avatar image

{
  "image": {
    "url": "https://images.easelai.com/avatars_example.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.