Get export snapshot by ID | API Reference

Retrieve information about an export file by export ID for a specific project.

Authentication

AuthorizationToken

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]”

Path parameters

export_pkintegerRequired

Primary key identifying the export file.

idintegerRequired

A unique integer value identifying this project.

Response

created_atdatetimeRead-only

Creation time

idintegerRead-only

converted_formatslist of objects

countersany

created_byobject

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 null

Complete or fail time

md5string<=128 characters

statusenum

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

Allowed values:

titlestring<=2048 characters

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]”

Primary key identifying the export file.

A unique integer value identifying this project.

Complete or fail time

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

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"id": 1,
4	"converted_formats": [
5	{
6	"export_type": "JSON",
7	"id": 101,
8	"status": "completed",
9	"traceback": null
10	}
11	],
12	"counters": null,
13	"created_by": {
14	"avatar": "https://labelstud.io/static/avatar123.png",
15	"id": 42,
16	"username": "janedoe",
17	"email": "jane.doe@example.com",
18	"first_name": "Jane",
19	"last_name": "Doe"
20	},
21	"finished_at": "2024-01-15T10:00:00Z",
22	"md5": "d41d8cd98f00b204e9800998ecf8427e",
23	"status": "completed",
24	"title": "Project 1 Export Snapshot"
25	}

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"id": 1,
4	"converted_formats": [
5	{
6	"export_type": "JSON",
7	"id": 101,
8	"status": "completed",
9	"traceback": null
10	}
11	],
12	"counters": null,
13	"created_by": {
14	"avatar": "https://labelstud.io/static/avatar123.png",
15	"id": 42,
16	"username": "janedoe",
17	"email": "jane.doe@example.com",
18	"first_name": "Jane",
19	"last_name": "Doe"
20	},
21	"finished_at": "2024-01-15T10:00:00Z",
22	"md5": "d41d8cd98f00b204e9800998ecf8427e",
23	"status": "completed",
24	"title": "Project 1 Export Snapshot"
25	}

$	curl http://localhost:8000/api/projects/1/exports/1 \
>	-H "Authorization: Token <api_key>" \
>	-H "Content-Type: application/json"