# Ultralytics Datasets API

**Canonical:** https://apis.io/apis/ultralytics/ultralytics-datasets-api/  
**Provider:** Ultralytics — https://apis.io/providers/ultralytics/  
**Base URL:** https://platform.ultralytics.com  
**Documentation:** https://docs.ultralytics.com/platform/api

Ultralytics Datasets API is one of 11 APIs that [Ultralytics](https://apis.io/providers/ultralytics/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Datasets. The published artifact set on APIs.io includes an OpenAPI specification.

The Datasets API from Ultralytics — 114 operation(s) for datasets.

## Operations (60 of 153)

| Method | Path | Summary |
|---|---|---|
| GET | `/datasets/datasetTypes` | Datasets get dataset types |
| POST | `/datasets/datasetTypes` | Datasets add dataset type |
| GET | `/datasets/datasetTypes/{idOrName}` | Datasets get dataset types |
| PUT | `/datasets/datasetTypes/{idOrName}` | Datasets update dataset type links with metadata blocks |
| PUT | `/datasets/datasetTypes/{idOrName}/licenses` | Datasets update dataset type with licenses |
| DELETE | `/datasets/datasetTypes/{id}` | Datasets delete dataset type |
| GET | `/datasets/export` | Datasets export dataset |
| GET | `/datasets/listCurationStates` | Datasets get curation states |
| GET | `/datasets/locks` | Datasets list locks |
| POST | `/datasets/modifyRegistrationAll` | Datasets update dataset target URL all |
| POST | `/datasets/modifyRegistrationPIDMetadataAll` | Datasets update dataset PID metadata all |
| PUT | `/datasets/mpupload` | Datasets complete MP upload |
| DELETE | `/datasets/mpupload` | Datasets abort MP upload |
| GET | `/datasets/previewUrlDatasetVersion/{previewUrlToken}` | Datasets get preview url dataset version |
| GET | `/datasets/previewUrlDatasetVersion/{previewUrlToken}/citation` | Datasets get preview url dataset version citation |
| GET | `/datasets/privateUrlDatasetVersion/{privateUrlToken}` | Datasets get private url dataset version |
| GET | `/datasets/privateUrlDatasetVersion/{privateUrlToken}/citation` | Datasets get private url dataset version citation |
| GET | `/datasets/summaryFieldNames` | Datasets get dataset summary field names |
| DELETE | `/datasets/{datasetId}/deleteLink/{linkedDataverseId}` | Datasets delete dataset linking dataverse |
| GET | `/datasets/{identifier}/allowedCurationLabels` | Datasets get allowed curation labels |
| GET | `/datasets/{identifier}/assignments` | Datasets get assignments |
| POST | `/datasets/{identifier}/assignments` | Datasets create assignment |
| DELETE | `/datasets/{identifier}/assignments/{id}` | Datasets delete assignment |
| GET | `/datasets/{identifier}/curationLabelSet` | Datasets get curation label set |
| PUT | `/datasets/{identifier}/curationLabelSet` | Datasets set curation label set |
| DELETE | `/datasets/{identifier}/curationLabelSet` | Datasets reset curation label set |
| POST | `/datasets/{identifier}/dataCaptureModule/checksumValidation` | Datasets receive checksum validation results |
| GET | `/datasets/{identifier}/dataCaptureModule/rsync` | Datasets get rsync |
| GET | `/datasets/{identifier}/guestbookEntryAtRequest` | Datasets get guestbook entry option |
| PUT | `/datasets/{identifier}/guestbookEntryAtRequest` | Datasets setguestbook entry at request |
| DELETE | `/datasets/{identifier}/guestbookEntryAtRequest` | Datasets reset guestbook entry at request |
| POST | `/datasets/{identifier}/lock/{type}` | Datasets lock dataset |
| GET | `/datasets/{identifier}/locks` | Datasets get locks for dataset |
| DELETE | `/datasets/{identifier}/locks` | Datasets delete locks |
| GET | `/datasets/{identifier}/pidGenerator` | Datasets get pid generator |
| PUT | `/datasets/{identifier}/pidGenerator` | Datasets set pid generator |
| DELETE | `/datasets/{identifier}/pidGenerator` | Datasets reset pid generator |
| PUT | `/datasets/{identifier}/pidReconcile` | Datasets reconcile pid |
| GET | `/datasets/{identifier}/storageDriver` | Datasets get file store |
| PUT | `/datasets/{identifier}/storageDriver` | Datasets set file store |
| DELETE | `/datasets/{identifier}/storageDriver` | Datasets reset file store |
| GET | `/datasets/{identifier}/storagesize` | Datasets get storage size |
| GET | `/datasets/{identifier}/timestamps` | Datasets get timestamps |
| GET | `/datasets/{identifier}/versions/{versionId}/downloadsize` | Datasets get download size |
| GET | `/datasets/{id}` | Datasets get dataset |
| DELETE | `/datasets/{id}` | Datasets delete dataset |
| GET | `/datasets/{id}/actions/:publish` | Datasets publish datase using get deprecated |
| POST | `/datasets/{id}/actions/:publish` | Datasets publish dataset |
| POST | `/datasets/{id}/actions/:releasemigrated` | Datasets publish migrated dataset |
| GET | `/datasets/{id}/availableFileCategories` | Datasets get available file categories |
| PUT | `/datasets/{id}/citationdate` | Datasets set citation date |
| DELETE | `/datasets/{id}/citationdate` | Datasets use default citation date |
| GET | `/datasets/{id}/cleanStorage` | Datasets clean storage |
| GET | `/datasets/{id}/curationStatus` | Datasets get curation status |
| PUT | `/datasets/{id}/curationStatus` | Datasets set curation status |
| DELETE | `/datasets/{id}/curationStatus` | Datasets delete curation status |
| PUT | `/datasets/{id}/deleteFiles` | Datasets delete dataset files |
| PUT | `/datasets/{id}/deleteMetadata` | Datasets delete version metadata |
| DELETE | `/datasets/{id}/destroy` | Datasets destroy dataset |
| GET | `/datasets/{id}/dirindex` | Datasets get file access folder view |

…and 93 more operations. They are listed in full on the page.

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/ultralytics/openapi/ultralytics-datasets-api-openapi.yml

## Other Ultralytics APIs (10)

- [Ultralytics Platform API](https://apis.io/apis/ultralytics/ultralytics-platform-api/)
- [Ultralytics Assets API](https://apis.io/apis/ultralytics/ultralytics-assets-api/)
- [Ultralytics Ultralytics API](https://apis.io/apis/ultralytics/ultralytics-ultralytics-api/)
- [Ultralytics Agents API](https://apis.io/apis/ultralytics/ultralytics-agents-api/)
- [Ultralytics Billing API](https://apis.io/apis/ultralytics/ultralytics-billing-api/)
- [Ultralytics Deployments API](https://apis.io/apis/ultralytics/ultralytics-deployments-api/)
- [Ultralytics Lifecycle API](https://apis.io/apis/ultralytics/ultralytics-lifecycle-api/)
- [Ultralytics Storage Integrations API](https://apis.io/apis/ultralytics/ultralytics-storage-integrations-api/)
- [Ultralytics Training API](https://apis.io/apis/ultralytics/ultralytics-training-api/)
- [Ultralytics Upload API](https://apis.io/apis/ultralytics/ultralytics-upload-api/)

## Tags

Datasets

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/ultralytics/ultralytics-datasets-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/ultralytics/.