Organizations

White Label Admin - Update white label project

White label admin only API to update project properties.

post/api/organizations/{organizationId}/whitelabel/projects/{projectId}

Request

Path parameters

organizationIdinteger required

Organization ID

projectIdinteger required

Project ID

Request body

logostring

New logo URL, or set to null to remove the logo.

namestring

New project name.

descriptionstring
projectVisibility'public' | 'private'

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 can only be viewed and edited by collaborators.

publicProjectListedboolean

If the project allows public access, whether to list it the public projects overview response. If not listed, the project is still accessible via direct link. If the project does not allow public access, this field has no effect.

lastDeployEonCompilerboolean

Call this when clicking the Eon compiler setting

lastDeployModelEngine'tflite-eon' | 'tflite-eon-ram-optimized' | 'tflite'
latencyDevicestring

MCU used for calculating latency

experimentsstring[]
showCreateFirstImpulseboolean

Whether to show the 'Create your first impulse' section on the dashboard

labelingMethod'single_label' | 'object_detection' | 'label_map'
selectedProjectTypeInWizard'accelerometer' | 'audio' | 'image_classification' | 'object_detection' | 'something_else'

Which option was selected in the project type wizard

gettingStartedStepinteger

The next step in the getting started wizard, or set to -1 to clear the getting started wizard

gettingStartedTutorial'kws' | 'cv'

The type of in-product guided tutorial to show in the getting started wizard

gettingStartedClassesstring[]

Classes or labels used in the getting started wizard

useGpuboolean

Whether to use GPU for training

computeTimeLimitMinteger

Job limit in minutes

dspFileSizeMbinteger

DSP file size in MB

enterprisePerformanceboolean
trainJobRamMbinteger

Amount of RAM allocated to training jobs

metadataobject

New metadata about the project

readmestring

Readme for the project (in Markdown)

lastAcquisitionLabelstring
trainJobNotificationUidsinteger[]

The IDs of users who should be notified when a Keras or retrain job is finished.

dspJobNotificationUidsinteger[]

The IDs of users who should be notified when a DSP job is finished.

modelTestingJobNotificationUidsinteger[]

The IDs of users who should be notified when a model testing job is finished.

exportJobNotificationUidsinteger[]

The IDs of users who should be notified when an export job is finished.

csvImportConfigobject

Config file specifying how to process CSV files. (set to null to clear the config)

inPretrainedModelFlowboolean

DEPRECATED. To enable the pretrained model flow, set the impulse type property to "BYOM" instead.

dspPageSizeinteger

Set to '0' to disable DSP paging

windowJobConcurrencyinteger

Used to override window job concurrency used during feature generation. This option is experimental and may change in the future.

indPauseProcessingSamplesboolean

Used in tests, to ensure samples that need to be processed async are not picked up until the flag is set to FALSE again.

showSensorDataInAcquisitionGraphboolean

Whether to show the actual sensor data in acquisition charts (only applies when you have structured labels)

lastDeploymentTargetstring

Which deployment target was last selected (used to populate this deployment target again the next time you visit the deployment page). Should match the format property of the response from listDeploymentTargetsForProject.

dataAcquisitionPageSizeinteger

Default page size on data acquisition

dataAcquisitionViewType'list' | 'grid'

Default view type on data acquisition

dataAcquisitionGridColumnCountinteger

Number of grid columns in non-detailed view on data acquisition

dataAcquisitionGridColumnCountDetailedinteger

Number of grid columns in detailed view on data acquisition

showExactSampleLengthboolean

If enabled, does not round sample length to hours/minutes/seconds, but always displays sample length in milliseconds. E.g. instead of 1m 32s, this'll say 92,142ms.

inlineEditBoundingBoxesboolean

If enabled, allows editing bounding box labels directly from the acquisition UI.

defaultProfilingVariant'int8' | 'float32' | 'akida'
enabledModelProfilingVariantsKerasModelVariantEnum[]

Set of model variants enabled by default on the model testing and live classification pages.

impulseListCoreMetricsHiddenColumnsstring[]

Which core metrics should be hidden in the impulse list. See 'GetAllDetailedImpulsesResponse' for a list of all metrics.

impulseListAdditionalMetricsShownColumnsstring[]

Which additional metrics should be shown in the impulse list. See 'GetAllDetailedImpulsesResponse' for a list of all metrics.

impulseListExtraColumnsstring[]

Which extra columns should be shown in the impulse list.

aiActionsGridColumnCountinteger

Number of grid columns in AI Actions

lastShownModelEngine'tflite-eon' | 'tflite-eon-ram-optimized' | 'tflite'
versioningStorageSizeMibinteger
explicitValidationEnabledboolean

Enables a first-class validation dataset alongside training and testing.

Response

OK

successboolean required

Whether the operation succeeded

errorstring

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

Changes

No recorded changes to this operation across all 1 revision of this API.