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 export storages types
        • GETGet all export storage
        • POSTCreate export storage
        • POSTValidate export storage
        • GETGet export storage
        • DELDelete export storage
        • PATCHUpdate export storage
        • POSTSync export storage
LogoLogo
EnterpriseQuick Start
API ReferenceExport StorageLocal

Get all export storage

GET
http://localhost:8000/api/storages/export/localfiles
GET
/api/storages/export/localfiles
$curl -G http://localhost:8000/api/storages/export/localfiles \
>     -H "Authorization: Token  <api_key>" \
>     -H "Content-Type: application/json" \
>     -d project=1
200Retrieved
1[
2  {
3    "created_at": "2024-04-10T08:45:00Z",
4    "id": 42,
5    "project": 42,
6    "type": "localfiles",
7    "can_delete_objects": true,
8    "description": "Local export storage for project assets",
9    "last_sync": "2024-04-15T12:00:00Z",
10    "last_sync_count": 150,
11    "last_sync_job": "sync-job-20240415-1200",
12    "meta": null,
13    "path": "/mnt/data/exports/project42",
14    "regex_filter": ".*\\.json$",
15    "status": "completed",
16    "synchronizable": true,
17    "title": "Project 42 Export Storage",
18    "traceback": null,
19    "use_blob_urls": false
20  }
21]
Get a list of all local file export storage connections.
Was this page helpful?
Previous

Create export 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>

Query parameters

orderingstringOptional
Which field to use when ordering the results.
projectintegerRequired
Project ID

Response

created_atdatetimeRead-only
Creation time
idintegerRead-only
projectinteger
A unique integer value identifying this project.
typestringRead-onlyDefaults 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 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
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]”