Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/livepeer/livepeer-ai-js

JavaScript/Typescript library for the Livepeer AI API.
https://github.com/livepeer/livepeer-ai-js

ai livepeer livepeer-api sdk

Last synced: 3 months ago
JSON representation

JavaScript/Typescript library for the Livepeer AI API.

Awesome Lists containing this project

README 

          
# Livepeer AI JavaScript/TypeScript Library





    

    

        

    




Welcome to the [Livepeer AI](https://livepeer.ai/) JavaScript/TypeScript Library! This library offers a seamless integration with the [Livepeer AI API](https://docs.livepeer.org/ai/api-reference/text-to-image), enabling you to easily incorporate powerful AI capabilities into your JavaScript applications, whether they run in the browser or on the server side.



## SDK Installation



The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.



### NPM



```bash

npm add @livepeer/ai

```



### PNPM



```bash

pnpm add @livepeer/ai

```



### Bun



```bash

bun add @livepeer/ai

```



### Yarn



```bash

yarn add @livepeer/ai zod



# Note that Yarn does not install peer dependencies automatically. You will need

# to install zod as shown above.

```



## Requirements



For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).



## SDK Example Usage



### Example



```typescript

import { Livepeer } from "@livepeer/ai";



const livepeer = new Livepeer({

  httpBearer: "",

});



async function run() {

  const result = await livepeer.generate.textToImage({

    modelId: "",

    loras: "",

    prompt: "",

    height: 576,

    width: 1024,

    guidanceScale: 7.5,

    negativePrompt: "",

    safetyCheck: true,

    numInferenceSteps: 50,

    numImagesPerPrompt: 1,

  });



  // Handle the result

  console.log(result);

}



run();



```



## Available Resources and Operations



Available methods



### [generate](docs/sdks/generate/README.md)



