✨ Sync GCS SA export storage | API Reference

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

Sync annotations to a GCS SA export storage.

<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Sync annotations to a GCS SA export storage.

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:

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

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_sa

bucketstring or null

GCS bucket name

can_delete_objectsboolean or null

Deletion from storage enabled

descriptionstring or null

Cloud storage description

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

target_service_account_emailstring or null

Service account email to impersonate for GCS access

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

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

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"id": 1,
4	"project": 42,
5	"type": "gcs_sa",
6	"bucket": "label-studio-exports",
7	"can_delete_objects": true,
8	"description": "Export storage for project annotations",
9	"google_project_id": "label-studio-project-123",
10	"last_sync": "2024-04-20T14:45:00Z",
11	"last_sync_count": 152,
12	"last_sync_job": "sync-job-20240420-1445",
13	"prefix": "exports/annotations/",
14	"regex_filter": "^.*\\.json$",
15	"status": "completed",
16	"synchronizable": true,
17	"target_service_account_email": "label-studio-sa@label-studio-project-123.iam.gserviceaccount.com",
18	"title": "GCS Service Account Export Storage",
19	"use_blob_urls": true
20	}