Sign in

v76

OpenAPI 3.0.3raw.githubusercontent.com2026-08-015764591.5 MB
Storage: S3

Create new S3 storage

Create new S3 import storage

post/api/storages/s3/

Request body

aws_access_key_idstring

AWS_ACCESS_KEY_ID

aws_secret_access_keystring

AWS_SECRET_ACCESS_KEY

aws_session_tokenstring

AWS_SESSION_TOKEN

aws_sse_kms_key_idstring

AWS SSE KMS Key ID

bucketstring

S3 bucket name

descriptionstring

Storage description

prefixstring

S3 bucket prefix

presignboolean

Presign URLs for download

presign_ttlinteger

Presign TTL in minutes

projectinteger

Project ID

recursive_scanboolean

Scan recursively

regex_filterstring

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

region_namestring

AWS Region

s3_endpointstring

S3 Endpoint

titlestring

Storage title

use_blob_urlsboolean

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.

Response

aws_access_key_idstring nullable

AWS_ACCESS_KEY_ID

aws_secret_access_keystring nullable

AWS_SECRET_ACCESS_KEY

aws_session_tokenstring nullable

AWS_SESSION_TOKEN

aws_sse_kms_key_idstring nullable

AWS SSE KMS Key ID

bucketstring nullable

S3 bucket name

created_atstring date-time required

Creation time

descriptionstring nullable

Cloud storage description

idinteger required
last_syncstring date-time nullable

Last sync finished time

last_sync_countinteger nullable

Count of tasks synced last time

last_sync_jobstring nullable

Last sync job ID

{"stackTrail":"components:schemas:S3ImportStorage:properties:meta","oasType":"schema","type":"unknown","description":"Meta and debug information about storage processes","nullable":true}
prefixstring nullable

S3 bucket prefix

presignboolean
presign_ttlinteger

Presigned URLs TTL (in minutes)

projectinteger required

A unique integer value identifying this project.

recursive_scanboolean

Perform recursive scan over the bucket content

regex_filterstring nullable

Cloud storage regex for filtering objects

region_namestring nullable

AWS Region

s3_endpointstring nullable

S3 Endpoint

status'initialized' | 'queued' | 'in_progress' | 'failed' | 'completed' | 'completed_with_errors'
  • initialized - Initialized
  • queued - Queued
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
  • completed_with_errors - Completed with errors
synchronizableboolean
titlestring nullable

Cloud storage title

tracebackstring nullable

Traceback report for the last failed sync

typestring required
use_blob_urlsboolean

Interpret objects as BLOBs and generate URLs