Create a new task

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Request

This endpoint expects an object.

dataanyRequired

cancelled_annotationsintegerOptional-2147483648-2147483647

Number of total cancelled annotations for the current task

comment_authorslist of integersOptional

Users who wrote comments

comment_countintegerOptional-2147483648-2147483647

Number of comments in the task including all annotations

file_uploadintegerOptional

Uploaded file used as data source for this task

inner_idlongOptional

Internal task ID in the project, starts with 1

is_labeledbooleanOptional

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_atdatetimeOptional

When the last comment was updated

metaanyOptional

overlapintegerOptional-2147483648-2147483647

Number of distinct annotators that processed the current task

projectintegerOptional

Project ID for this task

total_annotationsintegerOptional-2147483648-2147483647

Number of total annotations for the current task except cancelled annotations

total_predictionsintegerOptional-2147483648-2147483647

Number of total predictions for the current task

unresolved_comment_countintegerOptional-2147483648-2147483647

Number of unresolved comments in the task including all annotations

updated_byintegerOptional

Last annotator or reviewer who updated this task

Response

agreementstring

agreement_selectedstring

annotationsstring

annotations_idsstring

annotations_resultsstring

annotatorslist of integers

Annotators IDs who annotated this task

annotators_countinteger

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.

comment_authorslist of maps from strings to any

comment_authors_countinteger

commentsstring

created_atdatetime

Time a task was created

dataany

draftslist of objects

Drafts for this task

file_uploadstring

idinteger

predictionslist of objects

Predictions for this task

predictions_model_versionsstring

predictions_resultsstring

review_timeinteger

Calculate total review time for this task from MetricInTimeBucket records. Returns time in seconds.

reviewerslist of maps from strings to any

reviewers_countinteger

statestring

storage_filenamestring

updated_atdatetime

Last time a task was updated

updated_bylist of maps from strings to any

User IDs who updated this task

avg_lead_timedouble or null

cancelled_annotationsinteger or null

comment_countinteger or null-2147483648-2147483647

Number of comments in the task including all annotations

completed_atdatetime or null

draft_existsboolean or null

ground_truthboolean or null

inner_idinteger or null

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

last_comment_updated_atdatetime or null

When the last comment was updated

metaany or null

overlapinteger or null-2147483648-2147483647

Number of distinct annotators that processed the current task

precomputed_agreementdouble or null

Average agreement score for the task

predictions_scoredouble or null

projectinteger or null

Project ID for this task

reviewedboolean or null

reviews_acceptedinteger or null

reviews_rejectedinteger or null

total_annotationsinteger or null

total_predictionsinteger or null

unresolved_comment_countinteger or null-2147483648-2147483647

Number of unresolved comments in the task including all annotations

1	curl -X POST http://localhost:8000/api/tasks/ \
2	-H "Authorization: Token <api_key>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"data": {
6	"image": "https://example.com/image.jpg",
7	"text": "Hello, world!"
8	},
9	"project": 1
10	}'

1	{
2	"agreement": "agreement",
3	"agreement_selected": "agreement_selected",
4	"annotations": "annotations",
5	"annotations_ids": "annotations_ids",
6	"annotations_results": "annotations_results",
7	"annotators": [
8	1
9	],
10	"annotators_count": 1,
11	"comment_authors": [
12	{
13	"key": "value"
14	}
15	],
16	"comment_authors_count": 1,
17	"comments": "comments",
18	"created_at": "2024-01-15T09:30:00Z",
19	"data": {
20	"key": "value"
21	},
22	"drafts": [
23	{
24	"created_at": "2024-01-15T09:30:00Z",
25	"result": [
26	{
27	"key": "value"
28	}
29	],
30	"updated_at": "2024-01-15T09:30:00Z"
31	}
32	],
33	"file_upload": "file_upload",
34	"id": 1,
35	"predictions": [
36	{
37	"created_at": "2024-01-15T09:30:00Z",
38	"model": {
39	"key": "value"
40	},
41	"model_run": {
42	"key": "value"
43	},
44	"model_version": "model_version",
45	"project": 1,
46	"result": [
47	{
48	"key": "value"
49	}
50	],
51	"score": 1.1,
52	"task": 1,
53	"updated_at": "2024-01-15T09:30:00Z"
54	}
55	],
56	"predictions_model_versions": "predictions_model_versions",
57	"predictions_results": "predictions_results",
58	"review_time": 1,
59	"reviewers": [
60	{
61	"key": "value"
62	}
63	],
64	"reviewers_count": 1,
65	"state": "state",
66	"storage_filename": "storage_filename",
67	"updated_at": "2024-01-15T09:30:00Z",
68	"updated_by": [
69	{
70	"key": "value"
71	}
72	],
73	"avg_lead_time": 1.1,
74	"cancelled_annotations": 1,
75	"comment_count": 1,
76	"completed_at": "2024-01-15T09:30:00Z",
77	"draft_exists": true,
78	"ground_truth": true,
79	"inner_id": 1,
80	"is_labeled": true,
81	"last_comment_updated_at": "2024-01-15T09:30:00Z",
82	"meta": {
83	"key": "value"
84	},
85	"overlap": 1,
86	"precomputed_agreement": 1.1,
87	"predictions_score": 1.1,
88	"project": 1,
89	"reviewed": true,
90	"reviews_accepted": 1,
91	"reviews_rejected": 1,
92	"total_annotations": 1,
93	"total_predictions": 1,
94	"unresolved_comment_count": 1
95	}