Create task

Create a new labeling task in Label Studio.

The data you provide depends on your labeling config and data type.

You will also need to provide a project ID. The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using List all projects.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
datamap from strings to anyOptional
Task data dictionary with arbitrary keys and values
projectintegerOptional
Project ID

Response

Created task
datamap from strings to any
User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI.
idinteger or null
metamap from strings to any or null

Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps.

created_atdatetime or null
Time a task was created
updated_atdatetime or null
Last time a task was updated
is_labeledboolean or null

True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project

overlapinteger or null
Number of distinct annotators that processed the current task
inner_idinteger or null
Internal task ID in the project, starts with 1
total_annotationsinteger or null
Number of total annotations for the current task except cancelled annotations
cancelled_annotationsinteger or null
Number of total cancelled annotations for the current task
total_predictionsinteger or null
Number of total predictions for the current task
comment_countinteger or null
Number of comments in the task including all annotations
unresolved_comment_countinteger or null
Number of unresolved comments in the task including all annotations
last_comment_updated_atdatetime or null
When the last comment was updated
projectinteger or null
Project ID for this task
updated_byoptional integer or optional list of maps from strings to any or null
Last annotator or reviewer who updated this task
file_uploadoptional string or optional integer or null
Uploaded file used as data source for this task
comment_authorslist of integers or null
Users who wrote comments