1 of 38

OrganizationData

List storage buckets

Add a storage bucket

Verify bucket connectivity

Get storage bucket

Update storage bucket

Remove storage bucket

Verify existing bucket connectivity

List data

Add new data

Add data items from bucket

Download data

Delete data

Clear checklist for data

Change dataset

List files

Refresh data

Bulk update metadata

Get data metadata

Update data metadata

Add files

Delete file

Download file

Preview file

Get transformation jobs for data item

Add dataset

Get dataset

Update dataset

Hide dataset

Create pre-signed S3 upload link

Verify dataset

List files in dataset

Delete file from dataset

Rename file from dataset

Download file from dataset

Download folder from dataset

View file from dataset

Preview files in a default dataset

List storage buckets

Retrieve all configured storage buckets. This does not list the secret key.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

buckets*array of OrganizationBucket (object)

id*integer

accessKey*string

S3 access key

endpoint*string

S3 endpoint

bucket*string

S3 bucket

region*string

S3 region

connected*boolean

Whether we can reach the bucket

checkConnectivityPrefixstring

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

Request

Response

Update storage bucket

Updates storage bucket details. This only updates fields that were set in the request body.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}

Path parameters

organizationId*integer

Organization ID

bucketId*integer

Bucket ID

Body

accessKeystring

S3 access key

secretKeystring

S3 secret key

endpointstring

S3 endpoint

bucketstring

S3 bucket

regionstring

S3 region

checkConnectivityPrefixstring

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

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Get storage bucket

Get storage bucket details.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}

Path parameters

organizationId*integer

Organization ID

bucketId*integer

Bucket ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

bucket*OrganizationBucket (object)

id*integer

accessKey*string

S3 access key

endpoint*string

S3 endpoint

bucket*string

S3 bucket

region*string

S3 region

connected*boolean

Whether we can reach the bucket

checkConnectivityPrefixstring

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

Request

Response

Add a storage bucket

Add a storage bucket.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets

Path parameters

organizationId*integer

Organization ID

Body

accessKey*string

S3 access key

secretKey*string

S3 secret key

endpoint*string

S3 endpoint

bucket*string

S3 bucket

region*string

S3 region

checkConnectivityPrefixstring

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

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Add new data

Add a new data item. You can add a maximum of 10000 files directly through this API. Use addOrganizationDataFile to add additional files.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/add

Path parameters

organizationId*integer

Organization ID

Body

name*string

bucketIdinteger

bucketNamestring

Name of the bucket name (as an Edge Impulse name)

dataset*string

bucketPathstring

Optional path in the bucket to create this data item (files are created under this path).

metadata*string

Key-value pair of metadata (in JSON format)

files[]*array of string (binary)

itemsstring (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

List data

Lists all data items. This can be filtered by the ?filter parameter.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data

Path parameters

organizationId*integer

Organization ID

Query parameters

datasetstring

Selected dataset

Example: "activity data"

filterstring

Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore).

Example: "dataset = 'activity data' AND (label = 'running' OR metadata->user = 'Jan Jongboom')"

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

filterParseErrorstring

dataarray of object

id*integer

name*string

bucketId*integer

bucketName*string

bucketPath*string

fullBucketPath*string

dataset*string

totalFileCount*integer

totalFileSize*integer

created*string (date-time)

metadata*object

Other propertiesstring

metadataStringForCLI*string

String that's passed in to a transformation block in --metadata (the metadata + a dataItemInfo object)

totalFileCountinteger

totalDataItemCountinteger

Request

Response

Add new data

Add a new data item. You can add a maximum of 10000 files directly through this API. Use addOrganizationDataFile to add additional files.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/add

Path parameters

organizationId*integer

Organization ID

Body

name*string

bucketIdinteger

bucketNamestring

Name of the bucket name (as an Edge Impulse name)

dataset*string

bucketPathstring

Optional path in the bucket to create this data item (files are created under this path).

metadata*string

Key-value pair of metadata (in JSON format)

files[]*array of string (binary)

itemsstring (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Update storage bucket

Updates storage bucket details. This only updates fields that were set in the request body.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}

Path parameters

organizationId*integer

Organization ID

bucketId*integer

Bucket ID

Body

