API ReferenceProjectsExports

Easy export of tasks and annotations

Note: if you have a large project it’s recommended to use export snapshots, this easy export endpoint might have timeouts.

Export annotated tasks as a file in a specific format. For example, to export JSON annotations for a project to a file called annotations.json, run the following from the command line:

$curl -X GET http://localhost:8000/api/projects/{id}/export?exportType=JSON -H 'Authorization: Token abc123' --output 'annotations.json'

To export all tasks, including skipped tasks and others without annotations, run the following from the command line:

$curl -X GET http://localhost:8000/api/projects/{id}/export?exportType=JSON&download_all_tasks=true -H 'Authorization: Token abc123' --output 'annotations.json'

To export specific tasks with IDs of 123 and 345, run the following from the command line:

$curl -X GET 'http://localhost:8000/api/projects/{id}/export?ids[]=123&ids[]=345' -H 'Authorization: Token abc123' --output 'annotations.json'

Path parameters

idintegerRequired
A unique integer value identifying this project.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Query parameters

download_all_tasksbooleanOptional
If true, download all tasks regardless of status. If false, download only annotated tasks.
download_resourcesbooleanOptional
If true, download all resource files such as images, audio, and others relevant to the tasks.
export_typestringOptional

Selected export format (JSON by default)

idsstringOptional
Specify a list of task IDs to retrieve only the details for those tasks.

Response

Exported data