v76

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-015764591.5 MB

Tasks

Create a new task

post/api/tasks/

Request body

allow_skipboolean nullable

Whether this task can be skipped. Set to False to make task unskippable.

cancelled_annotationsinteger

Number of total cancelled annotations for the current task

comment_authorsinteger[]

Users who wrote comments

comment_countinteger

Number of comments in the task including all annotations

dataobject required

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.

file_uploadinteger nullable

Uploaded file used as data source for this task

inner_idinteger nullable

Internal task ID in the project, starts with 1

is_labeledboolean

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

last_comment_updated_atstring date-time nullable

When the last comment was updated

{"stackTrail":"components:schemas:LseTaskRequest:properties:meta","oasType":"schema","type":"unknown","description":"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.","nullable":true}

overlapinteger

Number of distinct annotators that processed the current task

projectinteger nullable

Project ID for this task

total_annotationsinteger

Number of total annotations for the current task except cancelled annotations

total_predictionsinteger

Number of total predictions for the current task

unresolved_comment_countinteger

Number of unresolved comments in the task including all annotations

updated_byinteger nullable

Last annotator or reviewer who updated this task

Response

agreementnumber double required

agreement_selectednumber double required

allow_skipboolean nullable

Whether this task can be skipped. Set to False to make task unskippable.

annotation_timeinteger nullable required

annotationsobject[] required

Return annotations for the task.

If annotations_stub=True is in context (via feature flag fflag_fix_all_fit_720_lazy_load_annotations), returns lightweight annotation stubs without result data for improved performance.

annotations_idsstring required

annotations_resultsstring required

annotatorsobject[] required

Who annotated this task; each item includes user_id plus minimal profile fields for Data Manager display.

annotators_countinteger required

The annotators_count is calculated as the number of users with annotations (can be repeated, so same as the number of annotations) + the number of assignees without annotations.

avg_lead_timenumber double

cancelled_annotationsinteger

comment_authorsobject[] required

comment_authors_countinteger required

comment_countinteger

Number of comments in the task including all annotations

commentsstring required

completed_atstring date-time

created_atstring date-time required

Time a task was created

dataobject required

draft_existsboolean

file_uploadstring nullable required

ground_truthboolean

idinteger required

inner_idinteger

is_labeledboolean

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

last_comment_updated_atstring date-time nullable

When the last comment was updated

{"stackTrail":"components:schemas:LseTask:properties:meta","oasType":"schema","type":"unknown","description":"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.","nullable":true}

overlapinteger

Number of distinct annotators that processed the current task

precomputed_agreementnumber double nullable

Average agreement score for the task

predictions_model_versionsstring required

predictions_resultsstring required

predictions_scorenumber double

projectinteger nullable

Project ID for this task

review_timeinteger nullable required

reviewedboolean

reviewersobject[] required

reviewers_countinteger required

reviews_acceptedinteger

reviews_rejectedinteger

statestring required

storage_filenamestring nullable required

total_annotationsinteger

total_predictionsinteger

unresolved_comment_countinteger

Number of unresolved comments in the task including all annotations

updated_atstring date-time required

Last time a task was updated

updated_byobject[] required

User IDs who updated this task