Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/Leonardo-Interactive/leonardo-ts-sdk

Typescript SDK for Leonardo AI
https://github.com/Leonardo-Interactive/leonardo-ts-sdk
Last synced: 7 days ago
JSON representation
Typescript SDK for Leonardo AI
Host: GitHub
URL: https://github.com/Leonardo-Interactive/leonardo-ts-sdk
Owner: Leonardo-Interactive
License: mit
Created: 2023-02-14T21:23:38.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-04-22T23:01:54.000Z (7 months ago)
Last Synced: 2024-04-23T09:21:13.543Z (7 months ago)
Language: TypeScript
Size: 1.53 MB
Stars: 47
Watchers: 9
Forks: 13
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project

README

        


   

   Leonardo Typescript SDK

   The API for creating stunning game assets with AI.

   

   

   



## Summary

Rest Endpoints: Leonardo.Ai API OpenAPI specification.

## Table of Contents

* [SDK Installation](#sdk-installation)

* [Requirements](#requirements)

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

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

* [Standalone functions](#standalone-functions)

* [Retries](#retries)

* [Error Handling](#error-handling)

* [Server Selection](#server-selection)

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

* [Authentication](#authentication)

* [Debugging](#debugging)

## 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 @leonardo-ai/sdk

```

### PNPM

```bash

pnpm add @leonardo-ai/sdk

```

### Bun

```bash

bun add @leonardo-ai/sdk

```

### Yarn

```bash

yarn add @leonardo-ai/sdk zod

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

# to install zod as shown above.

```

## Authentication

To get access to the API and fetch an API key, please sign up for [access](https://leonardo.ai/). 

## SDK Example Usage

### Example

```typescript

import { Leonardo } from "@leonardo-ai/sdk";

const leonardo = new Leonardo({

  bearerAuth: "",

});

async function run() {

  const result = await leonardo.initImages.deleteInitImageById("");

  // Handle the result

  console.log(result);

}

run();

```

## Available Resources and Operations

Available methods

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

* [createDataset](docs/sdks/dataset/README.md#createdataset) - Create a Dataset

* [deleteDatasetById](docs/sdks/dataset/README.md#deletedatasetbyid) - Delete a Single Dataset by ID

* [getDatasetById](docs/sdks/dataset/README.md#getdatasetbyid) - Get a Single Dataset by ID

* [uploadDatasetImage](docs/sdks/dataset/README.md#uploaddatasetimage) - Upload dataset image

* [uploadDatasetImageFromGen](docs/sdks/dataset/README.md#uploaddatasetimagefromgen) - Upload a Single Generated Image to a Dataset

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

* [listElements](docs/sdks/elements/README.md#listelements) - List Elements

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

* [createGeneration](docs/sdks/image/README.md#creategeneration) - Create a Generation of Images

* [deleteGenerationById](docs/sdks/image/README.md#deletegenerationbyid) - Delete a Single Generation

* [getGenerationById](docs/sdks/image/README.md#getgenerationbyid) - Get a Single Generation

* [getGenerationsByUserId](docs/sdks/image/README.md#getgenerationsbyuserid) - Get generations by user ID

### [initImages](docs/sdks/initimages/README.md)

* [deleteInitImageById](docs/sdks/initimages/README.md#deleteinitimagebyid) - Delete init image

* [getInitImageById](docs/sdks/initimages/README.md#getinitimagebyid) - Get single init image

* [uploadCanvasInitImage](docs/sdks/initimages/README.md#uploadcanvasinitimage) - Upload Canvas Editor init and mask image

* [uploadInitImage](docs/sdks/initimages/README.md#uploadinitimage) - Upload init image

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

* [createModel](docs/sdks/models/README.md#createmodel) - Train a Custom Model

* [deleteModelById](docs/sdks/models/README.md#deletemodelbyid) - Delete a Single Custom Model by ID

* [getModelById](docs/sdks/models/README.md#getmodelbyid) - Get a Single Custom Model by ID

* [listPlatformModels](docs/sdks/models/README.md#listplatformmodels) - List Platform Models

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

* [createSVDMotionGeneration](docs/sdks/motion/README.md#createsvdmotiongeneration) - Create SVD Motion Generation

### [pricingCalculator](docs/sdks/pricingcalculator/README.md)

* [pricingCalculator](docs/sdks/pricingcalculator/README.md#pricingcalculator) - Calculating API Cost

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

* [promptImprove](docs/sdks/prompt/README.md#promptimprove) - Improve a Prompt

* [promptRandom](docs/sdks/prompt/README.md#promptrandom) - Generate a Random prompt

### [realtimeCanvas](docs/sdks/realtimecanvas/README.md)

* [createLCMGeneration](docs/sdks/realtimecanvas/README.md#createlcmgeneration) - Create LCM Generation

* [performAlchemyUpscaleLCM](docs/sdks/realtimecanvas/README.md#performalchemyupscalelcm) - Perform Alchemy Upscale on a LCM image

* [performInpaintingLCM](docs/sdks/realtimecanvas/README.md#performinpaintinglcm) - Perform inpainting on a LCM image

* [performInstantRefine](docs/sdks/realtimecanvas/README.md#performinstantrefine) - Perform instant refine on a LCM image

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

* [createTextureGeneration](docs/sdks/texture/README.md#createtexturegeneration) - Create Texture Generation

* [deleteTextureGenerationById](docs/sdks/texture/README.md#deletetexturegenerationbyid) - Delete Texture Generation by ID

### [threeDModelAssets](docs/sdks/threedmodelassets/README.md)

* [delete3DModelById](docs/sdks/threedmodelassets/README.md#delete3dmodelbyid) - Delete 3D Model by ID

* [uploadModelAsset](docs/sdks/threedmodelassets/README.md#uploadmodelasset) - Upload 3D Model

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

* [getUserSelf](docs/sdks/user/README.md#getuserself) - Get user information

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

* [createUniversalUpscalerJob](docs/sdks/variation/README.md#createuniversalupscalerjob) - Create using Universal Upscaler

* [createVariationNoBG](docs/sdks/variation/README.md#createvariationnobg) - Create no background

* [createVariationUnzoom](docs/sdks/variation/README.md#createvariationunzoom) - Create unzoom

* [createVariationUpscale](docs/sdks/variation/README.md#createvariationupscale) - Create upscale

* [getVariationById](docs/sdks/variation/README.md#getvariationbyid) - Get variation by ID

## Error Handling

All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.

If a HTTP request fails, an operation my also throw an error from the `sdk/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                     |

In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `deleteInitImageById` method may throw the following errors:

| Error Type      | Status Code     | Content Type    |

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

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

```typescript

import { Leonardo } from "@leonardo-ai/sdk";

import { SDKValidationError } from "@leonardo-ai/sdk/sdk/models/errors";

const leonardo = new Leonardo({

  bearerAuth: "",

});

async function run() {

  let result;

  try {

    result = await leonardo.initImages.deleteInitImageById("");

    // Handle the result

    console.log(result);

  } catch (err) {

    switch (true) {

      case (err instanceof SDKValidationError): {

        // Validation errors can be pretty-printed

        console.error(err.pretty());

        // Raw value may also be inspected

        console.error(err.rawValue);

        return;

      }

      default: {

        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 string since validation errors can list many issues and the plain error string may be difficult read when debugging.

## 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 { Leonardo } from "@leonardo-ai/sdk";

import { HTTPClient } from "@leonardo-ai/sdk/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 Leonardo({ httpClient });

```

## Server Selection

### Select Server by Index

You can override the default server globally by passing a server index to the `serverIdx` 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 | Variables |

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

| 0 | `https://cloud.leonardo.ai/api/rest/v1` | None |

```typescript

import { Leonardo } from "@leonardo-ai/sdk";

const leonardo = new Leonardo({

  serverIdx: 0,

  bearerAuth: "",

});

async function run() {

  const result = await leonardo.initImages.deleteInitImageById("");

  // 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` optional parameter when initializing the SDK client instance. For example:

```typescript

import { Leonardo } from "@leonardo-ai/sdk";

const leonardo = new Leonardo({

  serverURL: "https://cloud.leonardo.ai/api/rest/v1",

  bearerAuth: "",

});

async function run() {

  const result = await leonardo.initImages.deleteInitImageById("");

  // Handle the result

  console.log(result);

}

run();

```

## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name         | Type         | Scheme       |

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

| `bearerAuth` | http         | HTTP Bearer  |

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

```typescript

import { Leonardo } from "@leonardo-ai/sdk";

const leonardo = new Leonardo({

  bearerAuth: "",

});

async function run() {

  const result = await leonardo.initImages.deleteInitImageById("");

  // Handle the result

  console.log(result);

}

run();

```

## Requirements

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

## 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

- [`datasetCreateDataset`](docs/sdks/dataset/README.md#createdataset) - Create a Dataset

- [`datasetDeleteDatasetById`](docs/sdks/dataset/README.md#deletedatasetbyid) - Delete a Single Dataset by ID

- [`datasetGetDatasetById`](docs/sdks/dataset/README.md#getdatasetbyid) - Get a Single Dataset by ID

- [`datasetUploadDatasetImage`](docs/sdks/dataset/README.md#uploaddatasetimage) - Upload dataset image

- [`datasetUploadDatasetImageFromGen`](docs/sdks/dataset/README.md#uploaddatasetimagefromgen) - Upload a Single Generated Image to a Dataset

- [`elementsListElements`](docs/sdks/elements/README.md#listelements) - List Elements

- [`imageCreateGeneration`](docs/sdks/image/README.md#creategeneration) - Create a Generation of Images

- [`imageDeleteGenerationById`](docs/sdks/image/README.md#deletegenerationbyid) - Delete a Single Generation

- [`imageGetGenerationById`](docs/sdks/image/README.md#getgenerationbyid) - Get a Single Generation

- [`imageGetGenerationsByUserId`](docs/sdks/image/README.md#getgenerationsbyuserid) - Get generations by user ID

- [`initImagesDeleteInitImageById`](docs/sdks/initimages/README.md#deleteinitimagebyid) - Delete init image

- [`initImagesGetInitImageById`](docs/sdks/initimages/README.md#getinitimagebyid) - Get single init image

- [`initImagesUploadCanvasInitImage`](docs/sdks/initimages/README.md#uploadcanvasinitimage) - Upload Canvas Editor init and mask image

- [`initImagesUploadInitImage`](docs/sdks/initimages/README.md#uploadinitimage) - Upload init image

- [`modelsCreateModel`](docs/sdks/models/README.md#createmodel) - Train a Custom Model

- [`modelsDeleteModelById`](docs/sdks/models/README.md#deletemodelbyid) - Delete a Single Custom Model by ID

- [`modelsGetModelById`](docs/sdks/models/README.md#getmodelbyid) - Get a Single Custom Model by ID

- [`modelsListPlatformModels`](docs/sdks/models/README.md#listplatformmodels) - List Platform Models

- [`motionCreateSVDMotionGeneration`](docs/sdks/motion/README.md#createsvdmotiongeneration) - Create SVD Motion Generation

- [`pricingCalculatorPricingCalculator`](docs/sdks/pricingcalculator/README.md#pricingcalculator) - Calculating API Cost

- [`promptPromptImprove`](docs/sdks/prompt/README.md#promptimprove) - Improve a Prompt

- [`promptPromptRandom`](docs/sdks/prompt/README.md#promptrandom) - Generate a Random prompt

- [`realtimeCanvasCreateLCMGeneration`](docs/sdks/realtimecanvas/README.md#createlcmgeneration) - Create LCM Generation

- [`realtimeCanvasPerformAlchemyUpscaleLCM`](docs/sdks/realtimecanvas/README.md#performalchemyupscalelcm) - Perform Alchemy Upscale on a LCM image

- [`realtimeCanvasPerformInpaintingLCM`](docs/sdks/realtimecanvas/README.md#performinpaintinglcm) - Perform inpainting on a LCM image

- [`realtimeCanvasPerformInstantRefine`](docs/sdks/realtimecanvas/README.md#performinstantrefine) - Perform instant refine on a LCM image

- [`textureCreateTextureGeneration`](docs/sdks/texture/README.md#createtexturegeneration) - Create Texture Generation

- [`textureDeleteTextureGenerationById`](docs/sdks/texture/README.md#deletetexturegenerationbyid) - Delete Texture Generation by ID

- [`threeDModelAssetsDelete3DModelById`](docs/sdks/threedmodelassets/README.md#delete3dmodelbyid) - Delete 3D Model by ID

- [`threeDModelAssetsUploadModelAsset`](docs/sdks/threedmodelassets/README.md#uploadmodelasset) - Upload 3D Model

- [`userGetUserSelf`](docs/sdks/user/README.md#getuserself) - Get user information

- [`variationCreateUniversalUpscalerJob`](docs/sdks/variation/README.md#createuniversalupscalerjob) - Create using Universal Upscaler

- [`variationCreateVariationNoBG`](docs/sdks/variation/README.md#createvariationnobg) - Create no background

- [`variationCreateVariationUnzoom`](docs/sdks/variation/README.md#createvariationunzoom) - Create unzoom

- [`variationCreateVariationUpscale`](docs/sdks/variation/README.md#createvariationupscale) - Create upscale

- [`variationGetVariationById`](docs/sdks/variation/README.md#getvariationbyid) - Get variation by ID

## 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 { Leonardo } from "@leonardo-ai/sdk";

const leonardo = new Leonardo({

  bearerAuth: "",

});

async function run() {

  const result = await leonardo.initImages.deleteInitImageById("", {

    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 { Leonardo } from "@leonardo-ai/sdk";

const leonardo = new Leonardo({

  retryConfig: {

    strategy: "backoff",

    backoff: {

      initialInterval: 1,

      maxInterval: 50,

      exponent: 1.1,

      maxElapsedTime: 100,

    },

    retryConnectionErrors: false,

  },

  bearerAuth: "",

});

async function run() {

  const result = await leonardo.initImages.deleteInitImageById("");

  // 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 { Leonardo } from "@leonardo-ai/sdk";

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

```

### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)