🔌 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!

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ultralytics_platform-0.1.7.tar.gz (53.1 kB view details)

Uploaded Aug 19, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

ultralytics_platform-0.1.7-py3-none-any.whl (64.4 kB view details)

Uploaded Aug 19, 2026 Python 3

File details

Details for the file ultralytics_platform-0.1.7.tar.gz.

File metadata

Download URL: ultralytics_platform-0.1.7.tar.gz
Upload date: Aug 19, 2026
Size: 53.1 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ultralytics_platform-0.1.7.tar.gz
Algorithm	Hash digest
SHA256	`e375e9ae7cbd0dc37f05d5dfed997f6f54297f400f04192c7d59246a85c5c824`
MD5	`4cd395f6d43fd00b03b079c06e6ae428`
BLAKE2b-256	`97cf2049ef87b9ddcbe6400a041b38209ff97cf677989006e9a7e085ffa542be`

See more details on using hashes here.

Provenance

The following attestation bundles were made for ultralytics_platform-0.1.7.tar.gz:

Publisher: publish.yml on ultralytics/sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: ultralytics_platform-0.1.7.tar.gz
- Subject digest: e375e9ae7cbd0dc37f05d5dfed997f6f54297f400f04192c7d59246a85c5c824
- Sigstore transparency entry: 2519092221
- Sigstore integration time: Aug 19, 2026
Source repository:
- Permalink: ultralytics/sdk@45a5fbab9d2d2f36f8fea60e2c345aff7e7373f3
- Branch / Tag: refs/heads/main
- Owner: https://github.com/ultralytics
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@45a5fbab9d2d2f36f8fea60e2c345aff7e7373f3
- Trigger Event: push