Create new export snapshot

POST

Create a new export request to start a background task and generate an export file (snapshot) for a specific project by ID. The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using List all projects.

A snapshot is a static export of your project’s data and annotations at a specific point in time. It captures the current state of your tasks, annotations, and other relevant data, allowing you to download and review them later. Snapshots are particularly useful for large projects as they help avoid timeouts during export operations by processing the data asynchronously.

For more information, see the Label Studio documentation on exporting annotations.

Path parameters

idintegerRequired

A unique integer value identifying this project.

Request

This endpoint expects an object.
titlestringOptional<=2048 characters
idintegerOptional
created_byobjectOptional

Project owner

created_atdatetimeOptional

Creation time

finished_atdatetimeOptional

Complete or fail time

statusenumOptional
Allowed values: createdin_progressfailedcompleted
md5stringOptional>=1 character<=128 characters
countersmap from strings to anyOptional
converted_formatslist of objectsOptional
task_filter_optionsobjectOptional
annotation_filter_optionsobjectOptional
serialization_optionsobjectOptional

Response

titlestringOptional<=2048 characters
idintegerOptional
created_byobjectOptional

Project owner

created_atdatetimeOptional

Creation time

finished_atdatetimeOptional

Complete or fail time

statusenumOptional
Allowed values: createdin_progressfailedcompleted
md5stringOptional>=1 character<=128 characters
countersmap from strings to anyOptional
converted_formatslist of objectsOptional
task_filter_optionsobjectOptional
annotation_filter_optionsobjectOptional
serialization_optionsobjectOptional