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 Whitelabels API

The Whitelabels API from Edge Impulse — 5 operation(s) for whitelabels.

Edge Impulse Whitelabels 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 Whitelabels. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 5 paths, and defines 21 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.

8 operations 5 paths 21 schemas 1 DELETE4 GET2 POST1 PUT

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 Whitelabels 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 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Whitelabels 8
GET
/api/whitelabels
List the registered white labels
getAllWhitelabels → 200
POST
/api/whitelabels
Create a new white label
createWhitelabel body → 200
GET
/api/whitelabel/{whitelabelIdentifier}
White label information
getWhitelabel 1 param → 200
PUT
/api/whitelabel/{whitelabelIdentifier}
Update white label
updateWhitelabel 1 param body → 200
DELETE
/api/whitelabel/{whitelabelIdentifier}
Deletes a white label
deleteWhitelabel 1 param → 200
GET
/api/whitelabel/{whitelabelIdentifier}/domain
Get white label domain
getWhitelabelDomain 1 param → 200
POST
/api/whitelabel/{whitelabelIdentifier}/deploymentTargets
Update deployment targets
updateDeploymentTargets 1 param body → 200
GET
/api/whitelabel/{whitelabelIdentifier}/impulse/blocks
Get impulse blocks
getAllImpulseBlocks 1 param → 200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Whitelabel (23 properties), CreateWhitelabelRequest (13 properties), DSPBlock (12 properties), LearnBlock (11 properties). Each schema is shown below with its type and property counts.

BlockDisplayCategory
string
Category to display this block in the UI.
BlockType
string
LearnBlock
object
11 properties 7 required
UpdateWhitelabelDeploymentTargetsRequest
object
1 property
GetWhitelabelResponse
CreateWhitelabelRequest
object
13 properties 3 required
Theme
object
7 properties 5 required
GetWhitelabelDomainResponse
CreateWhitelabelResponse
PublicProjectTierAvailability
string
For public blocks, this indicates the project tiers for which this block is available.
GetAllWhitelabelsResponse
GetImpulseBlocksResponse
DSPBlock
object
12 properties 9 required
ProjectType
string
UpdateWhitelabelInternalRequest
object
1 property
InputBlock
object
7 properties 7 required
DevelopmentBoardResponse
object
4 properties 4 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.
DSPNamedAxis
object
3 properties 3 required
GenericApiResponse
object
2 properties 1 required
Whitelabel
object
23 properties 16 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edge-impulse-whitelabels-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