Import StorageLocal

List import storages

GET

If you have local files that you want to add to Label Studio from a specific directory, you can set up a specific local directory on the machine where LS is running as source or target storage. Use this API request to get a list of all local file import (source) storage connections for a specific project.

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.

For more information about working with external storage, see Sync data from external storage.

Query parameters

projectintegerOptional
Project ID

Response

This endpoint returns a list of objects
project
integer
A unique integer value identifying this project.
id
integerOptional
type
stringOptionalDefaults to localfiles
synchronizable
booleanOptional
path
stringOptional
Local path
regex_filter
stringOptional
Regex for filtering objects
use_blob_urls
booleanOptional
Interpret objects as BLOBs and generate URLs
last_sync
datetimeOptional
Last sync finished time
last_sync_count
integerOptional
Count of tasks synced last time
last_sync_job
stringOptional
Last sync job ID
status
enumOptional
Allowed values: initializedqueuedin_progressfailedcompleted
traceback
stringOptional
Traceback report for the last failed sync
meta
map from strings to anyOptional
Meta and debug information about storage processes
title
stringOptional
Cloud storage title
description
stringOptional
Cloud storage description
created_at
datetimeOptional
Creation time
GET
1curl http://localhost:8080/api/storages/localfiles/ \
2 -H "Authorization: Token <api_key>"
200Retrieved
1[
2 {
3 "project": 1,
4 "id": 1,
5 "type": "type",
6 "synchronizable": true,
7 "path": "path",
8 "regex_filter": "regex_filter",
9 "use_blob_urls": true,
10 "last_sync": "2024-01-15T09:30:00Z",
11 "last_sync_count": 1,
12 "last_sync_job": "last_sync_job",
13 "status": "initialized",
14 "traceback": "traceback",
15 "meta": {
16 "meta": {
17 "key": "value"
18 }
19 },
20 "title": "title",
21 "description": "description",
22 "created_at": "2024-01-15T09:30:00Z"
23 }
24]