API ReferenceExport StorageLocal

Create export storage

Create a new local file export storage connection to store annotations.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
descriptionstringOptional
Storage description
pathstringOptional
Path to local directory
projectintegerOptional
Project ID
regex_filterstringOptional
Regex for filtering objects
titlestringOptional<=2048 characters
Storage title
use_blob_urlsbooleanOptionalDefaults to false
Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.

Response

created_atdatetime
Creation time
idinteger
projectinteger
A unique integer value identifying this project.
typestringDefaults to localfiles
can_delete_objectsboolean or null
Deletion from storage enabled
descriptionstring or null
Cloud storage description
last_syncdatetime or null
Last sync finished time
last_sync_countinteger or null>=0<=2147483647
Count of tasks synced last time
last_sync_jobstring or null<=256 characters
Last sync job ID
metaany or null
pathstring or null
Local path
regex_filterstring or null
Regex for filtering objects
statusenum or null
  • initialized - Initialized
  • queued - Queued
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
  • completed_with_errors - Completed with errors
synchronizableboolean or nullDefaults to true
titlestring or null<=256 characters
Cloud storage title
tracebackstring or null
Traceback report for the last failed sync
use_blob_urlsboolean or null
Interpret objects as BLOBs and generate URLs