accessKeystring

S3 access key

secretKeystring

S3 secret key

endpointstring

S3 endpoint

bucketstring

S3 bucket

regionstring

S3 region

checkConnectivityPrefixstring

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

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Add a storage bucket

Add a storage bucket.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets

Path parameters

organizationId*integer

Organization ID

Body

accessKey*string

S3 access key

secretKey*string

S3 secret key

endpoint*string

S3 endpoint

bucket*string

S3 bucket

region*string

S3 region

checkConnectivityPrefixstring

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

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

List storage buckets

Retrieve all configured storage buckets. This does not list the secret key.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

buckets*array of OrganizationBucket (object)

id*integer

accessKey*string

S3 access key

endpoint*string

S3 endpoint

bucket*string

S3 bucket

region*string

S3 region

connected*boolean

Whether we can reach the bucket

checkConnectivityPrefixstring

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

Request

Response

Get storage bucket

Get storage bucket details.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}

Path parameters

organizationId*integer

Organization ID

bucketId*integer

Bucket ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

bucket*OrganizationBucket (object)

id*integer

accessKey*string

S3 access key

endpoint*string

S3 endpoint

bucket*string

S3 bucket

region*string

S3 region

connected*boolean

Whether we can reach the bucket

checkConnectivityPrefixstring

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

Request

Response

Remove storage bucket

Remove a storage bucket. This will render any data in this storage bucket unreachable.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}

Path parameters

organizationId*integer

Organization ID

bucketId*integer

Bucket ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Add data items from bucket

Bulk adds data items that already exist in a storage bucket. The bucket path specified should contain folders. Each folder is added as a data item in Edge Impulse.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/add-folder

Path parameters

organizationId*integer

Organization ID

Body

dataset*string

bucketId*integer

bucketPath*string

metadataDatasetstring

typeOrganizationDatasetTypeEnum (enum)

clinicalfiles

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

Download data

Download all data for this data item.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/{dataId}/download

Path parameters

organizationId*integer

Organization ID

dataId*integer

Data ID

Query parameters

filterstring

Example: "dataset = 'activity data' AND (label = 'running' OR metadata->user = 'Jan Jongboom')"

Response

ZIP file

Body

string (binary)

Request

Response

Verify existing bucket connectivity

Verify whether we can reach a bucket before adding it.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}/verify

Path parameters

organizationId*integer

Organization ID

bucketId*integer

Bucket ID

Body

prefix*string

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

files*array of object

20 random files from the bucket.

name*string

size*integer

folderName*string

hasInfoLabelsFile*boolean

Indicates whether there are any info.labels files in this bucket. If so, those are used for category/labels.

signedUrl*string

A signed URL that allows you to PUT an item, to check whether CORS headers are set up correctly for this bucket.

Request

Response

Delete data

Delete a data item. This will remove items the items from the underlying storage if your dataset has "bucketPath" set.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/{dataId}

Path parameters

organizationId*integer

Organization ID

dataId*integer

Data ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Verify bucket connectivity

Verify whether we can reach a bucket before adding it.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/verify

Path parameters

organizationId*integer

Organization ID

Body

accessKey*string

S3 access key

secretKey*string

S3 secret key

bucket*string

S3 bucket

endpoint*string

S3 endpoint

region*string

S3 region

prefixstring

Optional prefix in the bucket. Set this if you don't have access to the full bucket for example.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

files*array of object

20 random files from the bucket.

name*string

size*integer

folderName*string

hasInfoLabelsFile*boolean

Indicates whether there are any info.labels files in this bucket. If so, those are used for category/labels.

signedUrl*string

A signed URL that allows you to PUT an item, to check whether CORS headers are set up correctly for this bucket.

Request

Response

Bulk update metadata

Bulk update the metadata of many data items in one go. This requires you to submit a CSV file with headers, one of which the columns should be named 'name'. The other columns are used as metadata keys.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/bulk-metadata

Path parameters

organizationId*integer

Organization ID

Body

dataset*string

