API ReferenceProjectsExports

Create new export snapshot

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

project_idintegerRequired
A unique integer value identifying this project.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

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:
md5stringOptional>=1 character<=128 characters
countersmap from strings to anyOptional
converted_formatslist of objectsOptional
task_filter_optionsobjectOptional
annotation_filter_optionsobjectOptional
serialization_optionsobjectOptional

Response

titlestring or null<=2048 characters
idinteger or null
created_byobject or null
Project owner
created_atdatetime or null
Creation time
finished_atdatetime or null
Complete or fail time
statusenum or null
Allowed values:
md5string or null>=1 character<=128 characters
countersmap from strings to any or null
converted_formatslist of objects or null
task_filter_optionsobject or null
annotation_filter_optionsobject or null
serialization_optionsobject or null