pip install Leonardo-Ai-SDKimport leonardoaisdk
from leonardoaisdk.models import operations
s = leonardoaisdk.LeonardoAiSDK(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
req = operations.CreateDatasetRequestBody(
name='<value>',
)
res = s.dataset.create_dataset(req)
if res.object is not None:
# handle response
pass- create_dataset - Create a Dataset
- delete_dataset_by_id - Delete a Single Dataset by ID
- get_dataset_by_id - Get a Single Dataset by ID
- upload_dataset_image - Upload dataset image
- upload_dataset_image_from_gen - Upload a Single Generated Image to a Dataset
- list_elements - List Elements
- create_generation - Create a Generation of Images
- create_lcm_generation - Create LCM Generation
- create_svd_motion_generation - Create SVD Motion Generation
- create_texture_generation - Create Texture Generation
- delete_generation_by_id - Delete a Single Generation
- delete_texture_generation_by_id - Delete Texture Generation by ID
- get_generation_by_id - Get a Single Generation
- get_generations_by_user_id - Get generations by user ID
- get_texture_generation_by_id - Get Texture Generation by ID
- get_texture_generations_by_model_id - Get texture generations by 3D Model ID
- perform_alchemy_upscale_lcm - Perform Alchemy Upscale on a LCM image
- perform_inpainting_lcm - Perform inpainting on a LCM image
- perform_instant_refine - Perform instant refine on a LCM image
- delete_init_image_by_id - Delete init image
- get_init_image_by_id - Get single init image
- upload_init_image - Upload init image
- get_user_self - Get user information
- create_model - Train a Custom Model
- delete3_d_model_by_id - Delete 3D Model by ID
- delete_model_by_id - Delete a Single Custom Model by ID
- get3_d_model_by_id - Get 3D Model by ID
- get3_d_models_by_user_id - Get 3D models by user ID
- get_model_by_id - Get a Single Custom Model by ID
- list_platform_models - List Platform Models
- upload_model_asset - Upload 3D Model
- prompt_improve - Improve a Prompt
- prompt_random - Generate a Random prompt
- create_variation_no_bg - Create no background
- create_variation_unzoom - Create unzoom
- create_variation_upscale - Create upscale
- get_variation_by_id - Get variation by ID
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
| Error Object | Status Code | Content Type |
|---|---|---|
| errors.SDKError | 4xx-5xx | / |
import leonardoaisdk
from leonardoaisdk.models import errors, operations
s = leonardoaisdk.LeonardoAiSDK(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
req = operations.CreateDatasetRequestBody(
name='<value>',
)
res = None
try:
res = s.dataset.create_dataset(req)
except errors.SDKError as e:
# handle exception
raise(e)
if res.object is not None:
# handle response
passThe Python SDK makes API calls using the requests HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom requests.Session object.
For example, you could specify a header for every request that this sdk makes as follows:
import leonardoaisdk
import requests
http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = leonardoaisdk.LeonardoAiSDK(client=http_client)You can override the default server globally by passing a server index to the server_idx: int 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 leonardoaisdk
from leonardoaisdk.models import operations
s = leonardoaisdk.LeonardoAiSDK(
server_idx=0,
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
req = operations.CreateDatasetRequestBody(
name='<value>',
)
res = s.dataset.create_dataset(req)
if res.object is not None:
# handle response
passThe default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:
import leonardoaisdk
from leonardoaisdk.models import operations
s = leonardoaisdk.LeonardoAiSDK(
server_url="https://cloud.leonardo.ai/api/rest/v1",
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
req = operations.CreateDatasetRequestBody(
name='<value>',
)
res = s.dataset.create_dataset(req)
if res.object is not None:
# handle response
passThis SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
bearer_auth |
http | HTTP Bearer |
To authenticate with the API the bearer_auth parameter must be set when initializing the SDK client instance. For example:
import leonardoaisdk
from leonardoaisdk.models import operations
s = leonardoaisdk.LeonardoAiSDK(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
req = operations.CreateDatasetRequestBody(
name='<value>',
)
res = s.dataset.create_dataset(req)
if res.object is not None:
# handle response
passThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !