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

Authorizationstring

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

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_atdatetime or nullOptional

Complete or fail time

md5stringOptional1-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	curl -X POST http://localhost:8000/api/projects/1/exports/ \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

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": "string",
13	"id": 1,
14	"status": "created",
15	"traceback": "string"
16	}
17	],
18	"counters": null,
19	"created_by": {
20	"avatar": "string",
21	"id": 1,
22	"email": "string",
23	"first_name": "string",
24	"last_name": "string"
25	},
26	"finished_at": "2024-01-15T09:30:00Z",
27	"md5": "string",
28	"serialization_options": {
29	"annotations__completed_by": {
30	"only_id": false
31	},
32	"drafts": {
33	"only_id": false
34	},
35	"include_annotation_history": false,
36	"interpolate_key_frames": false,
37	"predictions": {
38	"only_id": false
39	}
40	},
41	"status": "created",
42	"task_filter_options": {
43	"annotated": "only",
44	"finished": "only",
45	"only_with_annotations": false,
46	"reviewed": "only",
47	"skipped": "only",
48	"view": 1
49	},
50	"title": "string"
51	}