ProjectsExports

Create new export snapshot

POST

Create a new export request to start a background task and generate an export file (snapshot) for a specific project by ID. The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using List all projects.

A snapshot is a static export of your project’s data and annotations at a specific point in time. It captures the current state of your tasks, annotations, and other relevant data, allowing you to download and review them later. Snapshots are particularly useful for large projects as they help avoid timeouts during export operations by processing the data asynchronously.

For more information, see the Label Studio documentation on exporting annotations.

Path parameters

idintegerRequired
A unique integer value identifying this project.

Request

This endpoint expects an object.
title
stringOptional
id
integerOptional
created_by
objectOptional
Project owner
created_at
datetimeOptional
Creation time
finished_at
datetimeOptional
Complete or fail time
status
enumOptional
Allowed values: createdin_progressfailedcompleted
md5
stringOptional
counters
map from strings to anyOptional
converted_formats
list of objectsOptional
task_filter_options
objectOptional
annotation_filter_options
objectOptional
serialization_options
objectOptional

Response

This endpoint returns an object
title
stringOptional
id
integerOptional
created_by
objectOptional
Project owner
created_at
datetimeOptional
Creation time
finished_at
datetimeOptional
Complete or fail time
status
enumOptional
Allowed values: createdin_progressfailedcompleted
md5
stringOptional
counters
map from strings to anyOptional
converted_formats
list of objectsOptional
task_filter_options
objectOptional
annotation_filter_options
objectOptional
serialization_options
objectOptional
POST
1curl -X POST http://localhost:8080/api/projects/1/exports/ \
2 -H "Authorization: Token <api_key>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200Successful
1{
2 "title": "title",
3 "id": 1,
4 "created_by": {
5 "id": 1,
6 "first_name": "first_name",
7 "last_name": "last_name",
8 "email": "email",
9 "avatar": "avatar"
10 },
11 "created_at": "2024-01-15T09:30:00Z",
12 "finished_at": "2024-01-15T09:30:00Z",
13 "status": "created",
14 "md5": "md5",
15 "counters": {
16 "counters": {
17 "key": "value"
18 }
19 },
20 "converted_formats": [
21 {
22 "export_type": "export_type",
23 "id": 1,
24 "status": "created",
25 "traceback": "traceback"
26 }
27 ],
28 "task_filter_options": {
29 "view": 1,
30 "skipped": "skipped",
31 "finished": "finished",
32 "annotated": "annotated",
33 "only_with_annotations": true
34 },
35 "annotation_filter_options": {
36 "usual": true,
37 "ground_truth": true,
38 "skipped": true
39 },
40 "serialization_options": {
41 "drafts": {
42 "only_id": true
43 },
44 "predictions": {
45 "only_id": true
46 },
47 "include_annotation_history": true,
48 "annotations__completed_by": {
49 "only_id": true
50 },
51 "interpolate_key_frames": true
52 }
53}