Image To Image - Livepeer Docs

POST

image-to-image

import { Livepeer } from "@livepeer/ai";
import { openAsBlob } from "node:fs";

const livepeer = new Livepeer({
  httpBearer: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await livepeer.generate.imageToImage({
    prompt: "<value>",
    image: await openAsBlob("example.file"),
    modelId: "",
    loras: "",
    strength: 0.8,
    guidanceScale: 7.5,
    imageGuidanceScale: 1.5,
    negativePrompt: "",
    safetyCheck: true,
    numInferenceSteps: 100,
    numImagesPerPrompt: 1,
  });

  // Handle the result
  console.log(result);
}

run();

{
  "images": [
    {
      "url": "<string>",
      "seed": 123,
      "nsfw": true
    }
  ]
}

The default Gateway used in this guide is the public Livepeer.cloud Gateway. It is free to use but not intended for production-ready applications. For production-ready applications, consider using the Livepeer Studio Gateway, which requires an API token. Alternatively, you can set up your own Gateway node or partner with one via the ai-video channel on Discord.

Please note that the exact parameters, default values, and responses may vary between models. For more information on model-specific parameters, please refer to the respective model documentation available in the image-to-image pipeline. Not all parameters might be available for a given model.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data

prompt

string

required

Text prompt(s) to guide image generation.

image

file

required

Uploaded image to modify with the pipeline.

model_id

string

default:

required

Hugging Face model ID used for image generation.

loras

string

default:

A LoRA (Low-Rank Adaptation) model and its corresponding weight for image generation. Example: { "latent-consistency/lcm-lora-sdxl": 1.0, "nerijs/pixel-art-xl": 1.2}.

strength

number

default:

0.8

Degree of transformation applied to the reference image (0 to 1).

guidance_scale

number

default:

7.5

Encourages model to generate images closely linked to the text prompt (higher values may reduce image quality).

image_guidance_scale

number

default:

1.5

Degree to which the generated image is pushed towards the initial image.

negative_prompt

string

default:

Text prompt(s) to guide what to exclude from image generation. Ignored if guidance_scale < 1.

safety_check

boolean

default:

true

Perform a safety check to estimate if generated images could be offensive or harmful.

seed

integer

Seed for random number generation.

num_inference_steps

integer

default:

100

Number of denoising steps. More steps usually lead to higher quality images but slower inference. Modulated by strength.

num_images_per_prompt

integer

default:

Number of images to generate per prompt.

Response

200

application/json

Successful Response

Response model for image generation.

images

object[]

required

The generated images.

Was this page helpful?

Suggest edits Raise issue

Audio To Text Image To Text

import { Livepeer } from "@livepeer/ai";
import { openAsBlob } from "node:fs";

const livepeer = new Livepeer({
  httpBearer: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await livepeer.generate.imageToImage({
    prompt: "<value>",
    image: await openAsBlob("example.file"),
    modelId: "",
    loras: "",
    strength: 0.8,
    guidanceScale: 7.5,
    imageGuidanceScale: 1.5,
    negativePrompt: "",
    safetyCheck: true,
    numInferenceSteps: 100,
    numImagesPerPrompt: 1,
  });

  // Handle the result
  console.log(result);
}

run();

{
  "images": [
    {
      "url": "<string>",
      "seed": 123,
      "nsfw": true
    }
  ]
}

AI Video

Authorizations

Body

Response