Sync export storage | API Reference

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

{
  "created_at": "2024-04-20T14:22:00Z",
  "id": 1,
  "project": 101,
  "type": "gcs",
  "bucket": "label-studio-exports",
  "can_delete_objects": true,
  "description": "GCS export storage for project annotations",
  "google_application_credentials": "{ \"type\": \"service_account\", \"project_id\": \"label-studio-project-123\", \"private_key_id\": \"abcdef1234567890\", \"private_key\": \"-----BEGIN PRIVATE KEY-----\\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASC...\\n-----END PRIVATE KEY-----\\n\", \"client_email\": \"label-studio@label-studio-project-123.iam.gserviceaccount.com\", \"client_id\": \"1234567890\", \"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\", \"token_uri\": \"https://oauth2.googleapis.com/token\", \"auth_provider_x509_cert_url\": \"https://www.googleapis.com/oauth2/v1/certs\", \"client_x509_cert_url\": \"https://www.googleapis.com/robot/v1/metadata/x509/label-studio%40label-studio-project-123.iam.gserviceaccount.com\" }",
  "google_project_id": "label-studio-project-123",
  "last_sync": "2024-04-25T10:15:00Z",
  "last_sync_count": 42,
  "last_sync_job": "sync-job-20240425-1015",
  "meta": null,
  "prefix": "exports/annotations/",
  "regex_filter": ".*\\.json$",
  "status": "completed",
  "synchronizable": true,
  "title": "Label Studio GCS Export Storage",
  "traceback": null,
  "use_blob_urls": true
}

Sync tasks from an GCS export 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>

Path parameters

idintegerRequired

Response

created_atdatetimeRead-only

Creation time

idintegerRead-only

projectinteger

A unique integer value identifying this project.

typestringRead-onlyDefaults to gcs

bucketstring or null

GCS bucket name

can_delete_objectsboolean or null

Deletion from storage enabled

descriptionstring or null

Cloud storage description

google_application_credentialsstring or null

The content of GOOGLE_APPLICATION_CREDENTIALS json file

google_project_idstring or null

Google project ID

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

prefixstring or null

GCS bucket prefix

regex_filterstring or null

Cloud storage 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