Working with Projects (API)

Projects cannot be deleted using the SDK or the API, as this is a significant and irreversible operation. Please use our web-app to delete Projects.

Creating a Project

First you need to create a private key for Encord.

The above API call returns the unique identifier of the Project known as project_hash, and makes the caller the Admin of the project.

---

Adding datasets to a Project

Using the API you can add existing datasets to a Project.

You need to be the Admin of the Datasets that you want to add, and the Project itself.

The unique identifier dataset_hash for every dataset is needed for this functionality.

Removing Datasets from a Project

You can remove existing Datasets to a Project using the API.

The unique identifier dataset_hash is required for every dataset to be removed

Only the Admin of a project is eligible to execute this functionality.

Adding users to a Project

Add users to an existing project via the API.

The email_id of the users need to be provided as an input.

Project user roles are Admin = 0, Annotator = 1, Reviewer = 2, Annotator & Reviewer = 3, Team manager = 4

---

Fetching Project information

Fetch information associated with a given Project.

---

Fetching Project Ontology

You can fetch the Ontology of an existing project using the above API call. The editor Ontology can be found in the API response under the key editor_ontology.