ULultralytics
Datasets

Update a dataset

Changed on

Updates dataset properties. Changing the display name also changes the dataset name used in URLs.

patch/api/datasets/{owner}/{dataset}

Request

  • Base URL
    https://platform.ultralytics.com
  • Auth
    HTTP bearer

Path parameters

ownerstring required
Example:ultralytics

Dataset owner

datasetstring required
Example:coco8

Dataset name

Request body

starredboolean
namestring
descriptionstring
metadataobject

Custom JSON metadata with keys limited to 128 characters and at most 500,000 serialized characters.

visibility'public' | 'private'

Resource visibility

tagsstring[]
classNamesstring[]
initializeClassNamesboolean

Require the dataset to have no classes or annotations

classColorsobject
format'yolo' | 'coco' | 'raw' | 'ndjson'

Dataset annotation format

blurFacesboolean
task'detect' | 'segment' | 'semantic' | 'depth' | 'classify' | 'pose' | 'obb'

Dataset task type

kptSkeletonIdstring
license'None' | 'CC0-1.0' | 'PDM-1.0' | 'CC-BY-2.5' | 'CC-BY-3.0' | 'CC-BY-4.0' | 'CC-BY-NC-2.0' | 'CC-BY-NC-3.0' | 'CC-BY-NC-4.0' | 'CC-BY-SA-3.0' | 'CC-BY-SA-4.0' | 'CC-BY-NC-SA-3.0' | 'CC-BY-NC-SA-4.0' | 'CC-BY-ND-4.0' | 'CC-BY-NC-ND-2.0' | 'CC-BY-NC-ND-4.0' | 'Apache-2.0' | 'MIT' | 'BSD-3-Clause' | 'AGPL-3.0' | 'GPL-2.0' | 'GPL-3.0' | 'LGPL-3.0' | 'ODbL-1.0' | 'DbCL-1.0' | 'Research-Only' | 'Other'

Dataset license identifier

iconColorstring

Response

Dataset updated

successtrue required
datasetstring required

Current dataset name used in Platform URLs

Changes