🔌 Ultralytics Platform API Python SDK
Typed synchronous and asynchronous Python clients generated from the Ultralytics Platform API contract with Ultralytics OpenAPI. The interactive API reference documents every resource and includes Python examples.
🐍 Python
Install the standalone ultralytics-platform package from PyPI in a Python >=3.11 environment. It has one lightweight runtime dependency (httpx) and does not install the larger ultralytics package:
uv pip install ultralytics-platform
Pass your API key directly as shown below. Alternatively, set ULTRALYTICS_API_KEY and omit the api_key argument.
from ultralytics_platform import Platform
with Platform(api_key="YOUR_API_KEY") as client:
response = client.datasets.list("your_username")
The asynchronous client exposes the same resource tree:
import asyncio
from ultralytics_platform import AsyncPlatform
async def main():
async with AsyncPlatform(api_key="YOUR_API_KEY") as client:
response = await client.datasets.list("your_username")
asyncio.run(main())
The package includes typed responses, multipart uploads, retries for temporary failures, structured API errors, custom HTTP clients, and context-manager cleanup.
🧩 One Contract, Typed Python
The Ultralytics Platform API contract is the single source of truth for the generated client:
OpenAPI contract
└── Python SDK # ultralytics-platform
The source repository pins the consumed contract and generated output so API changes remain deterministic and reviewable. Generated SDK files should never be edited manually; update the contract, consumer configuration, package README source, or generator and regenerate.
🛠️ Validation
CI regenerates the Python SDK to detect contract mismatch or generated drift. It also formats and lints Python, compiles the package, builds its wheel, installs it through the package boundary, and exercises representative synchronous and asynchronous requests.
💡 Contribute
Ultralytics thrives on community collaboration, and we deeply value your contributions! Please see our Contributing Guide for details on how you can get involved. We also encourage you to share your feedback through our Survey. A huge thank you 🙏 to all our contributors!
API shape changes belong in the service OpenAPI contract; generated files should not be edited directly.
📄 License
- AGPL-3.0 License: The generated SDK is licensed under the AGPL-3.0 License.
- Enterprise License: Commercial licensing is available separately through Ultralytics Licensing.
📫 Contact
For bug reports or feature suggestions related to this SDK, please submit an issue via GitHub Issues. Join our Discord, Reddit, or Community Forums for discussions and support!
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ultralytics_platform-0.1.4.tar.gz.
File metadata
- Download URL: ultralytics_platform-0.1.4.tar.gz
- Upload date:
- Size: 50.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f93f2432aedf3f24b05189a45e0c1cea8c794c3c7d957e798cba9c3d9b7aa86d
|
|
| MD5 |
29fd55bbfb0d30716ce45d5ebd92383a
|
|
| BLAKE2b-256 |
5c4c1d8968b8b631afcaaf9439338c2fdb44ccc242060aad01dce1c7e273a94c
|
Provenance
The following attestation bundles were made for ultralytics_platform-0.1.4.tar.gz:
Publisher:
publish.yml on ultralytics/sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ultralytics_platform-0.1.4.tar.gz -
Subject digest:
f93f2432aedf3f24b05189a45e0c1cea8c794c3c7d957e798cba9c3d9b7aa86d - Sigstore transparency entry: 2450571128
- Sigstore integration time:
-
Permalink:
ultralytics/sdk@6cf676e44b5e68d3d04ccc8a2354a94d639a0f9e -
Branch / Tag:
refs/heads/main - Owner: https://github.com/ultralytics
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@6cf676e44b5e68d3d04ccc8a2354a94d639a0f9e -
Trigger Event:
push
-
Statement type:
File details
Details for the file ultralytics_platform-0.1.4-py3-none-any.whl.
File metadata
- Download URL: ultralytics_platform-0.1.4-py3-none-any.whl
- Upload date:
- Size: 61.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bf5016a8011495e67349264cc61462f5bdd550bb3f0cbcce31a01817bdb5c7c9
|
|
| MD5 |
3a785b08a28a2d0c537e2d9c7611bc84
|
|
| BLAKE2b-256 |
544e98707d8b2225e5a373d81cae476434163c5d54cabf957242ae5a8e55524e
|
Provenance
The following attestation bundles were made for ultralytics_platform-0.1.4-py3-none-any.whl:
Publisher:
publish.yml on ultralytics/sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ultralytics_platform-0.1.4-py3-none-any.whl -
Subject digest:
bf5016a8011495e67349264cc61462f5bdd550bb3f0cbcce31a01817bdb5c7c9 - Sigstore transparency entry: 2450571191
- Sigstore integration time:
-
Permalink:
ultralytics/sdk@6cf676e44b5e68d3d04ccc8a2354a94d639a0f9e -
Branch / Tag:
refs/heads/main - Owner: https://github.com/ultralytics
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@6cf676e44b5e68d3d04ccc8a2354a94d639a0f9e -
Trigger Event:
push
-
Statement type:
