Project Folders API
You can manage your Project Folders programmatically using the Roboflow API.
Note: This feature is only available for Enterprise workspaces.
Note: Your api_key
must be sent in all requests. The api_key
can be sent as a query parameter or as a top level attribute in the post body.
Creating a Project Folder
POST
/:workspace/groups
Creates a Project Folder.
Headers
Name | Value |
---|---|
Content-Type |
|
Body
Name | Type | Description | Required |
---|---|---|---|
| string | The api key of the workspace where the Project Folder should be created | |
| string | The name of the Project Folder | |
| Array<string> | ||
| string | The id of this Project Folder in an external system | |
| Map<"read" | "write , Array<string> | A list of permission groups that should have read/write access to the projects within this Folder. (Note: please contact Roboflow before using this feature as it requires additional set up) |
Example Request
Response
Get Project Folder
GET
/:workspace/groups/:folderId
Retrieves a Project Folder by ID
Headers
Name | Value |
---|---|
Content-Type |
|
Query
Name | Type | Description | Required |
---|---|---|---|
| string | API Key of workspace where Project Folder exists |
Example Request
Response
Update a Project Folder
POST
/:workspace/groups/:folderId
Updates a Project Folder's properities
Headers
Name | Value |
---|---|
Content-Type |
|
Query
Name | Required | ||
---|---|---|---|
| boolean | When set, returns the full resource payload in the response |
Body
Name | Type | Description | Required |
---|---|---|---|
| string | The api key of the workspace where the Project Folder should be created | |
| string | The name of the Project Folder | |
| Array<string> | ||
| string | The id of this Project Folder in an external system | |
| Map<"read" | "write , Array<string> | A list of permission groups that should have read/write access to the projects within this Folder. (Note: please contact Roboflow before using this feature as it requires additional set up) |
Example Request
Response
No Content. Resource was updated successfully
Add Project(s) to Folder
PATCH
/:workspace/groups/:folderId/projects
Adds one or more projects to an existing folder
Headers
Name | Value |
---|---|
Content-Type |
|
Body
Name | Type | Description | Required |
---|---|---|---|
| Array<string> | A list of project ids to add to the Project Folder |
Example Request
Response
No Content. Project was added to the group successfully
Remove Project(s) to Folder
DELETE
/:workspace/groups/:folderId/projects
Removes one or more projects from an existing folder and places it back into the top level workspace
Headers
Name | Value |
---|---|
Content-Type |
|
Body
Name | Type | Description | Required |
---|---|---|---|
| Array<string> | A list of project ids to remove from the Project Folder |
Example Request
Response
No Content. Project was removed from the group successfully
Delete Project Folder
DELETE
/:workspace/groups/:folderId
Deletes a project Folder. All projects within the folder will be placed back into the top level workspace and not deleted.
Headers
Name | Value |
---|---|
Content-Type |
|
Example Request
Response
No Content. Project Folder was successfully deleted
Last updated