For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create a Project

POST /:workspace/projects

Create a project in a workspace.

Example Request

curl -X POST "https://api.roboflow.com/my-workspace/projects?api_key=$ROBOFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sharks Dataset",
    "type": "object-detection",
    "annotation": "sharks",
    "license": "MIT"
  }'

Body

Name
Type
Description
Required

name

string

Display name for the project. The URL slug is auto-generated from this.

type

string

Project type. One of object-detection, single-label-classification, multi-label-classification, instance-segmentation, semantic-segmentation, keypoint-detection.

annotation

string

Annotation group - a noun describing what's being labeled (ex: "sharks", "defects"). Spaces and other non-alphanumeric characters are normalized to dashes, so "hard hats" is stored as hard-hats. Must contain at least one letter or number and be 256 characters or fewer.

license

string

License for the project. Required for workspaces that aren't already public. Accepted values: Public Domain, MIT, CC BY 4.0, BY-NC-SA 4.0, OBdL v1.0, Private (paid plans only).

group

string

Id of a project folder to place this project in. See Manage Project Folders.

Example Response

{
    "id": "my-workspace/sharks-dataset",
    "type": "object-detection",
    "name": "Sharks Dataset",
    "created": 1688739471567,
    "updated": 1688739471567,
    "images": 0,
    "unannotated": 0,
    "annotation": "sharks",
    "versions": 0,
    "public": false,
    "splits": {},
    "colors": {},
    "classes": {},
    "icon": null
}

Required scope: project:create.

SDK and CLI equivalents

Last updated

Was this helpful?