Tasks

Get project import info

GET

Get information about an async project import operation. This can be especially useful to monitor status, as large import jobs can take time.

You will need the project ID and the unique ID of the import operation.

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.

The import ID is returned as part of the response when you call Import tasks.

Path parameters

idintegerRequired
The project ID.
import_pkstringRequired

Response

This endpoint returns an object
id
integerOptional
preannotated_from_fields
map from strings to anyOptional
commit_to_project
booleanOptional
return_task_ids
booleanOptional
status
enumOptional
Allowed values: createdin_progressfailedcompleted
url
stringOptional
traceback
stringOptional
error
stringOptional
created_at
datetimeOptional
Creation time
updated_at
datetimeOptional
Updated time
finished_at
datetimeOptional
Complete or fail time
task_count
integerOptional
annotation_count
integerOptional
prediction_count
integerOptional
duration
integerOptional
file_upload_ids
map from strings to anyOptional
could_be_tasks_list
booleanOptional
found_formats
map from strings to anyOptional
data_columns
map from strings to anyOptional
tasks
map from strings to anyOptional
task_ids
map from strings to anyOptional
project
integerOptional
GET
1curl http://localhost:8080/api/projects/1/imports/import_pk/ \
2 -H "Authorization: Token <api_key>"
200Retrieved
1{
2 "id": 1,
3 "preannotated_from_fields": {
4 "preannotated_from_fields": {
5 "key": "value"
6 }
7 },
8 "commit_to_project": true,
9 "return_task_ids": true,
10 "status": "created",
11 "url": "url",
12 "traceback": "traceback",
13 "error": "error",
14 "created_at": "2024-01-15T09:30:00Z",
15 "updated_at": "2024-01-15T09:30:00Z",
16 "finished_at": "2024-01-15T09:30:00Z",
17 "task_count": 1,
18 "annotation_count": 1,
19 "prediction_count": 1,
20 "duration": 1,
21 "file_upload_ids": {
22 "file_upload_ids": {
23 "key": "value"
24 }
25 },
26 "could_be_tasks_list": true,
27 "found_formats": {
28 "found_formats": {
29 "key": "value"
30 }
31 },
32 "data_columns": {
33 "data_columns": {
34 "key": "value"
35 }
36 },
37 "tasks": {
38 "tasks": {
39 "key": "value"
40 }
41 },
42 "task_ids": {
43 "task_ids": {
44 "key": "value"
45 }
46 },
47 "project": 1
48}