Create import storage | API Reference

Create a new source storage connection to a Google Cloud Storage bucket.

For information about the required fields and prerequisites, see Google Cloud Storage in the Label Studio documentation.

Ensure you configure CORS before adding cloud storage. This ensures you will be able to see the content of the data rather than just a link.

After you add the storage, you should validate the connection before attempting to sync your data. Your data will not be imported until you sync your connection.

Request

This endpoint expects an object.

regex_filterstringOptional

Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.

use_blob_urlsbooleanOptionalDefaults to false

Interpret objects as BLOBs and generate URLs. For example, if your bucket 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.

presignbooleanOptionalDefaults to true

Presign URLs for direct download

presign_ttlintegerOptionalDefaults to 1

Presign TTL in minutes

titlestringOptional

Storage title

descriptionstringOptional

Storage description

projectintegerOptional

Project ID

bucketstringOptional

GCS bucket name

prefixstringOptional

GCS bucket prefix

google_application_credentialsstringOptional

The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.

google_project_idstringOptional

Google project ID

Response

regex_filterstring or null

Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.

use_blob_urlsboolean or nullDefaults to false

presignboolean or nullDefaults to true

Presign URLs for direct download

presign_ttlinteger or nullDefaults to 1

Presign TTL in minutes

titlestring or null

Storage title

descriptionstring or null

Storage description

projectinteger or null

Project ID

bucketstring or null

GCS bucket name

prefixstring or null

GCS bucket prefix

google_application_credentialsstring or null

The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.

google_project_idstring or null

Google project ID

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

1	{
2	"regex_filter": "regex_filter",
3	"use_blob_urls": true,
4	"presign": true,
5	"presign_ttl": 1,
6	"title": "title",
7	"description": "description",
8	"project": 1,
9	"bucket": "bucket",
10	"prefix": "prefix",
11	"google_application_credentials": "google_application_credentials",
12	"google_project_id": "google_project_id"
13	}

Headers

Request

Response