Tasks

Get all tasks of a dataset

URL

GET https://tools.deepen.ai/api/v2/datasets/{datasetId}/tasks

Request

Path parameters

Parameter name	Parameter type	Description
datasetId	string	Dataset Id of the dataset

Response

Returns a json with field ‘tasks’ that represents an array of TaskResource objects.

Submit task

URL

POST https://tools.deepen.ai/api/v2/tasks/{taskId}/submit

Request

Path parameters

Parameter name	Parameter type	Description
taskId	string	Task Id of the dataset

Response

Returns a json with an Updated TaskResource object.

Accept task

URL POST https://tools.deepen.ai/api/v2/tasks/{taskId}/accept

Request

Path parameters

Parameter name	Parameter type	Description
taskId	string	Task Id of the dataset

Response

Returns a json with an Updated TaskResource object.

Reject task

URL

POST https://tools.deepen.ai/api/v2/tasks/{taskId}/reject

Request

Path parameters

Parameter name	Parameter type	Description
taskId	string	Task Id of the dataset

Response

Returns a json with an Updated TaskResource object.

Get all tasks of a user

URL

GET https://tools.deepen.ai/api/v2/clients/{clientId}/user_tasks

Request

Path parameters

Parameter name	Parameter type	Description
clientId	string	client Id of the client

Query parameters

Parameter name	Parameter type	Description
email	string	Email of user

Response

Returns a json with fields ‘file_tasks’, ‘label_tasks’ that represents an array of TaskResource objects.

Get all tasks of a user

URL

GET https://tools.deepen.ai/api/v2/clients/{clientId}/delayed_tasks

Request

Path parameters

Parameter name	Parameter type	Description
clientId	string	client Id of the client

Response

Returns a json with fields ‘delayed tasks’ and value that represents an array of Delayed TaskResource objects.

Change and save file task assignments

URL

POST https://tools.deepen.ai/api/v2/datasets/{datasetId}/file_tasks

Request

Path parameters

Parameter name	Parameter type	Description
datasetId	string	Dataset Id of the dataset

Response

Returns an empty response if file tasks are updated.

Change and save label task assignments

URL

POST https://tools.deepen.ai/api/v2/datasets/{datasetId}/label_tasks

Request

Path parameters

Parameter name	Parameter type	Description
datasetId	string	Dataset Id of the dataset

Response

Returns an empty response if label tasks are updated.

Single Frame/Individual Dataset:

• For datasets consisting of single frames, all tasks are at the frame level, and each object is considered a task.

• Tasks are assigned based on different stages. For example, if there are 2 stages such as Labelling and QA, two tasks would be created, one for labelling and the other for QA.

• Each Frame Attribute and Dataset Attribute is also considered a task.

Sequence Dataset:

• For datasets consisting of sequence frames, all tasks are at the dataset level, and each object is considered a task across frames.

• Tasks are assigned based on different stages. For example, if there are 2 stages such as Labelling and QA, two tasks would be created, one for labelling and the other for QA.

• Each Frame Attribute and Dataset Attribute is also considered a task.