Skip to content

Leonardo-Interactive/leonardo-ts-sdk

BranchesTags

Repository files navigation

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

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

Available methods

ThreeDModelAssets

Blueprints

Dataset

Elements

Image

InitImages

Media

Models

Motion

PricingCalculator

Prompt

RealtimeCanvas

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:

Less common errors (6)

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.

Available standalone functions

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

About

Typescript SDK for Leonardo AI

Resources

Readme

License

MIT license

Contributing

Contributing
Activity
Custom properties

Stars

55 stars

Watchers

10 watching

Forks

21 forks
Report repository

Releases 137

typescript - v4.21.3 - 2026-04-21 05:04:27 Latest
Apr 21, 2026
+ 136 releases

Packages

 
 
 

Contributors

Languages