Edge Impulse Organizations API
The Organizations API from Edge Impulse — 60 operation(s) for organizations.
Edge Impulse Organizations 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 Organizations. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 78 operations across 60 paths, and defines 111 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.
78 operations
60 paths
111 schemas
10 DELETE28 GET37 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Edge Impulse Organizations 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 78
Across 60 paths, the API surfaces 78 operations — 10 DELETE, 28 GET, 37 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
Organizations 78
GET
/api/organizations
List active organizations
POST
/api/organizations/create
Create new organization
GET
/api/organizations/{organizationId}
Organization information
POST
/api/organizations/{organizationId}
Update organization
DELETE
/api/organizations/{organizationId}
Remove organization
POST
/api/organizations/{organizationId}/trial/request-extension
Request trial extension
GET
/api/organizations/{organizationId}/metrics
Organization metrics
POST
/api/organizations/{organizationId}/request-hr-block-license
Request HR block license
POST
/api/organizations/{organizationId}/limits-request
Request organization limits increase
GET
/api/organizations/{organizationId}/whitelabel
White Label Admin - Get white label information
PUT
/api/organizations/{organizationId}/whitelabel
White Label Admin - Update white label information
POST
/api/organizations/{organizationId}/whitelabel/deploymentTargets
White Label Admin - Update deployment targets
POST
/api/organizations/{organizationId}/whitelabel/deploymentTargets/default
White Label Admin - Update default deployment target
POST
/api/organizations/{organizationId}/whitelabel/deploymentOptionsOrder
White Label Admin - Update the order of deployment options in the deployment view
POST
/api/organizations/{organizationId}/whitelabel/learningBlocks
White Label Admin - Update learning blocks
POST
/api/organizations/{organizationId}/whitelabel/theme/logo
White Label Admin - Update theme logo
POST
/api/organizations/{organizationId}/whitelabel/theme/deviceLogo
White Label Admin - Update theme device logo
POST
/api/organizations/{organizationId}/whitelabel/theme/colors
White Label Admin - Update theme colors
POST
/api/organizations/{organizationId}/whitelabel/theme/favicon
White Label Admin - Update theme favicon
GET
/api/organizations/{organizationId}/whitelabel/metrics
White Label Admin - Get global white label metrics
GET
/api/organizations/{organizationId}/whitelabel/users
White Label Admin - Get all white label users
GET
/api/organizations/{organizationId}/whitelabel/users/{userId}
White Label Admin - Get a white label user
POST
/api/organizations/{organizationId}/whitelabel/users/{userId}
White Label Admin - Update white label user
DELETE
/api/organizations/{organizationId}/whitelabel/users/{userId}
Delete a user
GET
/api/organizations/{organizationId}/whitelabel/users/{userId}/metrics
White Label Admin - Get white label user metrics
GET
/api/organizations/{organizationId}/whitelabel/users/{userId}/jobs
White Label Admin - Get user jobs
GET
/api/organizations/{organizationId}/whitelabel/projects
White Label Admin - Get all white label projects
POST
/api/organizations/{organizationId}/whitelabel/projects
White Label Admin - Create a new project within white label context.
GET
/api/organizations/{organizationId}/whitelabel/projects/{projectId}
White Label Admin - Get a white label project
POST
/api/organizations/{organizationId}/whitelabel/projects/{projectId}
White Label Admin - Update white label project
DELETE
/api/organizations/{organizationId}/whitelabel/projects/{projectId}
White Label Admin - Delete a project
POST
/api/organizations/{organizationId}/whitelabel/projects/{projectId}/apiKeys
White Label Admin - Add Project API key
POST
/api/organizations/{organizationId}/whitelabel/projects/{projectId}/members
White Label Admin - Add user to a project
DELETE
/api/organizations/{organizationId}/whitelabel/projects/{projectId}/members/{userId}
White Label Admin - Remove user from a project
GET
/api/organizations/{organizationId}/whitelabel/projects/{projectId}/jobs
White Label Admin - Get project jobs
POST
/api/organizations/{organizationId}/whitelabel/development-boards
White Label Admin - Add a development board to a whitelabel
PUT
/api/organizations/{organizationId}/whitelabel/development-boards/{developmentBoardId}
White Label Admin - Update a development board in a whitelabel
DELETE
/api/organizations/{organizationId}/whitelabel/development-boards/{developmentBoardId}
White Label Admin - Remove a development board from a whitelabel
POST
/api/organizations/{organizationId}/whitelabel/development-boards/{developmentBoardId}/image
White Label Admin - Update the image of a whitelabel development board
GET
/api/organizations/{organizationId}/whitelabel/organizations
White Label Admin - Get all organizations within a white label
POST
/api/organizations/{organizationId}/whitelabel/organizations
White Label Admin - Create new organization within white label context
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/computeTime
White Label Admin - Get organization compute time usage
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports
White Label Admin - Get all usage reports
POST
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports
White Label Admin - Creates a new usage report
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports/{reportId}
White Label Admin - Get usage report
DELETE
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports/{reportId}
White Label Admin - Delete usage report
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports/{reportId}/download
White Label Admin - Download usage report
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports
White Label Admin - Get all organization data exports
POST
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports
White Label Admin - Create a new organization data export
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports/{exportId}
White Label Admin - Get organization data export
DELETE
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports/{exportId}
White Label Admin - Delete organization data export
PUT
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports/{exportId}
White Label Admin - Update organization data export
POST
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/apiKeys
White Label Admin - Add organization API key
POST
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/members
White Label Admin - Add user to an organization
DELETE
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/members/{userId}
White Label Admin - Remove user from an organization
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}
White Label Admin - Get organization information
POST
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}
White Label Admin - Update organization
DELETE
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}
White Label Admin - Delete an organization
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/restore
White Label Admin - Restore an organization
POST
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/projects
White Label Admin - Create a new organization project
GET
/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/jobs
White Label Admin - Get organization jobs
POST
/api/organizations/{organizationId}/logo
Upload organization logo
POST
/api/organizations/{organizationId}/header
Upload organization header image
GET
/api/organizations/{organizationId}/test-admin
Admin endpoint
GET
/api/organizations/{organizationId}/projects
Get projects
GET
/api/organizations/{organizationId}/apikeys
Get API keys
POST
/api/organizations/{organizationId}/apikeys
Add API key
DELETE
/api/organizations/{organizationId}/apikeys/{apiKeyId}
Revoke API key
POST
/api/organizations/{organizationId}/members/add
Add member
POST
/api/organizations/{organizationId}/members/invite
Invite member
POST
/api/organizations/{organizationId}/members/remove
Remove member
POST
/api/organizations/{organizationId}/members/{memberId}/role
Set member role
POST
/api/organizations/{organizationId}/members/{memberId}/datasets
Set member datasets
POST
/api/organizations/{organizationId}/members/{memberId}/resend-invite
Resend invitation
POST
/api/organizations/{organizationId}/readme/upload-image
Upload image for readme
GET
/api/organizations/{organizationId}/exports
Get all organization data exports
GET
/api/organizations/{organizationId}/exports/{exportId}
Get organization data export
GET
/api/organizations/{organizationId}/exports/{exportId}/download
Download organization data export
Schemas 111
The contract defines 111 schemas that model the data the API accepts and returns. The most detailed are UpdateProjectRequest (43 properties), Project (29 properties), Whitelabel (23 properties), DailyMetricsRecord (20 properties). Each schema is shown below with its type and property counts.
UpdateWhitelabelDefaultDeploymentTargetRequest
object
1 property
1 required
EntitlementLimits
object
5 properties
UpdateWhitelabelDeploymentOptionsOrderRequest
object
1 property
DevelopmentBoardRequestUpdate
object
3 properties
Report
object
9 properties
7 required
OrganizationDataExport
object
9 properties
6 required
ListJobsResponse
UpdateWhitelabelLearningBlocksRequest
object
1 property
ProjectCollaborator
CreateOrganizationResponse
ApplicationBudget
object
Specifies limits for your specific application, as available RAM and ROM for the model's operation and the maximum allowed latency.
3 properties
AdminAddProjectUserRequest
ModelEngineShortEnum
string
WhitelabelAdminCreateOrganizationRequest
object
3 properties
1 required
UpdateWhitelabelRequest
object
Only fields set in this object will be updated.
1 property
EnterpriseLimitsIncreaseRequest
object
2 properties
1 required
DevelopmentBoardResponse
object
4 properties
4 required
EnterpriseLimit
string
InviteOrganizationMemberRequest
object
3 properties
3 required
DeploymentOptionsOrder
array
Optional attribute allowing a whitelabel to customize the order of deployment options in the deployment view, given as an in-order list of deployment options.
UpdateOrganizationRequest
object
Only fields set in this object will be updated.
7 properties
AdminGetUserMetricsResponse
Organization
object
15 properties
10 required
ListProjects
object
1 property
1 required
ProjectInfoResponse
Device
object
12 properties
10 required
ListOrganizationApiKeysResponse
KerasModelVariantEnum
string
AdminUpdateUserRequest
object
Only fields set in this object will be updated.
6 properties
AdminCreateProjectRequest
object
4 properties
1 required
StartJobResponse
AdminGetOrganizationComputeTimeUsageResponse
DevelopmentBoardRequest
object
3 properties
3 required
EnterpriseTrial
object
9 properties
8 required
AddApiKeyRequest
object
2 properties
1 required
ProjectDataSummary
object
3 properties
3 required
MemorySpec
object
Describes performance characteristics of a particular memory type
2 properties
Permission
string
AdminUpdateOrganizationDataExportRequest
object
2 properties
OrganizationMemberRole
string
Job
object
12 properties
5 required
OrganizationUser
AdminGetUserResponse
TrialNotes
string
Notes about the trial. Free form text. This field is ignored if the trial is requested by a non-admin user.
AdminOrganizationInfoResponse
User
object
18 properties
9 required
DailyMetricsRecord
object
20 properties
18 required
AdminGetUsersResponse
EntityCreatedResponse
RemoveMemberRequest
object
1 property
1 required
TrialExpirationDate
string
Expiration date of the trial. The trial will be set as expired after this date. There will be a grace period of 30 days after a trial expires before fully dele…
EnterpriseUpgradeOrTrialExtensionRequest
object
5 properties
UserExperiment
object
5 properties
4 required
Whitelabel
object
23 properties
16 required
UploadImageRequest
object
1 property
1 required
GetOrganizationDataExportsResponse
AdminUpdateOrganizationRequest
object
Only fields set in this object will be updated.
9 properties
UpdateThemeColorsRequest
object
Only fields set in this object will be updated.
2 properties
UpdateWhitelabelDeploymentTargetsRequest
object
1 property
ProjectVisibility
string
The visibility of the project, either public or private. Public projects can be viewed by anyone on the internet and edited by collaborators. Private projects…
OrganizationDatasetTypeEnum
string
TargetProcessor
object
8 properties
AdminGetOrganizationsResponse
UploadAssetResponse
LatencyDevice
object
8 properties
8 required
UserTierEnum
string
The user account tier.
ListProjectsResponse
StaffInfo
object
3 properties
2 required
SetMemberDatasetsRequest
object
1 property
1 required
TargetConstraintsDevice
object
4 properties
ObjectDetectionLastLayer
string
ProjectType
string
AddMemberRequest
object
3 properties
3 required
AddOrganizationApiKeyRequest
OrganizationDataset
object
12 properties
9 required
AdminAddProjectApiKeyRequest
AdminGetReportsResponse
AdminCreateOrganizationDataExportRequest
object
2 properties
1 required
GetOrganizationDataExportResponse
ListOrganizationsResponse
GenericApiResponse
object
2 properties
1 required
OrganizationInfoResponse
CreateProjectResponse
OrganizationComputeTimeUsage
object
3 properties
AdminApiUser
AdminAddUserRequest
object
1 property
GetWhitelabelResponse
UploadReadmeImageResponse
TargetConstraints
object
3 properties
2 required
AdminApiProject
object
11 properties
3 required
Theme
object
7 properties
5 required
AdminAddOrganizationUserRequest
ResourceRange
object
Describes range of expected availability for an arbitrary resource
2 properties
AdminAddOrganizationApiKeyRequest
OrganizationDatasetBucket
object
5 properties
5 required
Project
object
29 properties
17 required
DevelopmentKeys
object
2 properties
ProjectTierEnum
string
The project tier. This is "enterprise" for all organization projects, or the user tier for all user projects.
OrganizationMetricsResponse
UpdateProjectRequest
object
Only fields set in this object will be updated.
43 properties
AdminGetReportResponse
SetMemberRoleRequest
object
1 property
1 required
CreateOrganizationRequest
object
1 property
1 required
AddApiKeyResponse
AdminListProjectsResponse
UserOrganization
object
15 properties
13 required
AdminGetMetricsResponse
ImageInputScaling
string
Normalization that is applied to images. If this is not set then 0..1 is used. "0..1" gives you non-normalized pixels between 0 and 1. "-1..1" gives you non-no…
AdminListProjects
object
2 properties
2 required
TargetMemory
object
RAM and ROM specifications of target
2 properties
UploadAssetRequest
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Edge Impulse 12
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
#Organizations