Skip to main content
POST
/
api
/
organizations
/
{organizationId}
/
buckets
Add a storage bucket
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "accessKey": "<string>",
  "secretKey": "<string>",
  "endpoint": "<string>",
  "bucket": "<string>",
  "region": "<string>",
  "checkConnectivityPrefix": "<string>",
  "storageProvider": "s3"
}
'
{
  "success": true,
  "id": 123,
  "error": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.edgeimpulse.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
organizationId
integer
required

Organization ID

Body

application/json
​
accessKey
string
required

Access key for the storage service (e.g., S3 access key, GCS access key)

​
secretKey
string
required

Secret key for the storage service (e.g., S3 secret key, GCS secret key)

​
endpoint
string
required

Endpoint URL for the storage service (e.g., S3 endpoint, custom endpoint for other services)

​
bucket
string
required

Name of the storage bucket

​
region
string
required

Region of the storage service (if applicable)

​
checkConnectivityPrefix
string

Set this if you don't have access to the root of this bucket. Only used to verify connectivity to this bucket.

​
storageProvider
enum<string>

The type of storage provider. Defaults to 's3' if not specified.

Available options:
s3,
google,
azure,
other

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
id
integer
required

Unique identifier of the created entity.

​
error
string

Optional error description (set if 'success' was false)