Create import storage | API Reference

Create a new local file import storage connection.

Authentication

AuthorizationToken

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

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_atdatetimeRead-only

Creation time

idintegerRead-only

projectinteger

A unique integer value identifying this project.

typestringRead-onlyDefaults to localfiles

descriptionstring or null

Cloud storage description

last_syncdatetime or null

Last sync finished time

last_sync_countinteger or null0-2147483647

Count of tasks synced last time

last_sync_jobstring or null<=256 characters

Last sync job ID

metaany or null

Meta and debug information about storage processes

pathstring or null

Local path

recursive_scanboolean or null

Perform recursive scan over the directory content

regex_filterstring or null

Regex for filtering objects

statusenum

initialized - Initialized
queued - Queued
in_progress - In progress
failed - Failed
completed - Completed
completed_with_errors - Completed with errors

synchronizablebooleanDefaults to true

titlestring or null<=256 characters

Cloud storage title

tracebackstring or null

Traceback report for the last failed sync

use_blob_urlsboolean

Interpret objects as BLOBs and generate URLs

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

This endpoint expects an object.

Path to local directory

Regex for filtering objects

A unique integer value identifying this project.

Cloud storage description

Last sync finished time

Count of tasks synced last time

Meta and debug information about storage processes

Perform recursive scan over the directory content

Regex for filtering objects

initialized - Initialized
queued - Queued
in_progress - In progress
failed - Failed
completed - Completed
completed_with_errors - Completed with errors

Traceback report for the last failed sync

Interpret objects as BLOBs and generate URLs

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

$	curl -X POST http://localhost:8000/api/storages/localfiles/ \
>	-H "Authorization: Token <api_key>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"id": 42,
4	"project": 7,
5	"type": "localfiles",
6	"description": "Local storage for project images",
7	"last_sync": "2024-04-20T14:45:00Z",
8	"last_sync_count": 150,
9	"last_sync_job": "sync_job_20240420_1445",
10	"meta": null,
11	"path": "/mnt/data/project_images",
12	"recursive_scan": true,
13	"regex_filter": ".*\\.(jpg\|png\|jpeg)$",
14	"status": "initialized",
15	"synchronizable": true,
16	"title": "Project 7 Image Storage",
17	"traceback": "",
18	"use_blob_urls": true
19	}