Create import storage

POST

Create a new source storage connection to a S3 bucket.

For information about the required fields and prerequisites, see Amazon S3 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 download

presign_ttlintegerOptionalDefaults to 1

Presign TTL in minutes

recursive_scanbooleanOptional

Scan recursively

titlestringOptional

Storage title

descriptionstringOptional

Storage description

projectintegerOptional

Project ID

bucketstringOptional

S3 bucket name

prefixstringOptional

S3 bucket prefix

external_idstringOptional

AWS External ID

role_arnstringOptional

AWS Role ARN

region_namestringOptional

AWS Region

s3_endpointstringOptional

S3 Endpoint

Response

projectinteger

A unique integer value identifying this project.

idintegerOptional
synchronizablebooleanOptionalDefaults to true
presignbooleanOptionalDefaults to true
last_syncdatetimeOptional

Last sync finished time

last_sync_countintegerOptional

Count of tasks synced last time

last_sync_jobstringOptional<=256 characters

Last sync job ID

statusenumOptional
Allowed values: initializedqueuedin_progressfailedcompleted
tracebackstringOptional

Traceback report for the last failed sync

metamap from strings to anyOptional

Meta and debug information about storage processes

titlestringOptional<=256 characters

Cloud storage title

descriptionstringOptional

Cloud storage description

created_atdatetimeOptional

Creation time

bucketstringOptional

S3 bucket name

prefixstringOptional

S3 bucket prefix

regex_filterstringOptional

Cloud storage regex for filtering objects

use_blob_urlsbooleanOptional

Interpret objects as BLOBs and generate URLs

region_namestringOptional

AWS Region

external_idstringOptional

AWS External ID

role_arnstringOptional

AWS Role ARN

s3_endpointstringOptional

S3 Endpoint

presign_ttlintegerOptional

Presigned URLs TTL (in minutes)

recursive_scanbooleanOptional

Perform recursive scan over the bucket content

Built with