(generate)
- textToImage - Text To Image
- imageToImage - Image To Image
- imageToVideo - Image To Video
- upscale - Upscale
- audioToText - Audio To Text
- segmentAnything2 - Segment Anything 2
- llm - LLM
- imageToText - Image To Text
- liveVideoToVideo - Live Video To Video
- textToSpeech - Text To Speech
Generate images from text prompts.
import { Livepeer } from "@livepeer/ai";
const livepeer = new Livepeer({
httpBearer: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await livepeer.generate.textToImage({
prompt: "<value>",
});
// Handle the result
console.log(result);
}
run();
The standalone function version of this method:
import { LivepeerCore } from "@livepeer/ai/core.js";
import { generateTextToImage } from "@livepeer/ai/funcs/generateTextToImage.js";
// Use `LivepeerCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const livepeer = new LivepeerCore({
httpBearer: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await generateTextToImage(livepeer, {
prompt: "<value>",
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
components.TextToImageParams | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<operations.GenTextToImageResponse>
Error Type | Status Code | Content Type |
---|---|---|
errors.HTTPError | 400, 401, 500 | application/json |
errors.HTTPValidationError | 422 | application/json |
errors.SDKError | 4XX, 5XX | */* |
Apply image transformations to a provided 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({
image: await openAsBlob("example.file"),
prompt: "<value>",
});
// Handle the result
console.log(result);
}
run();
The standalone function version of this method:
import { LivepeerCore } from "@livepeer/ai/core.js";
import { generateImageToImage } from "@livepeer/ai/funcs/generateImageToImage.js";
import { openAsBlob } from "node:fs";
// Use `LivepeerCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const livepeer = new LivepeerCore({
httpBearer: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await generateImageToImage(livepeer, {
image: await openAsBlob("example.file"),
prompt: "<value>",
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
components.BodyGenImageToImage | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<operations.GenImageToImageResponse>
Error Type | Status Code | Content Type |
---|---|---|
errors.HTTPError | 400, 401, 500 | application/json |
errors.HTTPValidationError | 422 | application/json |
errors.SDKError | 4XX, 5XX | */* |
Generate a video from a provided 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.imageToVideo({
image: await openAsBlob("example.file"),
});
// Handle the result
console.log(result);
}
run();
The standalone function version of this method:
import { LivepeerCore } from "@livepeer/ai/core.js";
import { generateImageToVideo } from "@livepeer/ai/funcs/generateImageToVideo.js";
import { openAsBlob } from "node:fs";
// Use `LivepeerCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const livepeer = new LivepeerCore({
httpBearer: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await generateImageToVideo(livepeer, {
image: await openAsBlob("example.file"),
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
components.BodyGenImageToVideo | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<operations.GenImageToVideoResponse>
Error Type | Status Code | Content Type |
---|---|---|
errors.HTTPError | 400, 401, 500 | application/json |
errors.HTTPValidationError | 422 | application/json |
errors.SDKError | 4XX, 5XX | */* |
Upscale an image by increasing its resolution.
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({
image: await openAsBlob("example.file"),
prompt: "<value>",
});
// Handle the result
console.log(result);
}
run();
The standalone function version of this method:
import { LivepeerCore } from "@livepeer/ai/core.js";
import { generateUpscale } from "@livepeer/ai/funcs/generateUpscale.js";
import { openAsBlob } from "node:fs";
// Use `LivepeerCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const livepeer = new LivepeerCore({
httpBearer: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await generateUpscale(livepeer, {
image: await openAsBlob("example.file"),
prompt: "<value>",
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
components.BodyGenUpscale | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<operations.GenUpscaleResponse>
Error Type | Status Code | Content Type |
---|---|---|
errors.HTTPError | 400, 401, 500 | application/json |
errors.HTTPValidationError | 422 | application/json |
errors.SDKError | 4XX, 5XX | */* |
Transcribe audio files 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.audioToText({
audio: await openAsBlob("example.file"),
});
// Handle the result
console.log(result);
}
run();
The standalone function version of this method:
import { LivepeerCore } from "@livepeer/ai/core.js";
import { generateAudioToText } from "@livepeer/ai/funcs/generateAudioToText.js";
import { openAsBlob } from "node:fs";
// Use `LivepeerCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const livepeer = new LivepeerCore({
httpBearer: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await generateAudioToText(livepeer, {
audio: await openAsBlob("example.file"),
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
components.BodyGenAudioToText | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<operations.GenAudioToTextResponse>
Error Type | Status Code | Content Type |
---|---|---|
errors.HTTPError | 400, 401, 413, 415, 500 | application/json |
errors.HTTPValidationError | 422 | application/json |
errors.SDKError | 4XX, 5XX | */* |
Segment objects in an 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.segmentAnything2({
image: await openAsBlob("example.file"),
});
// Handle the result
console.log(result);
}
run();
The standalone function version of this method:
import { LivepeerCore } from "@livepeer/ai/core.js";
import { generateSegmentAnything2 } from "@livepeer/ai/funcs/generateSegmentAnything2.js";
import { openAsBlob } from "node:fs";
// Use `LivepeerCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const livepeer = new LivepeerCore({
httpBearer: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await generateSegmentAnything2(livepeer, {
image: await openAsBlob("example.file"),
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
components.BodyGenSegmentAnything2 | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<operations.GenSegmentAnything2Response>
Error Type | Status Code | Content Type |
---|---|---|
errors.HTTPError | 400, 401, 500 | application/json |
errors.HTTPValidationError | 422 | application/json |
errors.SDKError | 4XX, 5XX | */* |
Generate text using a language model.
import { Livepeer } from "@livepeer/ai";
const livepeer = new Livepeer({
httpBearer: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await livepeer.generate.llm({
prompt: "<value>",
});
// Handle the result
console.log(result);
}
run();
The standalone function version of this method:
import { LivepeerCore } from "@livepeer/ai/core.js";
import { generateLlm } from "@livepeer/ai/funcs/generateLlm.js";
// Use `LivepeerCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const livepeer = new LivepeerCore({
httpBearer: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await generateLlm(livepeer, {
prompt: "<value>",
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
components.BodyGenLLM | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<operations.GenLLMResponse>
Error Type | Status Code | Content Type |
---|---|---|
errors.HTTPError | 400, 401, 500 | application/json |
errors.HTTPValidationError | 422 | application/json |
errors.SDKError | 4XX, 5XX | */* |
Transform image files 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"),
});
// Handle the result
console.log(result);
}
run();
The standalone function version of this method:
import { LivepeerCore } from "@livepeer/ai/core.js";
import { generateImageToText } from "@livepeer/ai/funcs/generateImageToText.js";
import { openAsBlob } from "node:fs";
// Use `LivepeerCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const livepeer = new LivepeerCore({
httpBearer: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await generateImageToText(livepeer, {
image: await openAsBlob("example.file"),
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
components.BodyGenImageToText | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<operations.GenImageToTextResponse>
Error Type | Status Code | Content Type |
---|---|---|
errors.HTTPError | 400, 401, 413, 500 | application/json |
errors.HTTPValidationError | 422 | application/json |
errors.SDKError | 4XX, 5XX | */* |
Apply transformations to a live video streamed to the returned endpoints.
import { Livepeer } from "@livepeer/ai";
const livepeer = new Livepeer({
httpBearer: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await livepeer.generate.liveVideoToVideo({
subscribeUrl: "https://soulful-lava.org/",
publishUrl: "https://vain-tabletop.biz",
});
// Handle the result
console.log(result);
}
run();
The standalone function version of this method:
import { LivepeerCore } from "@livepeer/ai/core.js";
import { generateLiveVideoToVideo } from "@livepeer/ai/funcs/generateLiveVideoToVideo.js";
// Use `LivepeerCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const livepeer = new LivepeerCore({
httpBearer: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await generateLiveVideoToVideo(livepeer, {
subscribeUrl: "https://soulful-lava.org/",
publishUrl: "https://vain-tabletop.biz",
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
components.LiveVideoToVideoParams | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<operations.GenLiveVideoToVideoResponse>
Error Type | Status Code | Content Type |
---|---|---|
errors.HTTPError | 400, 401, 500 | application/json |
errors.HTTPValidationError | 422 | application/json |
errors.SDKError | 4XX, 5XX | */* |
Generate a text-to-speech audio file based on the provided text input and speaker description.
import { Livepeer } from "@livepeer/ai";
const livepeer = new Livepeer({
httpBearer: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await livepeer.generate.textToSpeech({});
// Handle the result
console.log(result);
}
run();
The standalone function version of this method:
import { LivepeerCore } from "@livepeer/ai/core.js";
import { generateTextToSpeech } from "@livepeer/ai/funcs/generateTextToSpeech.js";
// Use `LivepeerCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const livepeer = new LivepeerCore({
httpBearer: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await generateTextToSpeech(livepeer, {});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
Parameter | Type | Required | Description |
---|---|---|---|
request |
components.TextToSpeechParams | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<operations.GenTextToSpeechResponse>
Error Type | Status Code | Content Type |
---|---|---|
errors.HTTPError | 400, 401, 500 | application/json |
errors.HTTPValidationError | 422 | application/json |
errors.SDKError | 4XX, 5XX | */* |