v77

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-045764591.5 MB
Projects

Get project import status

        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.
    
get/api/projects/{id}/imports/{import_pk}/

Path parameters

idinteger required

A unique integer value identifying this project import.

import_pkinteger required

Response

annotation_countinteger
commit_to_projectboolean
could_be_tasks_listboolean
created_atstring date-time nullable required

Creation time

{"stackTrail":"components:schemas:ProjectImport:properties:data_columns","oasType":"schema","type":"unknown"}
durationinteger
errorstring nullable
{"stackTrail":"components:schemas:ProjectImport:properties:file_upload_ids","oasType":"schema","type":"unknown"}
finished_atstring date-time nullable

Complete or fail time

{"stackTrail":"components:schemas:ProjectImport:properties:found_formats","oasType":"schema","type":"unknown"}
idinteger required
{"stackTrail":"components:schemas:ProjectImport:properties:preannotated_from_fields","oasType":"schema","type":"unknown","nullable":true}
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
{"stackTrail":"components:schemas:ProjectImport:properties:task_ids","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:ProjectImport:properties:tasks","oasType":"schema","type":"unknown","nullable":true}
updated_atstring date-time nullable required

Updated time

urlstring nullable