Sign in

v51

OpenAPI 3.1.0raw.githubusercontent.com2026-08-01228315499.3 KB
import

Starts an import job with the given parameters and file

post/import/{project_id}/type/{import_job_type}

Path parameters

project_idinteger required
import_job_type'PROJECT' | 'CODES' | 'TAGS' | 'FOLDERS' | 'BBOX_ANNOTATIONS' | 'SPAN_ANNOTATIONS' | 'SENTENCE_ANNOTATIONS' | 'USERS' | 'PROJECT_METADATA' | 'WHITEBOARDS' | 'TIMELINE_ANALYSES' | 'COTA' | 'MEMOS' | 'DOCUMENTS' required

Response

Successful Response

job_idstring required

RQ job ID

job_typestring required

Type of the job

project_idinteger required

Project ID associated with the job

status'queued' | 'finished' | 'failed' | 'started' | 'deferred' | 'scheduled' | 'stopped' | 'canceled' required
status_messagestring nullable

Status message

current_stepinteger required

Current step in the job process

stepsstring[] required

Total number of steps in the job process

{"stackTrail":"components:schemas:ImportJobRead:properties:output","oasType":"schema","type":"unknown","title":"Output","description":"Output for the job"}
createdstring date-time required

Created timestamp of the job

finishedstring date-time nullable

Finished timestamp of the job