* [textToImage](docs/sdks/generate/README.md#texttoimage) - Text To Image

* [imageToImage](docs/sdks/generate/README.md#imagetoimage) - Image To Image

* [imageToVideo](docs/sdks/generate/README.md#imagetovideo) - Image To Video

* [upscale](docs/sdks/generate/README.md#upscale) - Upscale

* [audioToText](docs/sdks/generate/README.md#audiototext) - Audio To Text

* [segmentAnything2](docs/sdks/generate/README.md#segmentanything2) - Segment Anything 2

* [llm](docs/sdks/generate/README.md#llm) - LLM

* [imageToText](docs/sdks/generate/README.md#imagetotext) - Image To Text

* [liveVideoToVideo](docs/sdks/generate/README.md#livevideotovideo) - Live Video To Video

* [textToSpeech](docs/sdks/generate/README.md#texttospeech) - Text To Speech



## Standalone functions



All the methods listed above are available as standalone functions. These

functions are ideal for use in applications running in the browser, serverless

runtimes or other environments where application bundle size is a primary

concern. When using a bundler to build your application, all unused

functionality will be either excluded from the final bundle or tree-shaken away.



To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).



Available standalone functions



- [`generateAudioToText`](docs/sdks/generate/README.md#audiototext) - Audio To Text

- [`generateImageToImage`](docs/sdks/generate/README.md#imagetoimage) - Image To Image

- [`generateImageToText`](docs/sdks/generate/README.md#imagetotext) - Image To Text

- [`generateImageToVideo`](docs/sdks/generate/README.md#imagetovideo) - Image To Video

- [`generateLiveVideoToVideo`](docs/sdks/generate/README.md#livevideotovideo) - Live Video To Video

- [`generateLlm`](docs/sdks/generate/README.md#llm) - LLM

- [`generateSegmentAnything2`](docs/sdks/generate/README.md#segmentanything2) - Segment Anything 2

- [`generateTextToImage`](docs/sdks/generate/README.md#texttoimage) - Text To Image

- [`generateTextToSpeech`](docs/sdks/generate/README.md#texttospeech) - Text To Speech

- [`generateUpscale`](docs/sdks/generate/README.md#upscale) - Upscale



## File uploads



Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.



> [!TIP]

>

> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

>

> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).

> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.

> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `` element.

> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).



```typescript

import { Livepeer } from "@livepeer/ai";

import { openAsBlob } from "node:fs";



const livepeer = new Livepeer({

  httpBearer: "",

});



async function run() {

  const result = await livepeer.generate.imageToImage({

    image: await openAsBlob("example.file"),

    prompt: "",

    guidanceScale: 7.5,

    imageGuidanceScale: 1.5,

    loras: "",

    modelId: "",

    negativePrompt: "",

    numImagesPerPrompt: 1,

    numInferenceSteps: 100,

    safetyCheck: true,

    strength: 0.8,

  });



  // Handle the result

  console.log(result);

}



run();



```



## Retries



Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.



To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

```typescript

import { Livepeer } from "@livepeer/ai";



const livepeer = new Livepeer({

  httpBearer: "",

});



async function run() {

  const result = await livepeer.generate.textToImage({

    modelId: "",

    loras: "",

    prompt: "",

    height: 576,

    width: 1024,

    guidanceScale: 7.5,

    negativePrompt: "",

    safetyCheck: true,

    numInferenceSteps: 50,

    numImagesPerPrompt: 1,

  }, {

    retries: {

      strategy: "backoff",

      backoff: {

        initialInterval: 1,

        maxInterval: 50,

        exponent: 1.1,

        maxElapsedTime: 100,

      },

      retryConnectionErrors: false,

    },

  });



  // Handle the result

  console.log(result);

}



run();



```



If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

```typescript

import { Livepeer } from "@livepeer/ai";



const livepeer = new Livepeer({

  retryConfig: {

    strategy: "backoff",

    backoff: {

      initialInterval: 1,

      maxInterval: 50,

      exponent: 1.1,

      maxElapsedTime: 100,

    },

    retryConnectionErrors: false,

  },

  httpBearer: "",

});



async function run() {

  const result = await livepeer.generate.textToImage({

    modelId: "",

    loras: "",

    prompt: "",

    height: 576,

    width: 1024,

    guidanceScale: 7.5,

    negativePrompt: "",

    safetyCheck: true,

    numInferenceSteps: 50,

    numImagesPerPrompt: 1,

  });



  // Handle the result

  console.log(result);

}



run();



```



## Error Handling



Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `textToImage` method may throw the following errors:



| Error Type                 | Status Code | Content Type     |

| -------------------------- | ----------- | ---------------- |

| errors.HTTPError           | 400, 401    | application/json |

| errors.HTTPValidationError | 422         | application/json |

| errors.HTTPError           | 500         | application/json |

| errors.SDKError            | 4XX, 5XX    | \*/\*            |



If the method throws an error and it is not captured by the known errors, it will default to throwing a `SDKError`.



```typescript

import { Livepeer } from "@livepeer/ai";

import {

  HTTPError,

  HTTPValidationError,

  SDKValidationError,

} from "@livepeer/ai/models/errors";



const livepeer = new Livepeer({

  httpBearer: "",

});



async function run() {

  let result;

  try {

    result = await livepeer.generate.textToImage({

      modelId: "",

      loras: "",

      prompt: "",

      height: 576,

      width: 1024,

      guidanceScale: 7.5,

      negativePrompt: "",

      safetyCheck: true,

      numInferenceSteps: 50,

      numImagesPerPrompt: 1,

    });



    // Handle the result

    console.log(result);

  } catch (err) {

    switch (true) {

      // The server response does not match the expected SDK schema

      case (err instanceof SDKValidationError): {

        // Pretty-print will provide a human-readable multi-line error message

        console.error(err.pretty());

        // Raw value may also be inspected

        console.error(err.rawValue);

        return;

      }

      case (err instanceof HTTPError): {

        // Handle err.data$: HTTPErrorData

        console.error(err);

        return;

      }

      case (err instanceof HTTPValidationError): {

        // Handle err.data$: HTTPValidationErrorData

        console.error(err);

        return;

      }

      case (err instanceof HTTPError): {

        // Handle err.data$: HTTPErrorData

        console.error(err);

        return;

      }

      default: {

        // Other errors such as network errors, see HTTPClientErrors for more details

        throw err;

      }

    }

  }

}



run();



```



Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.



In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:



| HTTP Client Error                                    | Description                                          |

| ---------------------------------------------------- | ---------------------------------------------------- |

| RequestAbortedError                                  | HTTP request was aborted by the client               |

| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |

| ConnectionError                                      | HTTP client was unable to make a request to a server |

| InvalidRequestError                                  | Any input used to create a request is invalid        |

| UnexpectedClientError                                | Unrecognised or unexpected error                     |



## Server Selection



### Select Server by Index



You can override the default server globally by passing a server index to the `serverIdx: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:



| #   | Server                                      |

| --- | ------------------------------------------- |

| 0   | `https://dream-gateway.livepeer.cloud`      |

| 1   | `https://livepeer.studio/api/beta/generate` |



#### Example



```typescript

import { Livepeer } from "@livepeer/ai";



const livepeer = new Livepeer({

  serverIdx: 1,

  httpBearer: "",

});



async function run() {

  const result = await livepeer.generate.textToImage({

    modelId: "",

    loras: "",

    prompt: "",

    height: 576,

    width: 1024,

    guidanceScale: 7.5,

    negativePrompt: "",

    safetyCheck: true,

    numInferenceSteps: 50,

    numImagesPerPrompt: 1,

  });



  // Handle the result

  console.log(result);

}



run();



```



### Override Server URL Per-Client



The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:

```typescript

import { Livepeer } from "@livepeer/ai";



const livepeer = new Livepeer({

  serverURL: "https://dream-gateway.livepeer.cloud",

  httpBearer: "",

});



async function run() {

  const result = await livepeer.generate.textToImage({

    modelId: "",

    loras: "",

    prompt: "",

    height: 576,

    width: 1024,

    guidanceScale: 7.5,

    negativePrompt: "",

    safetyCheck: true,

    numInferenceSteps: 50,

    numImagesPerPrompt: 1,

  });



  // Handle the result

  console.log(result);

}



run();



```



## Custom HTTP Client



The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native

[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This

client is a thin wrapper around `fetch` and provides the ability to attach hooks

around the request lifecycle that can be used to modify the request or handle

errors and response.



The `HTTPClient` constructor takes an optional `fetcher` argument that can be

used to integrate a third-party HTTP client or when writing tests to mock out

the HTTP client and feed in fixtures.



The following example shows how to use the `"beforeRequest"` hook to to add a

custom header and a timeout to requests and how to use the `"requestError"` hook

to log errors:



```typescript

import { Livepeer } from "@livepeer/ai";

import { HTTPClient } from "@livepeer/ai/lib/http";



const httpClient = new HTTPClient({

  // fetcher takes a function that has the same signature as native `fetch`.

  fetcher: (request) => {

    return fetch(request);

  }

});



httpClient.addHook("beforeRequest", (request) => {

  const nextRequest = new Request(request, {

    signal: request.signal || AbortSignal.timeout(5000)

  });



  nextRequest.headers.set("x-custom-header", "custom value");



  return nextRequest;

});



httpClient.addHook("requestError", (error, request) => {

  console.group("Request Error");

  console.log("Reason:", `${error}`);

  console.log("Endpoint:", `${request.method} ${request.url}`);

  console.groupEnd();

});



const sdk = new Livepeer({ httpClient });

```



## Authentication



### Per-Client Security Schemes



This SDK supports the following security scheme globally:



| Name         | Type | Scheme      |

| ------------ | ---- | ----------- |

| `httpBearer` | http | HTTP Bearer |



To authenticate with the API the `httpBearer` parameter must be set when initializing the SDK client instance. For example:

```typescript

import { Livepeer } from "@livepeer/ai";



const livepeer = new Livepeer({

  httpBearer: "",

});



async function run() {

  const result = await livepeer.generate.textToImage({

    modelId: "",

    loras: "",

    prompt: "",

    height: 576,

    width: 1024,

    guidanceScale: 7.5,

    negativePrompt: "",

    safetyCheck: true,

    numInferenceSteps: 50,

    numImagesPerPrompt: 1,

  });



  // Handle the result

  console.log(result);

}



run();



```



## Debugging



You can setup your SDK to emit debug logs for SDK requests and responses.



You can pass a logger that matches `console`'s interface as an SDK option.



> [!WARNING]

> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.



```typescript

import { Livepeer } from "@livepeer/ai";



const sdk = new Livepeer({ debugLogger: console });

```



## Summary



Livepeer AI Runner: An application to run AI pipelines



## Table of Contents



* [Livepeer AI JavaScript/TypeScript Library](#livepeer-ai-javascripttypescript-library)

  * [SDK Installation](#sdk-installation)

  * [Requirements](#requirements)

  * [SDK Example Usage](#sdk-example-usage)

  * [Available Resources and Operations](#available-resources-and-operations)

  * [Standalone functions](#standalone-functions)

  * [File uploads](#file-uploads)

  * [Retries](#retries)

  * [Error Handling](#error-handling)

  * [Server Selection](#server-selection)

  * [Custom HTTP Client](#custom-http-client)

  * [Authentication](#authentication)

  * [Debugging](#debugging)

* [Development](#development)

  * [Maturity](#maturity)

  * [Contributions](#contributions)



# Development



## Maturity



This SDK is in **alpha**, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.



## Contributions



While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a [PR](https://github.com/livepeer/livepeer-ai-js/compare) or [an issue](https://github.com/livepeer/livepeer-ai-js/issues) with a proof of concept and we'll do our best to include it in a future release.



### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=livepeer-ai&utm_campaign=typescript)