Skip to main content

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.

​
Classes

​
WhitelabelsApi

edgeimpulse_api.api.whitelabels_api.WhitelabelsApi(
	api_client=None
)
Parameters
api_client=None
METHODS

​
get_all_impulse_blocks

edgeimpulse_api.api.whitelabels_api.WhitelabelsApi.get_all_impulse_blocks(
	self,
	whitelabel_identifier: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Whitelabel ID')],
	**kwargs
) ‑> edgeimpulse_api.models.get_impulse_blocks_response.GetImpulseBlocksResponse
Get impulse blocks Lists all possible DSP and ML blocks available for this white label.
Parameters
self
whitelabel_identifierAnnotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Whitelabel ID')]
**kwargs
Returns
edgeimpulse_api.models.get_impulse_blocks_response.GetImpulseBlocksResponse

​
get_whitelabel_domain

edgeimpulse_api.api.whitelabels_api.WhitelabelsApi.get_whitelabel_domain(
	self,
	whitelabel_identifier: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Whitelabel ID')],
	**kwargs
) ‑> edgeimpulse_api.models.get_whitelabel_domain_response.GetWhitelabelDomainResponse
Get white label domain Get a white label domain given its unique identifier.
Parameters
self
whitelabel_identifierAnnotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Whitelabel ID')]
**kwargs
Returns
edgeimpulse_api.models.get_whitelabel_domain_response.GetWhitelabelDomainResponse

​
update_deployment_targets

edgeimpulse_api.api.whitelabels_api.WhitelabelsApi.update_deployment_targets(
	self,
	whitelabel_identifier: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Whitelabel ID')],
	update_whitelabel_deployment_targets_request: edgeimpulse_api.models.update_whitelabel_deployment_targets_request.UpdateWhitelabelDeploymentTargetsRequest,
	**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update deployment targets Update some or all of the deployment targets enabled for this white label.
Parameters
self
whitelabel_identifierAnnotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Whitelabel ID')]
update_whitelabel_deployment_targets_requestedgeimpulse_api.models.update_whitelabel_deployment_targets_request.UpdateWhitelabelDeploymentTargetsRequest
**kwargs
Returns
edgeimpulse_api.models.generic_api_response.GenericApiResponse