| Name | leap-python-sdk JSON |
| Version |
1.1.4
JSON |
| download |
| home_page | |
| Summary | Client for Leap |
| upload_time | 2023-09-21 18:17:21 |
| maintainer | |
| docs_url | None |
| author | Konfig |
| requires_python | >=3.7,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# leap-python-sdk
[](https://pypi.org/project/leap-python-sdk/1.1.4)
[](https://tryleap.ai/)
The Official Leap API
## Requirements
Python >=3.7
## Installing
```sh
pip install leap-python-sdk==1.1.4
```
## Getting Started
```python
from pprint import pprint
from leap import Leap, ApiException
leap = Leap(
# Defining the host is optional and defaults to https://api.tryleap.ai
# See configuration.py for a list of all supported configuration parameters.
host="https://api.tryleap.ai",
# Configure Bearer authorization (JWT): bearer
access_token="YOUR_BEARER_TOKEN",
)
try:
# Generate an Image
generate_response = leap.images.generate(
prompt="A photo of an astronaut riding a horse", # required
model_id="26a1a203-3a46-42cb-8cfa-f4de075907d8", # required
negative_prompt="asymmetric, bad hands, bad hair", # optional
steps=50, # optional
width=1024, # optional
height=1024, # optional
number_of_images=1, # optional
prompt_strength=7, # optional
seed=4523184, # optional
webhook_url="string_example", # optional
)
pprint(generate_response.body)
pprint(generate_response.body["id"])
pprint(generate_response.body["created_at"])
pprint(generate_response.body["prompt"])
pprint(generate_response.body["negative_prompt"])
pprint(generate_response.body["seed"])
pprint(generate_response.body["width"])
pprint(generate_response.body["height"])
pprint(generate_response.body["prompt_strength"])
pprint(generate_response.body["number_of_images"])
pprint(generate_response.body["state"])
pprint(generate_response.body["status"])
pprint(generate_response.body["steps"])
pprint(generate_response.body["images"])
pprint(generate_response.body["model_id"])
pprint(generate_response.body["upscaling_option"])
pprint(generate_response.headers)
pprint(generate_response.status)
pprint(generate_response.round_trip_time)
except ApiException as e:
print("Exception when calling ImagesApi.generate: %s\n" % e)
pprint(e.body)
pprint(e.headers)
pprint(e.status)
pprint(e.reason)
pprint(e.round_trip_time)
```
## Async
`async` support is available by prepending `a` to any method.
```python
import asyncio
from pprint import pprint
from leap import Leap, ApiException
leap = Leap(
# Defining the host is optional and defaults to https://api.tryleap.ai
# See configuration.py for a list of all supported configuration parameters.
host="https://api.tryleap.ai",
# Configure Bearer authorization (JWT): bearer
access_token="YOUR_BEARER_TOKEN",
)
async def main():
try:
# Generate an Image
generate_response = await leap.images.agenerate(
prompt="A photo of an astronaut riding a horse", # required
model_id="26a1a203-3a46-42cb-8cfa-f4de075907d8", # required
negative_prompt="asymmetric, bad hands, bad hair", # optional
steps=50, # optional
width=1024, # optional
height=1024, # optional
number_of_images=1, # optional
prompt_strength=7, # optional
seed=4523184, # optional
webhook_url="string_example", # optional
)
pprint(generate_response.body)
pprint(generate_response.body["id"])
pprint(generate_response.body["created_at"])
pprint(generate_response.body["prompt"])
pprint(generate_response.body["negative_prompt"])
pprint(generate_response.body["seed"])
pprint(generate_response.body["width"])
pprint(generate_response.body["height"])
pprint(generate_response.body["prompt_strength"])
pprint(generate_response.body["number_of_images"])
pprint(generate_response.body["state"])
pprint(generate_response.body["status"])
pprint(generate_response.body["steps"])
pprint(generate_response.body["images"])
pprint(generate_response.body["model_id"])
pprint(generate_response.body["upscaling_option"])
pprint(generate_response.headers)
pprint(generate_response.status)
pprint(generate_response.round_trip_time)
except ApiException as e:
print("Exception when calling ImagesApi.generate: %s\n" % e)
pprint(e.body)
pprint(e.headers)
pprint(e.status)
pprint(e.reason)
pprint(e.round_trip_time)
asyncio.run(main())
```
## Documentation for API Endpoints
All URIs are relative to *https://api.tryleap.ai*
Tag | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*Images* | [**generate**](docs/apis/tags/ImagesApi.md#generate) | **POST** /api/v1/images/models/{modelId}/inferences | Generate an Image
*Images* | [**delete**](docs/apis/tags/ImagesApi.md#delete) | **DELETE** /api/v1/images/models/{modelId}/inferences/{inferenceId} | Delete Image Job
*Images* | [**find_one**](docs/apis/tags/ImagesApi.md#find_one) | **GET** /api/v1/images/models/{modelId}/inferences/{inferenceId} | Get Single Image Job
*Images* | [**list_all**](docs/apis/tags/ImagesApi.md#list_all) | **GET** /api/v1/images/models/{modelId}/inferences | List All Image Jobs
*Image Models* | [**delete_model**](docs/apis/tags/ImageModelsApi.md#delete_model) | **DELETE** /api/v2/images/models/{modelId} | Delete a Model
*Image Models* | [**get_model**](docs/apis/tags/ImageModelsApi.md#get_model) | **GET** /api/v2/images/models/{modelId} | Get a Single Model
*Image Models* | [**list_all_models**](docs/apis/tags/ImageModelsApi.md#list_all_models) | **GET** /api/v2/images/models | List All Models
*Image Models* | [**train_model**](docs/apis/tags/ImageModelsApi.md#train_model) | **POST** /api/v2/images/models/new | Train Model
*Music* | [**find_one**](docs/apis/tags/MusicApi.md#find_one) | **GET** /api/v1/music/{inferenceId} | Get a Music Generation Job
*Music* | [**generate**](docs/apis/tags/MusicApi.md#generate) | **POST** /api/v1/music | Generate Music
*Music* | [**list_all**](docs/apis/tags/MusicApi.md#list_all) | **GET** /api/v1/music | List Music Generation Jobs
## Documentation For Models
- [CreateAndTrainModelDto](docs/models/CreateAndTrainModelDto.md)
- [CreateAndTrainModelDtoImageSampleFiles](docs/models/CreateAndTrainModelDtoImageSampleFiles.md)
- [CreateAndTrainModelDtoImageSampleUrls](docs/models/CreateAndTrainModelDtoImageSampleUrls.md)
- [CreateInferenceDto](docs/models/CreateInferenceDto.md)
- [CreateMusicgenInferenceDto](docs/models/CreateMusicgenInferenceDto.md)
- [InferenceEntity](docs/models/InferenceEntity.md)
- [InferenceImageEntity](docs/models/InferenceImageEntity.md)
- [InferencesControllerFindAllResponse](docs/models/InferencesControllerFindAllResponse.md)
- [ListModelsV2Response](docs/models/ListModelsV2Response.md)
- [ModelV2Entity](docs/models/ModelV2Entity.md)
- [ModelV2EntityImageSamples](docs/models/ModelV2EntityImageSamples.md)
- [MusicControllerFindAllAudioResponse](docs/models/MusicControllerFindAllAudioResponse.md)
- [MusicgenInferenceEntity](docs/models/MusicgenInferenceEntity.md)
## Author
This Python package is automatically generated by [Konfig](https://konfigthis.com)
Raw data
{
"_id": null,
"home_page": "",
"name": "leap-python-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Konfig",
"author_email": "engineering@konfigthis.com",
"download_url": "https://files.pythonhosted.org/packages/02/f5/6a4907514ca9826717a1eeab0279df4e582f9bb3cebc3d758072125f90d8/leap_python_sdk-1.1.4.tar.gz",
"platform": null,
"description": "# leap-python-sdk\n\n[](https://pypi.org/project/leap-python-sdk/1.1.4)\n[](https://tryleap.ai/)\n\nThe Official Leap API\n\n\n## Requirements\n\nPython >=3.7\n\n## Installing\n\n```sh\npip install leap-python-sdk==1.1.4\n```\n\n## Getting Started\n\n```python\nfrom pprint import pprint\nfrom leap import Leap, ApiException\n\nleap = Leap(\n # Defining the host is optional and defaults to https://api.tryleap.ai\n # See configuration.py for a list of all supported configuration parameters.\n host=\"https://api.tryleap.ai\",\n # Configure Bearer authorization (JWT): bearer\n access_token=\"YOUR_BEARER_TOKEN\",\n)\n\ntry:\n # Generate an Image\n generate_response = leap.images.generate(\n prompt=\"A photo of an astronaut riding a horse\", # required\n model_id=\"26a1a203-3a46-42cb-8cfa-f4de075907d8\", # required\n negative_prompt=\"asymmetric, bad hands, bad hair\", # optional\n steps=50, # optional\n width=1024, # optional\n height=1024, # optional\n number_of_images=1, # optional\n prompt_strength=7, # optional\n seed=4523184, # optional\n webhook_url=\"string_example\", # optional\n )\n pprint(generate_response.body)\n pprint(generate_response.body[\"id\"])\n pprint(generate_response.body[\"created_at\"])\n pprint(generate_response.body[\"prompt\"])\n pprint(generate_response.body[\"negative_prompt\"])\n pprint(generate_response.body[\"seed\"])\n pprint(generate_response.body[\"width\"])\n pprint(generate_response.body[\"height\"])\n pprint(generate_response.body[\"prompt_strength\"])\n pprint(generate_response.body[\"number_of_images\"])\n pprint(generate_response.body[\"state\"])\n pprint(generate_response.body[\"status\"])\n pprint(generate_response.body[\"steps\"])\n pprint(generate_response.body[\"images\"])\n pprint(generate_response.body[\"model_id\"])\n pprint(generate_response.body[\"upscaling_option\"])\n pprint(generate_response.headers)\n pprint(generate_response.status)\n pprint(generate_response.round_trip_time)\nexcept ApiException as e:\n print(\"Exception when calling ImagesApi.generate: %s\\n\" % e)\n pprint(e.body)\n pprint(e.headers)\n pprint(e.status)\n pprint(e.reason)\n pprint(e.round_trip_time)\n```\n\n## Async\n\n`async` support is available by prepending `a` to any method.\n\n```python\nimport asyncio\nfrom pprint import pprint\nfrom leap import Leap, ApiException\n\nleap = Leap(\n # Defining the host is optional and defaults to https://api.tryleap.ai\n # See configuration.py for a list of all supported configuration parameters.\n host=\"https://api.tryleap.ai\",\n # Configure Bearer authorization (JWT): bearer\n access_token=\"YOUR_BEARER_TOKEN\",\n)\n\n\nasync def main():\n try:\n # Generate an Image\n generate_response = await leap.images.agenerate(\n prompt=\"A photo of an astronaut riding a horse\", # required\n model_id=\"26a1a203-3a46-42cb-8cfa-f4de075907d8\", # required\n negative_prompt=\"asymmetric, bad hands, bad hair\", # optional\n steps=50, # optional\n width=1024, # optional\n height=1024, # optional\n number_of_images=1, # optional\n prompt_strength=7, # optional\n seed=4523184, # optional\n webhook_url=\"string_example\", # optional\n )\n pprint(generate_response.body)\n pprint(generate_response.body[\"id\"])\n pprint(generate_response.body[\"created_at\"])\n pprint(generate_response.body[\"prompt\"])\n pprint(generate_response.body[\"negative_prompt\"])\n pprint(generate_response.body[\"seed\"])\n pprint(generate_response.body[\"width\"])\n pprint(generate_response.body[\"height\"])\n pprint(generate_response.body[\"prompt_strength\"])\n pprint(generate_response.body[\"number_of_images\"])\n pprint(generate_response.body[\"state\"])\n pprint(generate_response.body[\"status\"])\n pprint(generate_response.body[\"steps\"])\n pprint(generate_response.body[\"images\"])\n pprint(generate_response.body[\"model_id\"])\n pprint(generate_response.body[\"upscaling_option\"])\n pprint(generate_response.headers)\n pprint(generate_response.status)\n pprint(generate_response.round_trip_time)\n except ApiException as e:\n print(\"Exception when calling ImagesApi.generate: %s\\n\" % e)\n pprint(e.body)\n pprint(e.headers)\n pprint(e.status)\n pprint(e.reason)\n pprint(e.round_trip_time)\n\n\nasyncio.run(main())\n```\n\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.tryleap.ai*\n\nTag | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*Images* | [**generate**](docs/apis/tags/ImagesApi.md#generate) | **POST** /api/v1/images/models/{modelId}/inferences | Generate an Image\n*Images* | [**delete**](docs/apis/tags/ImagesApi.md#delete) | **DELETE** /api/v1/images/models/{modelId}/inferences/{inferenceId} | Delete Image Job\n*Images* | [**find_one**](docs/apis/tags/ImagesApi.md#find_one) | **GET** /api/v1/images/models/{modelId}/inferences/{inferenceId} | Get Single Image Job\n*Images* | [**list_all**](docs/apis/tags/ImagesApi.md#list_all) | **GET** /api/v1/images/models/{modelId}/inferences | List All Image Jobs\n*Image Models* | [**delete_model**](docs/apis/tags/ImageModelsApi.md#delete_model) | **DELETE** /api/v2/images/models/{modelId} | Delete a Model\n*Image Models* | [**get_model**](docs/apis/tags/ImageModelsApi.md#get_model) | **GET** /api/v2/images/models/{modelId} | Get a Single Model\n*Image Models* | [**list_all_models**](docs/apis/tags/ImageModelsApi.md#list_all_models) | **GET** /api/v2/images/models | List All Models\n*Image Models* | [**train_model**](docs/apis/tags/ImageModelsApi.md#train_model) | **POST** /api/v2/images/models/new | Train Model\n*Music* | [**find_one**](docs/apis/tags/MusicApi.md#find_one) | **GET** /api/v1/music/{inferenceId} | Get a Music Generation Job\n*Music* | [**generate**](docs/apis/tags/MusicApi.md#generate) | **POST** /api/v1/music | Generate Music\n*Music* | [**list_all**](docs/apis/tags/MusicApi.md#list_all) | **GET** /api/v1/music | List Music Generation Jobs\n\n## Documentation For Models\n\n - [CreateAndTrainModelDto](docs/models/CreateAndTrainModelDto.md)\n - [CreateAndTrainModelDtoImageSampleFiles](docs/models/CreateAndTrainModelDtoImageSampleFiles.md)\n - [CreateAndTrainModelDtoImageSampleUrls](docs/models/CreateAndTrainModelDtoImageSampleUrls.md)\n - [CreateInferenceDto](docs/models/CreateInferenceDto.md)\n - [CreateMusicgenInferenceDto](docs/models/CreateMusicgenInferenceDto.md)\n - [InferenceEntity](docs/models/InferenceEntity.md)\n - [InferenceImageEntity](docs/models/InferenceImageEntity.md)\n - [InferencesControllerFindAllResponse](docs/models/InferencesControllerFindAllResponse.md)\n - [ListModelsV2Response](docs/models/ListModelsV2Response.md)\n - [ModelV2Entity](docs/models/ModelV2Entity.md)\n - [ModelV2EntityImageSamples](docs/models/ModelV2EntityImageSamples.md)\n - [MusicControllerFindAllAudioResponse](docs/models/MusicControllerFindAllAudioResponse.md)\n - [MusicgenInferenceEntity](docs/models/MusicgenInferenceEntity.md)\n\n\n## Author\nThis Python package is automatically generated by [Konfig](https://konfigthis.com)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Client for Leap",
"version": "1.1.4",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "66e7f025aeaa5120cabe6d71766adec7016925867f87a9caef787be5f77a7a91",
"md5": "e254f22af70971d4713f218cd5e2de59",
"sha256": "785b5b96e45fad33f05f24010827f227ebce81a5ab51d7ac25ea4973951a1b64"
},
"downloads": -1,
"filename": "leap_python_sdk-1.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e254f22af70971d4713f218cd5e2de59",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 148728,
"upload_time": "2023-09-21T18:17:19",
"upload_time_iso_8601": "2023-09-21T18:17:19.769802Z",
"url": "https://files.pythonhosted.org/packages/66/e7/f025aeaa5120cabe6d71766adec7016925867f87a9caef787be5f77a7a91/leap_python_sdk-1.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "02f56a4907514ca9826717a1eeab0279df4e582f9bb3cebc3d758072125f90d8",
"md5": "fe600f90d0e73057d1f1abb8dbe97ef3",
"sha256": "c1e4e0894f616e3589553a7e3fa7e0577e64ea53e1ae94124816d2bd5ce31e19"
},
"downloads": -1,
"filename": "leap_python_sdk-1.1.4.tar.gz",
"has_sig": false,
"md5_digest": "fe600f90d0e73057d1f1abb8dbe97ef3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 64899,
"upload_time": "2023-09-21T18:17:21",
"upload_time_iso_8601": "2023-09-21T18:17:21.937082Z",
"url": "https://files.pythonhosted.org/packages/02/f5/6a4907514ca9826717a1eeab0279df4e582f9bb3cebc3d758072125f90d8/leap_python_sdk-1.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-21 18:17:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "leap-python-sdk"
}
