npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@leonardo-ai/sdk

v4.21.1

Published

<div align="center"> <img src="https://user-images.githubusercontent.com/6267663/230025738-42a4980e-a5ea-4d00-a591-65e8de14de85.png" width="200"> <h1>Leonardo Typescript SDK</h1> <p>The API for creating stunning game assets with AI.</p> <a hre

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

leonardo-peterleonardo-peterndimaresndimaressilvamarcelsilvamarcel

Keywords

Readme

Summary

Rest Endpoints: Leonardo.Ai API OpenAPI specification.

Table of Contents

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

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";
import { SettingName } from "@leonardo-ai/sdk/sdk/models/shared";

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

async function run() {
  const result = await leonardo.blueprints.executeBlueprint({
    blueprintVersionId: "550e8400-e29b-41d4-a716-446655440000",
    input: {
      collectionIds: [],
      nodeInputs: [
        {
          nodeId: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          settingName: SettingName.Text,
          value: "A futuristic cityscape at sunset",
        },
        {
          nodeId: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
          settingName: SettingName.TextVariables,
          value: [
            {
              name: "characterName",
              value: "Luna",
            },
            {
              name: "outfit",
              value: "cyberpunk armor",
            },
          ],
        },
        {
          nodeId: "c3d4e5f6-a7b8-9012-cdef-123456789012",
          settingName: SettingName.ImageUrl,
          value: "https://cdn.leonardo.ai/users/example/image.png",
        },
      ],
      public: false,
    },
  });

  console.log(result);
}

run();

Available Resources and Operations

ThreeDModelAssets

Blueprints

Dataset

Elements

Image

InitImages

Models

Motion

PricingCalculator

Prompt

RealtimeCanvas

Texture

User

Variation

Error Handling

LeonardoError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | ------------------------------------------------------ | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response |

Example

import { Leonardo } from "@leonardo-ai/sdk";
import * as errors from "@leonardo-ai/sdk/sdk/models/errors";
import { SettingName } from "@leonardo-ai/sdk/sdk/models/shared";

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

async function run() {
  try {
    const result = await leonardo.blueprints.executeBlueprint({
      blueprintVersionId: "550e8400-e29b-41d4-a716-446655440000",
      input: {
        collectionIds: [],
        nodeInputs: [
          {
            nodeId: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            settingName: SettingName.Text,
            value: "A futuristic cityscape at sunset",
          },
          {
            nodeId: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
            settingName: SettingName.TextVariables,
            value: [
              {
                name: "characterName",
                value: "Luna",
              },
              {
                name: "outfit",
                value: "cyberpunk armor",
              },
            ],
          },
          {
            nodeId: "c3d4e5f6-a7b8-9012-cdef-123456789012",
            settingName: SettingName.ImageUrl,
            value: "https://cdn.leonardo.ai/users/example/image.png",
          },
        ],
        public: false,
      },
    });

    console.log(result);
  } catch (error) {
    if (error instanceof errors.LeonardoError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

Network errors:

Inherit from LeonardoError:

  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

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:

  • route requests through a proxy server using undici's ProxyAgent
  • use the "beforeRequest" hook to add a custom header and a timeout to requests
  • use the "requestError" hook to log errors
import { Leonardo } from "@leonardo-ai/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@leonardo-ai/sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

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: httpClient });

Server Selection

Override Server URL Per-Client

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

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

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

async function run() {
  const result = await leonardo.blueprints.executeBlueprint({
    blueprintVersionId: "550e8400-e29b-41d4-a716-446655440000",
    input: {
      collectionIds: [],
      nodeInputs: [
        {
          nodeId: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          settingName: SettingName.Text,
          value: "A futuristic cityscape at sunset",
        },
        {
          nodeId: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
          settingName: SettingName.TextVariables,
          value: [
            {
              name: "characterName",
              value: "Luna",
            },
            {
              name: "outfit",
              value: "cyberpunk armor",
            },
          ],
        },
        {
          nodeId: "c3d4e5f6-a7b8-9012-cdef-123456789012",
          settingName: SettingName.ImageUrl,
          value: "https://cdn.leonardo.ai/users/example/image.png",
        },
      ],
      public: false,
    },
  });

  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";
import { SettingName } from "@leonardo-ai/sdk/sdk/models/shared";

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

async function run() {
  const result = await leonardo.blueprints.executeBlueprint({
    blueprintVersionId: "550e8400-e29b-41d4-a716-446655440000",
    input: {
      collectionIds: [],
      nodeInputs: [
        {
          nodeId: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          settingName: SettingName.Text,
          value: "A futuristic cityscape at sunset",
        },
        {
          nodeId: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
          settingName: SettingName.TextVariables,
          value: [
            {
              name: "characterName",
              value: "Luna",
            },
            {
              name: "outfit",
              value: "cyberpunk armor",
            },
          ],
        },
        {
          nodeId: "c3d4e5f6-a7b8-9012-cdef-123456789012",
          settingName: SettingName.ImageUrl,
          value: "https://cdn.leonardo.ai/users/example/image.png",
        },
      ],
      public: false,
    },
  });

  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.

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";
import { SettingName } from "@leonardo-ai/sdk/sdk/models/shared";

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

async function run() {
  const result = await leonardo.blueprints.executeBlueprint({
    blueprintVersionId: "550e8400-e29b-41d4-a716-446655440000",
    input: {
      collectionIds: [],
      nodeInputs: [
        {
          nodeId: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          settingName: SettingName.Text,
          value: "A futuristic cityscape at sunset",
        },
        {
          nodeId: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
          settingName: SettingName.TextVariables,
          value: [
            {
              name: "characterName",
              value: "Luna",
            },
            {
              name: "outfit",
              value: "cyberpunk armor",
            },
          ],
        },
        {
          nodeId: "c3d4e5f6-a7b8-9012-cdef-123456789012",
          settingName: SettingName.ImageUrl,
          value: "https://cdn.leonardo.ai/users/example/image.png",
        },
      ],
      public: false,
    },
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  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";
import { SettingName } from "@leonardo-ai/sdk/sdk/models/shared";

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.blueprints.executeBlueprint({
    blueprintVersionId: "550e8400-e29b-41d4-a716-446655440000",
    input: {
      collectionIds: [],
      nodeInputs: [
        {
          nodeId: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          settingName: SettingName.Text,
          value: "A futuristic cityscape at sunset",
        },
        {
          nodeId: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
          settingName: SettingName.TextVariables,
          value: [
            {
              name: "characterName",
              value: "Luna",
            },
            {
              name: "outfit",
              value: "cyberpunk armor",
            },
          ],
        },
        {
          nodeId: "c3d4e5f6-a7b8-9012-cdef-123456789012",
          settingName: SettingName.ImageUrl,
          value: "https://cdn.leonardo.ai/users/example/image.png",
        },
      ],
      public: false,
    },
  });

  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