API ReferenceAnnotations

Create annotation

Add annotations to a task like an annotator does.

You will need to supply the task ID. You can find this in Label Studio by opening a task and checking the URL. It is also listed at the top of the labeling interface. Or you can use Get tasks list.

The content of the result field depends on your labeling configuration. For example, send the following data as part of your POST request to send an empty annotation with the ID of the user who completed the task:

1{
2"result": {},
3"was_cancelled": true,
4"ground_truth": true,
5"lead_time": 0,
6"task": 0
7"completed_by": 123
8}

Path parameters

idintegerRequired
Task ID

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
resultlist of maps from strings to anyOptional

Labeling result in JSON format. Read more about the format in the Label Studio documentation.

taskintegerOptional
Corresponding task for this annotation
projectintegerOptional
Project ID for this annotation
completed_byintegerOptional
User ID of the person who created this annotation
updated_byintegerOptional
Last user who updated this annotation
was_cancelledbooleanOptional
User skipped the task
ground_truthbooleanOptional
This annotation is a Ground Truth
lead_timedoubleOptional

How much time it took to annotate the task (in seconds)

Response

Created annotation
idinteger or null
resultlist of maps from strings to any or null
List of annotation results for the task
created_usernamestring or null
Username string
created_agostring or null>=1 characterDefaults to
Time delta from creation time
completed_byobject or integer or null
unique_idstring or null>=1 character
was_cancelledboolean or null
User skipped the task
ground_truthboolean or null

This annotation is a Ground Truth (ground_truth)

created_atdatetime or null
Creation time
updated_atdatetime or null
Last updated time
draft_created_atdatetime or null
Draft creation time
lead_timedouble or null
How much time it took to annotate the task
import_idinteger or null
Original annotation ID that was at the import step or NULL if this annotation wasn't imported
last_actionenum or null
Action which was performed in the last annotation history item
taskinteger or null
Corresponding task for this annotation
projectinteger or null
Project ID for this annotation
updated_byinteger or null
Last user who updated this annotation
parent_predictioninteger or null
Points to the prediction from which this annotation was created
parent_annotationinteger or null
Points to the parent annotation from which this annotation was created
last_created_byinteger or null
User who created the last annotation history item