Import/Export

Bulk data import and export

Submit Annotation

post
/annotate/{taskId}

Submits annotation answer for a task

Authorizations
apikeystringRequired

API key for authentication. Format - apikey YOUR_API_KEY

Path parameters
taskIdstringRequired

Task ID

Query parameters
isPluginstring · enumOptional

Set to 'true' if annotation from plugin

Possible values:
Body
answerobjectRequired

Annotation answer object (structure depends on project categorySchema)

Responses
200

Annotation submitted successfully

application/json
post
/annotate/{taskId}
200

Annotation submitted successfully

Import Attachments

post
/attachments

Imports attachments and associates them with assets

Authorizations
apikeystringRequired

API key for authentication. Format - apikey YOUR_API_KEY

Body
projectstringRequired
Responses
200

Attachments imported successfully

application/json
post
/attachments
200

Attachments imported successfully

Import Labels

post
/import/labels

Imports pre-labeled data into a project

Authorizations
apikeystringRequired

API key for authentication. Format - apikey YOUR_API_KEY

Body
projectstringRequired
Responses
200

Labels imported successfully

application/json
post
/import/labels
200

Labels imported successfully

Export Tasks

get
/export

Exports task data from projects in various formats

Authorizations
apikeystringRequired

API key for authentication. Format - apikey YOUR_API_KEY

Query parameters
projectstringRequired

Project ID

Example: 507f1f77bcf86cd799439011
formatstring · enumOptional

Export format

Default: jsonPossible values:
typestring · enumOptional

Export type (task or issue)

Default: taskPossible values:
stagestringOptional

Filter by stages (JSON array string, e.g., ["Complete"])

Example: ["Complete"]
batchesstringOptional

Filter by batches (JSON array string, e.g., ["Batch1"])

Example: ["Batch1"]
sendEmailstring · enumOptional

Send export download link via email

Default: falsePossible values:
doNotNotifystring · enumOptional

Do not send notifications about export

Default: falsePossible values:
includeMetadatastring · enumOptional

Include asset metadata in export

Default: falsePossible values:
includeHistorystring · enumOptional

Include task history (all state changes)

Default: falsePossible values:
includeOnlyKeyFramesstring · enumOptional

Include only key frames for video annotations

Default: falsePossible values:
includeIdleBlurDurationsstring · enumOptional

Include idle and blur duration statistics

Default: falsePossible values:
updatedAtstringOptional

Filter by update date (JSON object, e.g., {"$gt":"2020-08-19T07:37:15.000000Z","$lt":"2020-08-26T07:37:15.000000Z"})

Example: {"$gt":"2020-08-19T07:37:15.000000Z","$lt":"2020-08-26T07:37:15.000000Z"}
createdAtstringOptional

Filter by creation date (JSON object, e.g., {"$gt":"2020-07-27T07:37:15.000000Z","$lt":"2020-08-26T07:37:15.000000Z"})

Example: {"$gt":"2020-07-27T07:37:15.000000Z","$lt":"2020-08-26T07:37:15.000000Z"}
filtersstringOptional

MongoDB-style filter object for advanced task filtering (JSON string). Supports any MongoDB query operators on task fields. Common use cases:

  • Filter by task IDs: {"_id": {"$in": ["taskId1", "taskId2"]}}
  • Filter by assignee: {"assignee": "[email protected]"}
  • Filter by external ID: {"externalId": {"$regex": "^prefix_"}}
Example: {"_id": {"$in": ["507f1f77bcf86cd799439011", "507f1f77bcf86cd799439012"]}}
Responses
200

Export prepared successfully

application/json
get
/export
200

Export prepared successfully

Last updated