Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Edge Impulse OrganizationData API

The OrganizationData API from Edge Impulse — 32 operation(s) for organizationdata.

Edge Impulse OrganizationData API is one of 34 APIs that Edge Impulse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include OrganizationData. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 39 operations across 32 paths, and defines 40 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://studio.edgeimpulse.com/v1.

39 operations 32 paths 40 schemas 3 DELETE13 GET23 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://studio.edgeimpulse.com/v1
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Edge Impulse OrganizationData API declares 3 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuthentication). An API key is passed in the cookie as jwt (JWTAuthentication). An API key is passed in the header as x-jwt-token (JWTHttpHeaderAuthentication). By default, every request must be authenticated.

Paths & Operations 39

Across 32 paths, the API surfaces 39 operations — 3 DELETE, 13 GET, 23 POST. Each is listed below with its method, path, parameters, and response codes.

OrganizationData 39
GET
/api/organizations/{organizationId}/buckets
List storage buckets
listOrganizationBuckets 1 param → 200
POST
/api/organizations/{organizationId}/buckets
Add a storage bucket
addOrganizationBucket 1 param body → 200
POST
/api/organizations/{organizationId}/buckets/verify
Verify bucket connectivity
verifyOrganizationBucket 1 param body → 200
GET
/api/organizations/{organizationId}/buckets/{bucketId}
Get storage bucket
getOrganizationBucket 2 params → 200
POST
/api/organizations/{organizationId}/buckets/{bucketId}
Update storage bucket
updateOrganizationBucket 2 params body → 200
DELETE
/api/organizations/{organizationId}/buckets/{bucketId}
Remove storage bucket
removeOrganizationBucket 2 params → 200
POST
/api/organizations/{organizationId}/buckets/{bucketId}/verify
Verify existing bucket connectivity
verifyExistingOrganizationBucket 2 params body → 200
GET
/api/organizations/{organizationId}/data
List data
listOrganizationData 5 params → 200
POST
/api/organizations/{organizationId}/data/add
Add new data
addOrganizationDataItem 1 param body → 200
POST
/api/organizations/{organizationId}/data/add-folder
Add data items from bucket
addOrganizationDataFolder 1 param body → 200
GET
/api/organizations/{organizationId}/data/download
Download data
downloadOrganizationDataItem 4 params → 200
POST
/api/organizations/{organizationId}/data/delete
Delete data
deleteOrganizationDataItems 4 params → 200
POST
/api/organizations/{organizationId}/data/clear-checklist
Clear checklist for data
clearChecklistOrganizationDataItems 4 params → 200
POST
/api/organizations/{organizationId}/data/change-dataset
Change dataset
changeDatasetOrganizationDataItems 4 params body → 200
GET
/api/organizations/{organizationId}/data/files
List files
listOrganizationFiles 5 params → 200
POST
/api/organizations/{organizationId}/data/refresh
Refresh data
refreshOrganizationData 2 params → 200
POST
/api/organizations/{organizationId}/data/bulk-metadata
Bulk update metadata
organizationBulkUpdateMetadata 1 param body → 200
GET
/api/organizations/{organizationId}/data/{dataId}
Get data metadata
getOrganizationDataItem 3 params → 200
POST
/api/organizations/{organizationId}/data/{dataId}
Update data metadata
updateOrganizationDataItem 2 params body → 200
DELETE
/api/organizations/{organizationId}/data/{dataId}
Delete data
deleteOrganizationDataItem 2 params → 200
POST
/api/organizations/{organizationId}/data/{dataId}/add
Add files
addOrganizationDataFile 2 params body → 200
GET
/api/organizations/{organizationId}/data/{dataId}/download
Download data
downloadOrganizationSingleDataItem 3 params → 200
DELETE
/api/organizations/{organizationId}/data/{dataId}/download
Delete file
deleteOrganizationDataFile 3 params → 200
GET
/api/organizations/{organizationId}/data/{dataId}/files/download
Download file
downloadOrganizationDataFile 3 params → 200
GET
/api/organizations/{organizationId}/data/{dataId}/files/preview
Preview file
previewOrganizationDataFile 3 params → 200
GET
/api/organizations/{organizationId}/data/{dataId}/transformation-jobs
Get transformation jobs for data item
getOrganizationDataItemTransformJobs 4 params → 200
POST
/api/organizations/{organizationId}/dataset
Add dataset
addOrganizationDataset 1 param body → 200
GET
/api/organizations/{organizationId}/dataset/{dataset}
Get dataset
getOrganizationDataset 2 params → 200
POST
/api/organizations/{organizationId}/dataset/{dataset}
Update dataset
updateOrganizationDataset 2 params body → 200
POST
/api/organizations/{organizationId}/dataset/{dataset}/hide
Hide dataset
hideOrganizationDataset 2 params → 200
POST
/api/organizations/{organizationId}/dataset/{dataset}/upload-link
Create pre-signed S3 upload link
createSignedUploadLinkDataset 2 params body → 200
POST
/api/organizations/{organizationId}/dataset/{dataset}/verify
Verify dataset
verifyDataset 2 params → 200
POST
/api/organizations/{organizationId}/dataset/{dataset}/files
List files in dataset
listDatasetFilesInFolder 2 params body → 200
POST
/api/organizations/{organizationId}/dataset/{dataset}/files/delete
Delete file from dataset
deleteDatasetFile 2 params body → 200
POST
/api/organizations/{organizationId}/dataset/{dataset}/files/rename
Rename file from dataset
renameDatasetFile 2 params body → 200
POST
/api/organizations/{organizationId}/dataset/{dataset}/files/download
Download file from dataset
downloadDatasetFile 2 params body → 200
GET
/api/organizations/{organizationId}/dataset/{dataset}/files/download-folder
Download folder from dataset
downloadDatasetFolder 3 params → 200
GET
/api/organizations/{organizationId}/dataset/{dataset}/files/view
View file from dataset
viewDatasetFile 3 params → 200
POST
/api/organizations/{organizationId}/dataset/{dataset}/files/preview
Preview files in a default dataset
previewDefaultFilesInFolder 2 params body → 200

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are OrganizationDataset (12 properties), OrganizationDataItem (11 properties), OrganizationBucket (9 properties), VerifyOrganizationBucketRequest (8 properties). Each schema is shown below with its type and property counts.