csvFile*string (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

Change dataset

Change the dataset for selected data items.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/change-dataset

Path parameters

organizationId*integer

Organization ID

Query parameters

datasetstring

Selected dataset

Example: "activity data"

dataIds*string

Data IDs as an Array

filterstring

Example: "dataset = 'activity data' AND (label = 'running' OR metadata->user = 'Jan Jongboom')"

Body

dataset*string

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

Clear checklist for data

Clear all checklist flags for selected data items.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/clear-checklist

Path parameters

organizationId*integer

Organization ID

Query parameters

datasetstring

Selected dataset

Example: "activity data"

dataIds*string

Data IDs as an Array

filterstring

Example: "dataset = 'activity data' AND (label = 'running' OR metadata->user = 'Jan Jongboom')"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

List files

Lists all files included by the filter.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/files

Path parameters

organizationId*integer

Organization ID

Query parameters

datasetstring

Selected dataset

Example: "activity data"

filterstring

Example: "dataset = 'activity data' AND (label = 'running' OR metadata->user = 'Jan Jongboom')"

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

filterParseErrorstring

totalFileSize*integer

totalFileCount*integer

totalDataItemCount*integer

data*array of OrganizationDataItem (object)

id*integer

name*string

bucketId*integer

bucketName*string

bucketPath*string

dataset*string

totalFileCount*integer

totalFileSize*integer

created*string (date-time)

metadata*object

Other propertiesstring

files*array of object

name*string

bucketPath*string

size*integer

lastModifiedstring (date-time)

Request

Response

Get data metadata

Get a data item. This will HEAD the underlying bucket to retrieve the last file information.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/{dataId}

Path parameters

organizationId*integer

Organization ID

dataId*integer

Data ID

Query parameters

filterstring

Example: "dataset = 'activity data' AND (label = 'running' OR metadata->user = 'Jan Jongboom')"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

data*OrganizationDataItem (object)

id*integer

name*string

bucketId*integer

bucketName*string

bucketPath*string

dataset*string

totalFileCount*integer

totalFileSize*integer

created*string (date-time)

metadata*object

Other propertiesstring

files*array of object

name*string

bucketPath*string

size*integer

lastModifiedstring (date-time)

Request

Response

Add files

Add a new file to an existing data item.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/{dataId}/add

Path parameters

organizationId*integer

Organization ID

dataId*integer

Data ID

Body

files[]*array of string (binary)

itemsstring (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Delete file

Delete a single file from a data item.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/{dataId}/download

Path parameters

organizationId*integer

Organization ID

dataId*integer

Data ID

Query parameters

fileName*string

File name

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Get transformation jobs for data item

Get all transformation jobs that ran for a data item. If limit / offset is not provided then max. 20 results are returned.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/{dataId}/transformation-jobs

Path parameters

organizationId*integer

Organization ID

dataId*integer

Data ID

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

transformationJobs*array of object

id*integer

transformationJobId*integer

createProjectId*integer

created*string (date-time)

jobId*integer

jobStartedstring (date-time)

jobFinishedstring (date-time)

jobFinishedSuccessfulboolean

transformationBlockName*string

pipelineNamestring

totalTransformationJobCount*integer

Request

Response

Preview file

Preview a single file from a data item (same as downloadOrganizationDataFile but w/ content-disposition inline and could be truncated).

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/{dataId}/files/preview

Path parameters

organizationId*integer

Organization ID

dataId*integer

Data ID

Query parameters

fileName*string

File name

Response

File

Body

string (binary)

Request

Response

Update data metadata

Update the data item metadata.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/{dataId}

Path parameters

organizationId*integer

Organization ID

dataId*integer

Data ID

Body

namestring

datasetstring

metadataobject

Other propertiesstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Verify dataset

Verify whether we can reach a dataset (and return some random files, used for data sources)

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/verify

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

files*array of object

20 random files from the bucket.

name*string

size*integer

folderName*string

hasInfoLabelsFile*boolean

Indicates whether there are any info.labels files in this bucket. If so, those are used for category/labels.

signedUrl*string

A signed URL that allows you to PUT an item, to check whether CORS headers are set up correctly for this bucket.

Request

Response

Update dataset

Set information about a dataset

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Body

datasetstring

tagsarray of string

itemsstring

categorystring

typeOrganizationDatasetTypeEnum (enum)

clinicalfiles

bucketobject

id*integer

Bucket ID

path*string

Path in the bucket

dataItemNamingLevelsDeep*integer

Number of levels deep for data items, e.g. if you have folder "test/abc", with value 1 "test" will be a data item, with value 2 "test/abc" will be a data item. Only used for "clinical" datasets.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Download file from dataset

Download a file from a dataset. Will return a signed URL to the bucket.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/files/download

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Body

path*string

S3 path (within the portal)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

url*string

Signed URL to download the file

Request

Response

Hide dataset

Hide a dataset (does not remove underlying data)

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/hide

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Refresh data

Update all data items. HEADs all underlying buckets to retrieve the last file information. Use this API after uploading data directly to S3. If your dataset has bucketId and bucketPath set then this will also remove items that have been removed from S3.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/refresh

Path parameters

organizationId*integer

Organization ID

Query parameters

dataset*string

Selected dataset

Example: "activity data"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

List files in dataset

List all files and directories in specified prefix.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/files

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Body

prefix*string

S3 prefix

continuationTokenstring

Only one S3 page (1000 items typically) is returned. Pass in the continuationToken on the next request to receive the next page.

onlyFetchFoldersboolean

If set, then no files will be returned

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

files*array of PortalFile (object)

name*string

addedDatestring (date-time)

Example: "2019-07-21T17:32:28Z"

sizeinteger

ETagstring

path*string

type*enum

folderfile

continuationTokenstring

Request

Response

Get dataset

Get information about a dataset

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

dataset*OrganizationDataset (object)

dataset*string

lastFileCreated*string (date-time)

totalFileSize*integer

totalFileCount*integer

totalItemCount*integer

totalItemCountChecklistOK*integer

totalItemCountChecklistFailed*integer

tags*array of string

itemsstring

categorystring

bucketOrganizationDatasetBucket (object)

id*integer

Bucket ID

bucket*string

path*string

Path in the bucket

fullBucketPathDescription*string

Full bucket path, incl. protocol (e.g. s3://bucket/path) - to be used in the UI

dataItemNamingLevelsDeep*integer

Number of levels deep for data items, e.g. if you have folder "test/abc", with value 1 "test" will be a data item, with value 2 "test/abc" will be a data item. Only used for "clinical" type.

type*OrganizationDatasetTypeEnum (enum)

clinicalfiles

bucketPathstring

Location of the dataset within the bucket

Request

Response

Create pre-signed S3 upload link

Creates a signed link to securely upload data to s3 bucket directly from the client.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/upload-link

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Body

fileName*string

file name

fileSize*integer

file size in bytes

fileHash*string

hash to identify file changes

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

urlstring

S3 Upload Link

ETagstring

S3 File Tag

Request

Response

Rename file from dataset

Rename a file in a dataset

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/files/rename

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Body

oldPath*string

S3 path (within the portal)

newPath*string

S3 path (within the portal)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Preview files in a default dataset

Preview files and directories in a default dataset for the given prefix, with support for wildcards. This is an internal API used when starting a transformation job.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/files/preview

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Body

prefix*string

S3 prefix

itemsToList*enum

Return either files or folders matching the specified prefix

filesfolders

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

files*array of PortalFile (object)

name*string

addedDatestring (date-time)

Example: "2019-07-21T17:32:28Z"

sizeinteger

ETagstring

path*string

type*enum

folderfile

isTruncatedboolean

True if results are truncated.

truncationReasonenum

Explains why results are truncated; only present in the response if isTruncated is true. Results can be truncated if there are too many results (more than 500 matches), or if searching for more results is too expensive (for example, the dataset contains many items but very few match the given wildcard).

too-many-resultstoo-expensive-search

Request

Response

View file from dataset

View a file that's located in a dataset (requires JWT auth). File might be converted (e.g. Parquet) or truncated (e.g. CSV).

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/files/view

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Query parameters

path*string

Path to file in portal

Response

Body

string (binary)

Request

Response

Download folder from dataset

Download all files in the given folder in a dataset, ignoring any subdirectories.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/files/download-folder

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Query parameters

path*string

Path, relative to dataset

Response

ZIP file

Body

string (binary)

Request

Response

Add dataset

Add a new research dataset

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset

Path parameters

organizationId*integer

Organization ID

Body

dataset*string

tags*array of string

itemsstring

category*string

type*OrganizationDatasetTypeEnum (enum)

clinicalfiles

bucket*object

id*integer

Bucket ID

path*string

Path in the bucket

dataItemNamingLevelsDeep*integer

Number of levels deep for data items, e.g. if you have folder "test/abc", with value 1 "test" will be a data item, with value 2 "test/abc" will be a data item. Only used for "clinical" type.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

Download folder from dataset

Download all files in the given folder in a dataset, ignoring any subdirectories.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/files/download-folder

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Query parameters

path*string

Path, relative to dataset

Response

ZIP file

Body

string (binary)

Request

Response

Preview file

Preview a single file from a data item (same as downloadOrganizationDataFile but w/ content-disposition inline and could be truncated).

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/{dataId}/files/preview

Path parameters

organizationId*integer

Organization ID

dataId*integer

Data ID

Query parameters

fileName*string

File name

Response

File

Body

string (binary)

Request

Response

Download data

Download all data for this data item.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/{dataId}/download

Path parameters

organizationId*integer

Organization ID

dataId*integer

Data ID

Query parameters

filterstring

Example: "dataset = 'activity data' AND (label = 'running' OR metadata->user = 'Jan Jongboom')"

Response

ZIP file

Body

string (binary)

Request

Response

View file from dataset

View a file that's located in a dataset (requires JWT auth). File might be converted (e.g. Parquet) or truncated (e.g. CSV).

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/files/view

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Query parameters

path*string

Path to file in portal

Response

Body

string (binary)

Request

Response

Hide dataset

Hide a dataset (does not remove underlying data)

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/hide

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Refresh data

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/refresh

Path parameters

organizationId*integer

Organization ID

Query parameters

dataset*string

Selected dataset

Example: "activity data"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

Remove storage bucket

Remove a storage bucket. This will render any data in this storage bucket unreachable.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}

Path parameters

organizationId*integer

Organization ID

bucketId*integer

Bucket ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Delete data

Delete a data item. This will remove items the items from the underlying storage if your dataset has "bucketPath" set.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/{dataId}

Path parameters

organizationId*integer

Organization ID

dataId*integer

Data ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Delete file

Delete a single file from a data item.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/{dataId}/download

Path parameters

organizationId*integer

Organization ID

dataId*integer

Data ID

Query parameters

fileName*string

File name

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Bulk update metadata

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/bulk-metadata

Path parameters

organizationId*integer

Organization ID

Body

dataset*string

csvFile*string (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

Change dataset

Change the dataset for selected data items.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/change-dataset

Path parameters

organizationId*integer

Organization ID

Query parameters

datasetstring

Selected dataset

Example: "activity data"

dataIds*string

Data IDs as an Array

filterstring

Example: "dataset = 'activity data' AND (label = 'running' OR metadata->user = 'Jan Jongboom')"

Body

dataset*string

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

Clear checklist for data

Clear all checklist flags for selected data items.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/clear-checklist

Path parameters

organizationId*integer

Organization ID

Query parameters

datasetstring

Selected dataset

Example: "activity data"

dataIds*string

Data IDs as an Array

filterstring

Example: "dataset = 'activity data' AND (label = 'running' OR metadata->user = 'Jan Jongboom')"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

Add files

Add a new file to an existing data item.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/{dataId}/add

Path parameters

organizationId*integer

Organization ID

dataId*integer

Data ID

Body

files[]*array of string (binary)

itemsstring (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Update data metadata

Update the data item metadata.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/{dataId}

Path parameters

organizationId*integer

Organization ID

dataId*integer

Data ID

Body

namestring

datasetstring

metadataobject

Other propertiesstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Rename file from dataset

Rename a file in a dataset

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/files/rename

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Body

oldPath*string

S3 path (within the portal)

newPath*string

S3 path (within the portal)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Download file from dataset

Download a file from a dataset. Will return a signed URL to the bucket.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/files/download

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Body

path*string

S3 path (within the portal)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

url*string

Signed URL to download the file

Request

Response

Add data items from bucket

Bulk adds data items that already exist in a storage bucket. The bucket path specified should contain folders. Each folder is added as a data item in Edge Impulse.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/add-folder

Path parameters

organizationId*integer

Organization ID

Body

dataset*string

bucketId*integer

bucketPath*string

metadataDatasetstring

typeOrganizationDatasetTypeEnum (enum)

clinicalfiles

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

Verify dataset

Verify whether we can reach a dataset (and return some random files, used for data sources)

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/verify

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

files*array of object

20 random files from the bucket.

name*string

size*integer

folderName*string

hasInfoLabelsFile*boolean

Indicates whether there are any info.labels files in this bucket. If so, those are used for category/labels.

signedUrl*string

A signed URL that allows you to PUT an item, to check whether CORS headers are set up correctly for this bucket.

Request

Response

Get transformation jobs for data item

Get all transformation jobs that ran for a data item. If limit / offset is not provided then max. 20 results are returned.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/{dataId}/transformation-jobs

Path parameters

organizationId*integer

Organization ID

dataId*integer

Data ID

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

transformationJobs*array of object

id*integer

transformationJobId*integer

createProjectId*integer

created*string (date-time)

jobId*integer

jobStartedstring (date-time)

jobFinishedstring (date-time)

jobFinishedSuccessfulboolean

transformationBlockName*string

pipelineNamestring

totalTransformationJobCount*integer

Request

Response

Create pre-signed S3 upload link

Creates a signed link to securely upload data to s3 bucket directly from the client.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/upload-link

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Body

fileName*string

file name

fileSize*integer

file size in bytes

fileHash*string

hash to identify file changes

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

urlstring

S3 Upload Link

ETagstring

S3 File Tag

Request

Response

Verify bucket connectivity

Verify whether we can reach a bucket before adding it.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/verify

Path parameters

organizationId*integer

Organization ID

Body

accessKey*string

S3 access key

secretKey*string

S3 secret key

bucket*string

S3 bucket

endpoint*string

S3 endpoint

region*string

S3 region

prefixstring

Optional prefix in the bucket. Set this if you don't have access to the full bucket for example.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

files*array of object

20 random files from the bucket.

name*string

size*integer

folderName*string

hasInfoLabelsFile*boolean

Indicates whether there are any info.labels files in this bucket. If so, those are used for category/labels.

signedUrl*string

A signed URL that allows you to PUT an item, to check whether CORS headers are set up correctly for this bucket.

Request

Response

List data

Lists all data items. This can be filtered by the ?filter parameter.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data

Path parameters

organizationId*integer

Organization ID

Query parameters

datasetstring

Selected dataset

Example: "activity data"

filterstring

Example: "dataset = 'activity data' AND (label = 'running' OR metadata->user = 'Jan Jongboom')"

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

filterParseErrorstring

dataarray of object

id*integer

name*string

bucketId*integer

bucketName*string

bucketPath*string

fullBucketPath*string

dataset*string

totalFileCount*integer

totalFileSize*integer

created*string (date-time)

metadata*object

Other propertiesstring

metadataStringForCLI*string

String that's passed in to a transformation block in --metadata (the metadata + a dataItemInfo object)

totalFileCountinteger

totalDataItemCountinteger

Request

Response

Verify existing bucket connectivity

Verify whether we can reach a bucket before adding it.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}/verify

Path parameters

organizationId*integer

Organization ID

bucketId*integer

Bucket ID

Body

prefix*string

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

files*array of object

20 random files from the bucket.

name*string

size*integer

folderName*string

hasInfoLabelsFile*boolean

Indicates whether there are any info.labels files in this bucket. If so, those are used for category/labels.

signedUrl*string

A signed URL that allows you to PUT an item, to check whether CORS headers are set up correctly for this bucket.

Request

Response

Update dataset

Set information about a dataset

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Body

datasetstring

tagsarray of string

itemsstring

categorystring

typeOrganizationDatasetTypeEnum (enum)

clinicalfiles

bucketobject

id*integer

Bucket ID

path*string

Path in the bucket

dataItemNamingLevelsDeep*integer

Number of levels deep for data items, e.g. if you have folder "test/abc", with value 1 "test" will be a data item, with value 2 "test/abc" will be a data item. Only used for "clinical" datasets.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Add dataset

Add a new research dataset

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset

Path parameters

organizationId*integer

Organization ID

Body

dataset*string

tags*array of string

itemsstring

category*string

type*OrganizationDatasetTypeEnum (enum)

clinicalfiles

bucket*object

id*integer

Bucket ID

path*string

Path in the bucket

dataItemNamingLevelsDeep*integer

Number of levels deep for data items, e.g. if you have folder "test/abc", with value 1 "test" will be a data item, with value 2 "test/abc" will be a data item. Only used for "clinical" type.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

Get data metadata

Get a data item. This will HEAD the underlying bucket to retrieve the last file information.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/{dataId}

Path parameters

organizationId*integer

Organization ID

dataId*integer

Data ID

Query parameters

filterstring

Example: "dataset = 'activity data' AND (label = 'running' OR metadata->user = 'Jan Jongboom')"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

data*OrganizationDataItem (object)

id*integer

name*string

bucketId*integer

bucketName*string

bucketPath*string

dataset*string

totalFileCount*integer

totalFileSize*integer

created*string (date-time)

metadata*object

Other propertiesstring

files*array of object

name*string

bucketPath*string

size*integer

lastModifiedstring (date-time)

Request

Response

List files

Lists all files included by the filter.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/files

Path parameters

organizationId*integer

Organization ID

Query parameters

datasetstring

Selected dataset

Example: "activity data"

filterstring

Example: "dataset = 'activity data' AND (label = 'running' OR metadata->user = 'Jan Jongboom')"

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

filterParseErrorstring

totalFileSize*integer

totalFileCount*integer

totalDataItemCount*integer

data*array of OrganizationDataItem (object)

id*integer

name*string

bucketId*integer

bucketName*string

bucketPath*string

dataset*string

totalFileCount*integer

totalFileSize*integer

created*string (date-time)

metadata*object

Other propertiesstring

files*array of object

name*string

bucketPath*string

size*integer

lastModifiedstring (date-time)

Request

Response

List files in dataset

List all files and directories in specified prefix.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/files

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Body

prefix*string

S3 prefix

continuationTokenstring

Only one S3 page (1000 items typically) is returned. Pass in the continuationToken on the next request to receive the next page.

onlyFetchFoldersboolean

If set, then no files will be returned

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

files*array of PortalFile (object)

name*string

addedDatestring (date-time)

Example: "2019-07-21T17:32:28Z"

sizeinteger

ETagstring

path*string

type*enum

folderfile

continuationTokenstring

Request

Response

Preview files in a default dataset

Preview files and directories in a default dataset for the given prefix, with support for wildcards. This is an internal API used when starting a transformation job.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/files/preview

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Body

prefix*string

S3 prefix

itemsToList*enum

Return either files or folders matching the specified prefix

filesfolders

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

files*array of PortalFile (object)

name*string

addedDatestring (date-time)

Example: "2019-07-21T17:32:28Z"

sizeinteger

ETagstring

path*string

type*enum

folderfile

isTruncatedboolean

True if results are truncated.

truncationReasonenum

too-many-resultstoo-expensive-search

Request

Response

Get dataset

Get information about a dataset

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

dataset*OrganizationDataset (object)

dataset*string

lastFileCreated*string (date-time)

totalFileSize*integer

totalFileCount*integer

totalItemCount*integer

totalItemCountChecklistOK*integer

totalItemCountChecklistFailed*integer

tags*array of string

itemsstring

categorystring

bucketOrganizationDatasetBucket (object)

id*integer

Bucket ID

bucket*string

path*string

Path in the bucket

fullBucketPathDescription*string

Full bucket path, incl. protocol (e.g. s3://bucket/path) - to be used in the UI

dataItemNamingLevelsDeep*integer

Number of levels deep for data items, e.g. if you have folder "test/abc", with value 1 "test" will be a data item, with value 2 "test/abc" will be a data item. Only used for "clinical" type.

type*OrganizationDatasetTypeEnum (enum)

clinicalfiles

bucketPathstring

Location of the dataset within the bucket

Request

Response

Delete file from dataset

Delete a file from a dataset

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/files/delete

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Body

path*string

S3 path (within the portal)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Delete file from dataset

Delete a file from a dataset

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/files/delete

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Body

path*string

S3 path (within the portal)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response