Leonardo AI Python Client SDK
Project description
Leonardo-Ai-SDK
SDK Installation
pip install Leonardo-Ai-SDK
SDK Example Usage
import leonardoaisdk
from leonardoaisdk.models import operations
s = leonardoaisdk.LeonardoAiSDK(
bearer_auth="",
)
req = operations.CreateDatasetRequestBody(
name='string',
)
res = s.dataset.create_dataset(req)
if res.object is not None:
# handle response
pass
Available Resources and Operations
dataset
- 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
element
- get_elements - List Elements
generation
- create_generation - Create a Generation of Images
- delete_generation_by_id - Delete a Single Generation
- delete_generations_texture_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_generations_texture_model_model_id_ - Get texture generations by 3D Model ID
- get_generations_texture_id_ - Get Texture Generation by ID
- post_generations_texture - Create Texture Generation
init_image
- delete_init_image_by_id - Delete init image
- get_init_image_by_id - Get single init image
- upload_init_image - Upload init image
user
- get_user_self - Get user information
model
- create_model - Train a Custom Model
- delete_model_by_id - Delete a Single Custom Model by ID
- delete_models_3d_id_ - Delete 3D Model by ID
- get_model_by_id - Get a Single Custom Model by ID
- get_models_3d_user_user_id_ - Get 3D models by user ID
- get_models_3d_id_ - Get 3D Model by ID
- get_platform_models - List Platform Models
- post_models_3d_upload - Upload 3D Model
variation
- create_variation_no_bg - Create no background
- create_variation_upscale - Create upscale
- get_variation_by_id - Get variation by ID
- post_variations_unzoom - Create unzoom
Dev Containers
Experience our SDK in an enhanced sandbox environment. Try it now in GitHub Codespaces!
Pagination
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
returned response object will have a Next
method that can be called to pull down the next group of results. If the
return value of Next
is None
, then there are no more pages to be fetched.
Here's an example of one such pagination call:
Error Handling
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 | 400-600 | / |
Example
import leonardoaisdk
from leonardoaisdk.models import operations
s = leonardoaisdk.LeonardoAiSDK(
bearer_auth="",
)
req = operations.CreateDatasetRequestBody(
name='string',
)
res = None
try:
res = s.dataset.create_dataset(req)
except (errors.SDKError) as e:
print(e) # handle exception
if res.object is not None:
# handle response
pass
Custom HTTP Client
The Python SDK makes API calls using the (requests)[https://pypi.org/project/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)
Server Selection
Select Server by Index
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 |
For example:
import leonardoaisdk
from leonardoaisdk.models import operations
s = leonardoaisdk.LeonardoAiSDK(
server_idx=0,
bearer_auth="",
)
req = operations.CreateDatasetRequestBody(
name='string',
)
res = s.dataset.create_dataset(req)
if res.object is not None:
# handle response
pass
Override Server URL Per-Client
The 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="",
)
req = operations.CreateDatasetRequestBody(
name='string',
)
res = s.dataset.create_dataset(req)
if res.object is not None:
# handle response
pass
Authentication
Per-Client Security Schemes
This 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="",
)
req = operations.CreateDatasetRequestBody(
name='string',
)
res = s.dataset.create_dataset(req)
if res.object is not None:
# handle response
pass
Maturity
This 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.
Contributions
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 !
SDK Created by Speakeasy
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for Leonardo_Ai_SDK-3.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcfaaf747e2266c6b89c40de680f3e7298e721ecac5c39a280ad942cc764a900 |
|
MD5 | 2874e52c1c97518c2995b1dd9d5239aa |
|
BLAKE2b-256 | dd4477f7a4d32dde41e7c37f1859b4c9073299585600a06f675ee61bd79845e0 |