For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
EnterpriseQuick Start
API ReferenceTutorials
  • Introduction
    • Getting started
  • API Reference
      • GETList all import storages types
        • GETGet all import storage
        • POSTCreate import storage
        • POSTValidate import storage
        • GETGet import storage
        • DELDelete import storage
        • PATCHUpdate import storage
        • POSTSync import storage
LogoLogo
EnterpriseQuick Start
API ReferenceImport StorageLocal

Get import storage

GET
http://localhost:8000/api/storages/localfiles/:id
GET
/api/storages/localfiles/:id
$curl http://localhost:8000/api/storages/localfiles/1 \
>     -H "Authorization: Token  <api_key>" \
>     -H "Content-Type: application/json"
200Retrieved
1{
2  "created_at": "2024-01-15T09:30:00Z",
3  "id": 1,
4  "project": 42,
5  "type": "localfiles",
6  "description": "Local import storage for project images",
7  "last_sync": "2024-04-10T14:45:00Z",
8  "last_sync_count": 125,
9  "last_sync_job": "sync-job-20240410-1445",
10  "meta": null,
11  "path": "/mnt/data/project_images",
12  "recursive_scan": true,
13  "regex_filter": ".*\\.(jpg|png|jpeg)$",
14  "status": "completed",
15  "synchronizable": true,
16  "title": "Project Images Storage",
17  "traceback": null,
18  "use_blob_urls": false
19}
Get a specific local file import storage connection.
Was this page helpful?
Previous

Delete import storage

Next
Built with

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>

Path parameters

idintegerRequired

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]”