POST
/
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.imageToText({
    image: await openAsBlob("example.file"),
    prompt: "",
    modelId: "",
  });

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

run();
{
  "text": "<string>"
}

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-text 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
​
image
file
required

Uploaded image to transform with the pipeline.

​
model_id
string
default:
required

Hugging Face model ID used for transformation.

​
prompt
string
default:

Text prompt(s) to guide transformation.

Response

200
application/json
Successful Response

Response model for text generation.

​
text
string
required

The generated text.

Was this page helpful?

Suggest editsRaise issue
Image To ImageImage To Video