Skip to main content

Ultralytics logo

🔌 Ultralytics Platform API Python SDK

Ultralytics Discord Ultralytics Forums Ultralytics Reddit

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

PyPI - Version Ultralytics Downloads PyPI - Python Version

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.

Ultralytics open-source contributors

📄 License

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


Ultralytics GitHub space Ultralytics LinkedIn space Ultralytics Twitter space Ultralytics YouTube space Ultralytics TikTok space Ultralytics BiliBili space Ultralytics Discord

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.13.tar.gz (54.0 kB view details)

Uploaded Source

Built Distribution

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

ultralytics_platform-0.1.13-py3-none-any.whl (65.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ultralytics_platform-0.1.13.tar.gz
  • Upload date:
  • Size: 54.0 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.13.tar.gz
Algorithm Hash digest
SHA256 cd2d0a06cd141b0710e9c7105e61833a0d1ce36d5f785ea377286c7deedcf0c4
MD5 e9871f6aeb907bd163efea640596b8e5
BLAKE2b-256 9353ca864575fa0f192093cd4f31724ed8d96a5e3aac1778b4a529c01f353135

See more details on using hashes here.

Provenance

The following attestation bundles were made for ultralytics_platform-0.1.13.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.

File details

Details for the file ultralytics_platform-0.1.13-py3-none-any.whl.

File metadata

File hashes

Hashes for ultralytics_platform-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 e339e759da7d535ffbc9e91998d63485d9a513812295e23ab82184ce508af0de
MD5 90fa5f428e0337a62e92e1b2f7b9a529
BLAKE2b-256 52d95fb45c3eedd567a8814dbf994893f427ad7ad164db453dd4cca605b173a1

See more details on using hashes here.

Provenance

The following attestation bundles were made for ultralytics_platform-0.1.13-py3-none-any.whl:

Publisher: publish.yml on ultralytics/sdk

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

Release history Release notifications | RSS feed

0.1.14

2 files

This release

0.1.13 This release

2 files

0.1.11

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.1

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page