Create import storage — API Reference

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_urlsbooleanOptional

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.

presignbooleanOptional

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

aws_access_key_idstringOptional

AWS_ACCESS_KEY_ID

aws_secret_access_keystringOptional

AWS_SECRET_ACCESS_KEY

aws_session_tokenstringOptional

AWS_SESSION_TOKEN

aws_sse_kms_key_idstringOptional

AWS SSE KMS Key ID

region_namestringOptional

AWS Region

s3_endpointstringOptional

S3 Endpoint

Response

This endpoint returns an object.