@leonardo-ai/sdk
Advanced tools
Leonardo Typescript SDK The API for creating stunning game assets with AI. <a hre
The API for creating stunning game assets with AI.
Rest Endpoints: Leonardo.Ai API OpenAPI specification.
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add @leonardo-ai/sdk
pnpm add @leonardo-ai/sdk
bun add @leonardo-ai/sdk
yarn add @leonardo-ai/sdk zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
To get access to the API and fetch an API key, please sign up for access.
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();
If the request fails due to, for example 4XX or 5XX status codes, it will throw a SDKError.
| 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) {
// 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;
}
sdkerror.js;
// Server returned an error status code or an unknown content type
case (err instanceof SDKError): {
console.error(err.statusCode);
console.error(err.rawResponse.body);
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 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 |
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 });
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:
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();
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();
For supported JavaScript runtimes, please consult RUNTIMES.md.
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 DatasetdatasetDeleteDatasetById - Delete a Single Dataset by IDdatasetGetDatasetById - Get a Single Dataset by IDdatasetUploadDatasetImage - Upload dataset imagedatasetUploadDatasetImageFromGen - Upload a Single Generated Image to a DatasetelementsCreateElement - Train a Custom ElementelementsDeleteElementById - Delete a Single Custom Element by IDelementsGetCustomElementsByUserId - Get a list of Custom Elements by User IDelementsGetElementById - Get a Single Custom Element by IDelementsListElements - List ElementsimageCreateGeneration - Create a Generation of ImagesimageDeleteGenerationById - Delete a Single GenerationimageGetGenerationById - Get a Single GenerationimageGetGenerationsByUserId - Get generations by user IDinitImagesDeleteInitImageById - Delete init imageinitImagesGetInitImageById - Get single init imageinitImagesUploadCanvasInitImage - Upload Canvas Editor init and mask imageinitImagesUploadInitImage - Upload init imagemodelsCreateModel - Train a Custom ModelmodelsDeleteModelById - Delete a Single Custom Model by IDmodelsGetCustomModelsByUserId - Get a list of Custom Models by User IDmodelsGetModelById - Get a Single Custom Model by IDmodelsListPlatformModels - List Platform ModelsmotionCreateSVDMotionGeneration - Create SVD Motion GenerationpricingCalculatorPricingCalculator - Calculating API CostpromptPromptImprove - Improve a PromptpromptPromptRandom - Generate a Random promptrealtimeCanvasCreateLCMGeneration - Create LCM GenerationrealtimeCanvasPerformAlchemyUpscaleLCM - Perform Alchemy Upscale on a LCM imagerealtimeCanvasPerformInpaintingLCM - Perform inpainting on a LCM imagerealtimeCanvasPerformInstantRefine - Perform instant refine on a LCM imagetextureCreateTextureGeneration - Create Texture GenerationtextureDeleteTextureGenerationById - Delete Texture Generation by IDthreeDModelAssetsDelete3DModelById - Delete 3D Model by IDthreeDModelAssetsUploadModelAsset - Upload 3D ModeluserGetUserSelf - Get user informationvariationCreateUniversalUpscalerJob - Create using Universal UpscalervariationCreateVariationNoBG - Create no backgroundvariationCreateVariationUnzoom - Create unzoomvariationCreateVariationUpscale - Create upscalevariationGetVariationById - Get variation by IDSome 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();
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 });
FAQs
Leonardo Typescript SDK The API for creating stunning game assets with AI. <a hre
The npm package @leonardo-ai/sdk receives a total of 3,613 weekly downloads. As such, @leonardo-ai/sdk popularity was classified as popular.
We found that @leonardo-ai/sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
A flawed sandbox in @nestjs/devtools-integration lets attackers run code on your machine via CSRF, leading to full Remote Code Execution (RCE).
Product
Customize license detection with Socket’s new license overlays: gain control, reduce noise, and handle edge cases with precision.
Product
Socket now supports Rust and Cargo, offering package search for all users and experimental SBOM generation for enterprise projects.