Projects

Get project import status

Changed on
        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.
        While an import is running, `task_count` / annotation / prediction counts update as batches commit.
        Counts are cumulative so far; there is no expected total, so percent-complete / ETA is not available from this API.
    
get/api/projects/{id}/imports/{import_pk}/

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/projects/{id}/imports/{import_pk}/
  • Auth
    API key in header Authorization

Path parameters

idinteger required

A unique integer value identifying this project.

import_pkinteger required

A unique integer value identifying this project import.

Response

annotation_countinteger
commit_to_projectboolean
could_be_tasks_listboolean
created_atstring date-time nullable required

Creation time

data_columnsunknown
durationinteger
errorstring nullable
file_upload_idsunknown
finished_atstring date-time nullable

Complete or fail time

found_formatsunknown
idinteger required
preannotated_from_fieldsunknown
prediction_countinteger
projectinteger nullable
return_task_idsboolean
status'created' | 'in_progress' | 'failed' | 'completed'
  • created - Created
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
task_countinteger
task_idsunknown
updated_atstring date-time nullable

Last time import progress or terminal status was updated

urlstring nullable

Changes

    • breaking

      the response property became optional for the status

    • warning

      removed the optional property from the response with the status

    • info

      the response required property became not read-only for the status