Create import storage
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.
Headers
Authorization
Header authentication of the form Token <token>
Request
This endpoint expects an object.
regex_filter
Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
use_blob_urls
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.
presign
Presign URLs for download
presign_ttl
Presign TTL in minutes
recursive_scan
Scan recursively
title
Storage title
description
Storage description
project
Project ID
bucket
S3 bucket name
prefix
S3 bucket prefix
aws_access_key_id
AWS_ACCESS_KEY_ID
aws_secret_access_key
AWS_SECRET_ACCESS_KEY
aws_session_token
AWS_SESSION_TOKEN
aws_sse_kms_key_id
AWS SSE KMS Key ID
region_name
AWS Region
s3_endpoint
S3 Endpoint
Response
regex_filter
Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
use_blob_urls
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.
presign
Presign URLs for download
presign_ttl
Presign TTL in minutes
recursive_scan
Scan recursively
title
Storage title
description
Storage description
project
Project ID
bucket
S3 bucket name
prefix
S3 bucket prefix
aws_access_key_id
AWS_ACCESS_KEY_ID
aws_secret_access_key
AWS_SECRET_ACCESS_KEY
aws_session_token
AWS_SESSION_TOKEN
aws_sse_kms_key_id
AWS SSE KMS Key ID
region_name
AWS Region
s3_endpoint
S3 Endpoint