Get export snapshot by ID | API Reference

Retrieve information about a specific export file (snapshot).

You will need the export ID. You can find this in the response when you create the snapshot via the API or using List all export snapshots.

You will also need the project ID. This can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using List all projects.

Path parameters

project_idintegerRequired

A unique integer value identifying this project.

export_pkstringRequired

Primary key identifying the export file.

Response

titlestringOptional<=2048 characters

idintegerOptional

created_byobjectOptional

Project owner

created_atdatetimeOptional

Creation time

finished_atdatetimeOptional

Complete or fail time

statusenumOptional

Allowed values:

md5stringOptional>=1 character<=128 characters

countersmap from strings to anyOptional

converted_formatslist of objectsOptional

1	from label_studio_sdk import LabelStudio
2
3	client = LabelStudio(
4	api_key="YOUR_API_KEY",
5	)
6	client.projects.exports.get(
7	project_id=1,
8	export_pk="export_pk",
9	)

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	"key": "value"
17	},
18	"converted_formats": [
19	{
20	"export_type": "export_type",
21	"id": 1,
22	"status": "created",
23	"traceback": "traceback"
24	}
25	]
26	}

Path parameters

Headers

Response