Summary

Rest Endpoints: Leonardo.Ai API OpenAPI specification.

Table of Contents

• SDK Installation
• Requirements
• SDK Example Usage
• Available Resources and Operations
• Standalone functions
• Retries
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication
• Debugging

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @leonardo-ai/sdk

PNPM

pnpm add @leonardo-ai/sdk

Bun

bun add @leonardo-ai/sdk

Yarn

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.

SDK Example Usage

Example

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

const leonardo = new Leonardo({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await leonardo.initImages.deleteInitImageById("<id>");

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

run();

Available Resources and Operations

dataset

• createDataset - Create a Dataset
• deleteDatasetById - Delete a Single Dataset by ID
• getDatasetById - Get a Single Dataset by ID
• uploadDatasetImage - Upload dataset image
• uploadDatasetImageFromGen - Upload a Single Generated Image to a Dataset

elements

• listElements - List Elements

image

• createGeneration - Create a Generation of Images
• deleteGenerationById - Delete a Single Generation
• getGenerationById - Get a Single Generation
• getGenerationsByUserId - Get generations by user ID

initImages

• deleteInitImageById - Delete init image
• getInitImageById - Get single init image
• uploadCanvasInitImage - Upload Canvas Editor init and mask image
• uploadInitImage - Upload init image

models

• createModel - Train a Custom Model
• deleteModelById - Delete a Single Custom Model by ID
• getModelById - Get a Single Custom Model by ID
• listPlatformModels - List Platform Models

motion

• createSVDMotionGeneration - Create SVD Motion Generation

pricingCalculator

• pricingCalculator - Calculating API Cost

prompt

• promptImprove - Improve a Prompt
• promptRandom - Generate a Random prompt

realtimeCanvas

• createLCMGeneration - Create LCM Generation
• performAlchemyUpscaleLCM - Perform Alchemy Upscale on a LCM image
• performInpaintingLCM - Perform inpainting on a LCM image
• performInstantRefine - Perform instant refine on a LCM image

texture

• createTextureGeneration - Create Texture Generation
• deleteTextureGenerationById - Delete Texture Generation by ID

threeDModelAssets

• delete3DModelById - Delete 3D Model by ID
• uploadModelAsset - Upload 3D Model

user

• getUserSelf - Get user information

variation

• createUniversalUpscalerJob - Create using Universal Upscaler
• createVariationNoBG - Create no background
• createVariationUnzoom - Create unzoom
• createVariationUpscale - Create upscale
• 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 | */* |

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

const leonardo = new Leonardo({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  let result;
  try {
    result = await leonardo.initImages.deleteInitImageById("<id>");

    // 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. 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:

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 |

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

const leonardo = new Leonardo({
  serverIdx: 0,
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await leonardo.initImages.deleteInitImageById("<id>");

  // 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:

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

const leonardo = new Leonardo({
  serverURL: "https://cloud.leonardo.ai/api/rest/v1",
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await leonardo.initImages.deleteInitImageById("<id>");

  // 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:

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

const leonardo = new Leonardo({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await leonardo.initImages.deleteInitImageById("<id>");

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

run();

Requirements

For supported JavaScript runtimes, please consult 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.

• datasetCreateDataset - Create a Dataset
• datasetDeleteDatasetById - Delete a Single Dataset by ID
• datasetGetDatasetById - Get a Single Dataset by ID
• datasetUploadDatasetImage - Upload dataset image
• datasetUploadDatasetImageFromGen - Upload a Single Generated Image to a Dataset
• elementsListElements - List Elements
• imageCreateGeneration - Create a Generation of Images
• imageDeleteGenerationById - Delete a Single Generation
• imageGetGenerationById - Get a Single Generation
• imageGetGenerationsByUserId - Get generations by user ID
• initImagesDeleteInitImageById - Delete init image
• initImagesGetInitImageById - Get single init image
• initImagesUploadCanvasInitImage - Upload Canvas Editor init and mask image
• initImagesUploadInitImage - Upload init image
• modelsCreateModel - Train a Custom Model
• modelsDeleteModelById - Delete a Single Custom Model by ID
• modelsGetModelById - Get a Single Custom Model by ID
• modelsListPlatformModels - List Platform Models
• motionCreateSVDMotionGeneration - Create SVD Motion Generation
• pricingCalculatorPricingCalculator - Calculating API Cost
• promptPromptImprove - Improve a Prompt
• promptPromptRandom - Generate a Random prompt
• realtimeCanvasCreateLCMGeneration - Create LCM Generation
• realtimeCanvasPerformAlchemyUpscaleLCM - Perform Alchemy Upscale on a LCM image
• realtimeCanvasPerformInpaintingLCM - Perform inpainting on a LCM image
• realtimeCanvasPerformInstantRefine - Perform instant refine on a LCM image
• textureCreateTextureGeneration - Create Texture Generation
• textureDeleteTextureGenerationById - Delete Texture Generation by ID
• threeDModelAssetsDelete3DModelById - Delete 3D Model by ID
• threeDModelAssetsUploadModelAsset - Upload 3D Model
• userGetUserSelf - Get user information
• variationCreateUniversalUpscalerJob - Create using Universal Upscaler
• variationCreateVariationNoBG - Create no background
• variationCreateVariationUnzoom - Create unzoom
• variationCreateVariationUpscale - Create upscale
• variationGetVariationById - 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:

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

const leonardo = new Leonardo({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await leonardo.initImages.deleteInitImageById("<id>", {
    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:

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: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await leonardo.initImages.deleteInitImageById("<id>");

  // 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.

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

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

SDK Generated by Speakeasy