Create new export snapshot | API Reference

Create a new export request to start a background task and generate an export file for a specific project by ID.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path Parameters

idintegerRequired

A unique integer value identifying this project.

Request

This endpoint expects an object.

annotation_filter_optionsobjectOptional

converted_formatslist of objectsOptional

countersanyOptional

created_byobjectOptional

A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations

finished_atdatetimeOptional

Complete or fail time

md5stringOptional>=1 character<=128 characters

serialization_optionsobjectOptional

statusenumOptional

created - Created
in_progress - In progress
failed - Failed
completed - Completed

* `created` - Created * `in_progress` - In progress * `failed` - Failed * `completed` - Completed

Allowed values:

task_filter_optionsobjectOptional

titlestringOptional<=2048 characters

Response

created_atdatetime

Creation time

idinteger

annotation_filter_optionsobject or null

converted_formatslist of objects or null

countersany or null

created_byobject or null

finished_atdatetime or null

Complete or fail time

md5string or null<=128 characters

serialization_optionsobject or null

statusenum or null

created - Created
in_progress - In progress
failed - Failed
completed - Completed

* `created` - Created * `in_progress` - In progress * `failed` - Failed * `completed` - Completed

Allowed values:

task_filter_optionsobject or null

titlestring or null<=2048 characters

1	from label_studio_sdk import LabelStudio
2
3	client = LabelStudio(
4	api_key="YOUR_API_KEY",
5	)
6	client.projects.exports.create(
7	id=1,
8	)

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"id": 1,
4	"annotation_filter_options": {
5	"ground_truth": true,
6	"reviewed": "only",
7	"skipped": true,
8	"usual": true
9	},
10	"converted_formats": [
11	{
12	"export_type": "export_type",
13	"id": 1,
14	"status": "created",
15	"traceback": "traceback"
16	}
17	],
18	"counters": {
19	"key": "value"
20	},
21	"created_by": {
22	"avatar": "avatar",
23	"id": 1,
24	"email": "email",
25	"first_name": "first_name",
26	"last_name": "last_name"
27	},
28	"finished_at": "2024-01-15T09:30:00Z",
29	"md5": "md5",
30	"serialization_options": {
31	"annotations__completed_by": {
32	"only_id": true
33	},
34	"drafts": {
35	"only_id": true
36	},
37	"include_annotation_history": true,
38	"interpolate_key_frames": true,
39	"predictions": {
40	"only_id": true
41	}
42	},
43	"status": "created",
44	"task_filter_options": {
45	"annotated": "only",
46	"finished": "only",
47	"only_with_annotations": true,
48	"reviewed": "only",
49	"skipped": "only",
50	"view": 1
51	},
52	"title": "title"
53	}