ProjectsExports

Get export snapshot by ID

GET

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

idintegerRequired
A unique integer value identifying this project.
export_pkstringRequired
Primary key identifying the export file.

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
GET
1curl http://localhost:8080/api/projects/1/exports/export_pk \
2 -H "Authorization: Token <api_key>"
200Retrieved
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}