ListOrganizationBucketsResponse
ListPortalFilesInFolderRequest
object
3 properties 1 required
CreateSignedUploadLinkRequest
object
3 properties 3 required
StartJobResponse
VerifyOrganizationBucketRequest
object
8 properties 3 required
GetOrganizationDataItemTransformJobsResponse
VerifyOrganizationExistingBucketRequest
object
1 property 1 required
ListOrganizationFilesResponse
OrganizationDataItem
object
11 properties 11 required
DownloadPortalFileRequest
object
1 property 1 required
OrganizationDatasetTypeEnum
string
OrganizationDatasetBucket
object
5 properties 5 required
GetOrganizationBucketResponse
OrganizationBulkMetadataRequest
object
2 properties 2 required
RenamePortalFileRequest
object
2 properties 2 required
UpdateOrganizationBucketRequest
object
7 properties
SetOrganizationDataDatasetRequest
object
1 property 1 required
UpdateOrganizationDataItemRequest
object
3 properties
DownloadPortalFileResponse
StorageProvider
string
AddOrganizationBucketRequest
object
7 properties 5 required
CreateSignedUploadLinkResponse
PreviewDefaultFilesInFolderRequest
object
2 properties 2 required
GetOrganizationDataItemResponse
OrganizationAddDatasetRequest
object
5 properties 5 required
ListPortalFilesInFolderResponse
OrganizationAddDataFileRequest
object
1 property 1 required
OrganizationBucket
object
9 properties 7 required
PreviewDefaultFilesInFolderResponse
OrganizationDataset
object
12 properties 9 required
DeletePortalFileRequest
object
1 property 1 required
EntityCreatedResponse
OrganizationAddDataFolderRequest
object
5 properties 3 required
PortalFile
object
6 properties 3 required
ListOrganizationDataResponse
UpdateOrganizationDatasetRequest
object
5 properties
GetOrganizationDatasetResponse
VerifyOrganizationBucketResponse
Response object for verifying an organization's bucket connectivity. Workflow: 1. The client initiates verification by sending a GET request to /api/organizati…
OrganizationAddDataItemRequest
object
7 properties 4 required
GenericApiResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edge-impulse-organizationdata-api-openapi.yml Raw ↑

Other APIs Edge Impulse publishes across the network.

Edge Impulse Admin API
Edge Impulse Auth API
Edge Impulse Canary API
Edge Impulse CDN API
Edge Impulse Classify API
Edge Impulse Deployment API
Edge Impulse Devices API
Edge Impulse DSP API
Edge Impulse EmailVerification API
Edge Impulse Export API
Edge Impulse FeatureFlags API
Edge Impulse Health API