Projects

Create a project

Changed on

Creates a project for organizing models in an account or editable workspace. An existing slug is rejected with 409.

post/api/projects

Request

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

Request body

projectstring required

Project name used in Platform URLs

namestring required

Display name

descriptionstring
metadataobject

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

visibility'public' | 'private'

Resource visibility

tagsstring[]
license'None' | 'Apache-2.0' | 'MIT' | 'BSD-3-Clause' | 'AGPL-3.0' | 'GPL-3.0' | 'LGPL-3.0' | 'MPL-2.0' | 'EUPL-1.1' | 'Unlicense' | 'CC0-1.0' | 'Ultralytics-Enterprise' | 'Other'

Project/model license identifier

ownerstring

Workspace owner

Example request

{
  "name": "Inspection",
  "owner": "ultralytics"
}

Response

Project created

idstring required

Created project ID

ownerstring required

Project owner

projectstring required

Created project name used in Platform URLs

region'us' | 'eu' | 'ap' required

Data region where data is stored

Changes