Storages

Cloud storage configuration

Get Storages

get
/storages

Retrieves all storage configurations for your organization

Authorizations
apikeystringRequired

API key for authentication. Format - apikey YOUR_API_KEY

Query parameters
pageinteger · min: 1Optional

Page number (1-indexed)

Default: 1
limitinteger · min: 1 · max: 100Optional

Items per page (max 100)

Default: 10
Responses
200

Storages retrieved successfully

application/json
get
/storages
200

Storages retrieved successfully

Create Storage

post
/storages

Creates a new cloud storage configuration

Authorizations
apikeystringRequired

API key for authentication. Format - apikey YOUR_API_KEY

Body
namestringRequired
typestring · enumRequiredPossible values:
bucketstringRequired
regionstringOptional
credentialsobjectRequired

Storage provider credentials

privateKeystringOptional

Private key (for GCS)

Responses
200

Storage created successfully

application/json
post
/storages

Delete Storage

delete
/storages/{storageId}

Deletes a storage configuration

Authorizations
apikeystringRequired

API key for authentication. Format - apikey YOUR_API_KEY

Path parameters
storageIdstringRequired

Storage ID

Responses
200

Storage deleted successfully

application/json
delete
/storages/{storageId}
200

Storage deleted successfully

List Storage Files

get
/storages/{storageId}/files

Lists files recursively in a cloud storage bucket. This endpoint allows you to browse and retrieve file listings from your configured storage integrations (AWS S3, Google Cloud Storage, Azure Blob Storage, or Custom S3-compatible storage).

Features:

  • Recursive directory listing

  • Optional signed URL generation for direct file access

  • Automatic retry mechanism for S3 rate limit errors

  • Support for path-based filtering

Use Cases:

  • Browse storage bucket contents before importing

  • Generate signed URLs for batch asset uploads

  • Validate storage configuration and access

  • List available datasets for annotation projects

Authorizations
apikeystringRequired

API key for authentication. Format - apikey YOUR_API_KEY

Path parameters
storageIdstringRequired

Storage configuration ID

Example: 507f1f77bcf86cd799439011
Query parameters
bucketNamestringRequired

Name of the bucket/container to list files from

Example: my-annotation-data
pathstringOptional

Directory path to list files from. Defaults to root directory if not specified.

Default: ""Example: datasets/images/2024
getSignedUrlsstring · enumOptional

Whether to generate signed URLs for each file. Signed URLs provide temporary authenticated access to private files.

  • true: Returns signed URLs (24-hour expiry)
  • false: Returns file metadata only (default)
Default: falseExample: truePossible values:
retryOnSlowDownstring · enumOptional

Enable automatic retry mechanism for S3 SlowDown errors (rate limiting). When enabled, the API will automatically retry with exponential backoff.

  • true: Retry on rate limit errors (default)
  • false: Fail immediately on rate limit errors
Default: trueExample: truePossible values:
Responses
200

Files retrieved successfully

application/json
get
/storages/{storageId}/files

Last updated