Export StorageLocal

Create new storage

POST

Create a new target storage connection to a local file directory.

For information about the required fields and prerequisites, see Local storage in the Label Studio documentation.

After you add the storage, you should validate the connection before attempting to sync your data. Your data will not be exported until you sync your connection.

Request

This endpoint expects an object.
title
stringOptional
Storage title
description
stringOptional
Storage description
project
integerOptional
Project ID
path
stringOptional
Path to local directory
regex_filter
stringOptional
Regex for filtering objects
use_blob_urls
booleanOptional
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

This endpoint returns an object
title
stringOptional
Storage title
description
stringOptional
Storage description
project
integerOptional
Project ID
path
stringOptional
Path to local directory
regex_filter
stringOptional
Regex for filtering objects
use_blob_urls
booleanOptional
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.
POST
1curl -X POST http://localhost:8080/api/storages/export/localfiles \
2 -H "Authorization: Token <api_key>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200Successful
1{
2 "title": "title",
3 "description": "description",
4 "project": 1,
5 "path": "path",
6 "regex_filter": "regex_filter",
7 "use_blob_urls": true
8}