Skip to main content
POST
/
upscale
TypeScript
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.upscale({
    prompt: "<value>",
    image: await openAsBlob("example.file"),
    modelId: "",
    safetyCheck: true,
    numInferenceSteps: 75,
  });

  // 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 upscaling 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 upscaled image generation.

​
image
file
required

Uploaded image to modify with the pipeline.

​
model_id
string
default:""
required

Hugging Face model ID used for upscaled image generation.

​
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:75

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

Response

Successful Response

Response model for image generation.

​
images
Media · object[]
required

The generated images.