@leonardo-ai/sdk v4.10.1
SDK Installation
NPM
npm 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";
const leonardo = new Leonardo({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await leonardo.dataset.createDataset({
name: "<value>",
});
// 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
element
- listElements - List Elements
generation
- createGeneration - Create a Generation of Images
- createLCMGeneration - Create LCM Generation
- createSVDMotionGeneration - Create SVD Motion Generation
- createTextureGeneration - Create Texture Generation
- deleteGenerationById - Delete a Single Generation
- deleteTextureGenerationById - Delete Texture Generation by ID
- getGenerationById - Get a Single Generation
- getGenerationsByUserId - Get generations by user ID
- performAlchemyUpscaleLCM - Perform Alchemy Upscale on a LCM image
- performInpaintingLCM - Perform inpainting on a LCM image
- performInstantRefine - Perform instant refine on a LCM image
initImage
- deleteInitImageById - Delete init image
- getInitImageById - Get single init image
- uploadInitImage - Upload init image
user
- getUserSelf - Get user information
model
- createModel - Train a Custom Model
- delete3DModelById - Delete 3D Model by ID
- deleteModelById - Delete a Single Custom Model by ID
- getModelById - Get a Single Custom Model by ID
- listPlatformModels - List Platform Models
- uploadModelAsset - Upload 3D Model
prompt
- promptImprove - Improve a Prompt
- promptRandom - Generate a Random prompt
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. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
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.
import { Leonardo } from "@leonardo-ai/sdk";
import * as errors 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.dataset.createDataset({
name: "<value>",
});
} catch (err) {
switch (true) {
case err instanceof errors.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;
}
}
}
// Handle the result
console.log(result);
}
run();
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.dataset.createDataset({
name: "<value>",
});
// 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.dataset.createDataset({
name: "<value>",
});
// 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.dataset.createDataset({
name: "<value>",
});
// Handle the result
console.log(result);
}
run();
Requirements
For supported JavaScript runtimes, please consult RUNTIMES.md.
SDK Generated by Speakeasy
7 days ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
9 months ago
8 months ago
9 months ago
8 months ago
8 months ago
8 months ago
6 months ago
7 months ago
6 months ago
6 months ago
8 months ago
8 months ago
7 months ago
7 months ago
7 months ago
11 months ago
7 months ago
11 months ago
10 months ago
10 months ago
9 months ago
11 months ago
12 months ago
11 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago