Get project import status | API Reference

Poll the status of an asynchronous project import operation.

Usage:

When you POST to /api/projects/{project_id}/import, you’ll receive a response like {"import": <import_id>}
Use that import_id with this GET endpoint to check the import status
Poll this endpoint to see if the import has completed, is still processing, or has failed
Import errors and failures will only be visible in this GET response, not in the original POST request

This endpoint returns detailed information about the import including task counts, status, and any error messages.

Poll the status of an asynchronous project import operation. **Usage:** 1. When you POST to `/api/projects/{project_id}/import`, you'll receive a response like `{"import": <import_id>}` 2. Use that `import_id` with this GET endpoint to check the import status 3. Poll this endpoint to see if the import has completed, is still processing, or has failed 4. **Import errors and failures will only be visible in this GET response**, not in the original POST request This endpoint returns detailed information about the import including task counts, status, and any error messages.

Authentication

AuthorizationToken

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Path parameters

idintegerRequired

A unique integer value identifying this project import.

import_pkintegerRequired

Response

created_atdatetime or nullRead-only

Creation time

idintegerRead-only

updated_atdatetime or nullRead-only

Updated time

annotation_countinteger-2147483648-2147483647

commit_to_projectboolean

could_be_tasks_listboolean

data_columnsany

durationinteger-2147483648-2147483647

errorstring or null

file_upload_idsany

finished_atdatetime or null

Complete or fail time

found_formatsany

preannotated_from_fieldsany or null

prediction_countinteger-2147483648-2147483647

projectinteger or null

return_task_idsboolean

statusenum

created - Created
in_progress - In progress
failed - Failed
completed - Completed

* `created` - Created * `in_progress` - In progress * `failed` - Failed * `completed` - Completed

Allowed values:

task_countinteger-2147483648-2147483647

task_idsany

tasksany or null

urlstring or null<=2048 characters

1	{
2	"created_at": "2024-04-10T14:22:00Z",
3	"id": 17,
4	"updated_at": "2024-04-10T14:24:00Z",
5	"annotation_count": 45,
6	"commit_to_project": true,
7	"could_be_tasks_list": false,
8	"duration": 120,
9	"finished_at": "2024-04-10T14:24:00Z",
10	"prediction_count": 30,
11	"project": 5,
12	"return_task_ids": false,
13	"status": "completed",
14	"task_count": 50,
15	"url": "https://labelstud.io/api/projects/5/imports/17/"
16	}

1	curl http://localhost:8000/api/projects/1/imports/1/ \
2	-H "Authorization: Token <api_key>" \
3	-H "Content-Type: application/json"