White Label Admin - Update white label project

White Label Admin - Update white label project

post

White label admin only API to update project properties.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

projectIdintegerrequired

Project ID

Body

logostringoptional

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

namestringoptional

New project name.

descriptionstringoptional

projectVisibilitystring · enumoptional

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.

Options: public, private

publicProjectListedbooleanoptional

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.

lastDeployEonCompilerbooleanoptional

Call this when clicking the Eon compiler setting

lastDeployModelEnginestring · enumoptional

Model engine for last deploy

Options: tflite-eon, tflite-eon-ram-optimized, tflite

latencyDevicestringoptional

MCU used for calculating latency

experimentsstring[]optional

showCreateFirstImpulsebooleanoptional

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

labelingMethodstring · enumoptional

What labeling flow to use

Options: single_label, object_detection

selectedProjectTypeInWizardstring · enumoptional

Which option was selected in the project type wizard

Options: accelerometer, audio, image_classification, object_detection, something_else

gettingStartedStepintegeroptional

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

useGpubooleanoptional

Whether to use GPU for training

computeTimeLimitMintegeroptional

Job limit in minutes

dspFileSizeMbintegeroptional

DSP file size in MB

enterprisePerformancebooleanoptional

trainJobRamMbintegeroptional

Amount of RAM allocated to training jobs

metadataobjectoptional

New metadata about the project

readmestringoptional

Readme for the project (in Markdown)

lastAcquisitionLabelstringoptional

trainJobNotificationUidsinteger[]optional

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

dspJobNotificationUidsinteger[]optional

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

modelTestingJobNotificationUidsinteger[]optional

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

exportJobNotificationUidsinteger[]optional

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

csvImportConfigobjectoptional

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

inPretrainedModelFlowbooleanoptional

dspPageSizeintegeroptional

Set to '0' to disable DSP paging

indPauseProcessingSamplesbooleanoptional

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

showSensorDataInAcquisitionGraphbooleanoptional

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

lastDeploymentTargetstringoptional

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.

dataAcquisitionPageSizeintegeroptional

Default page size on data acquisition

dataAcquisitionViewTypestring · enumoptional

Default view type on data acquisition

Options: list, grid

dataAcquisitionGridColumnCountintegeroptional

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

dataAcquisitionGridColumnCountDetailedintegeroptional

Number of grid columns in detailed view on data acquisition

showExactSampleLengthbooleanoptional

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.

inlineEditBoundingBoxesbooleanoptional

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

defaultProfilingVariantstring · enumoptional

Last shown variant on the model testing and live classification pages. Used to keep the same view after refreshing.

Options: int8, float32, akida

enabledModelProfilingVariantsstring · enum[]optional

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

impulseListCoreMetricsHiddenColumnsstring[]optional

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

impulseListAdditionalMetricsShownColumnsstring[]optional

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

impulseListExtraColumnsstring[]optional

Which extra columns should be shown in the impulse list.

aiActionsGridColumnCountintegeroptional

Number of grid columns in AI Actions

lastShownModelEnginestring · enumoptional

Last shown model engine on the Keras/DSP/BYOM/Anomaly screens. Used to keep the same view after refreshing.

Options: tflite-eon, tflite-eon-ram-optimized, tflite

versioningStorageSizeMibintegeroptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "logo": "text",
    "name": "text",
    "description": "text",
    "projectVisibility": "public",
    "publicProjectListed": true,
    "lastDeployEonCompiler": true,
    "lastDeployModelEngine": "tflite-eon",
    "latencyDevice": "text",
    "experiments": [
      "text"
    ],
    "showCreateFirstImpulse": true,
    "labelingMethod": "single_label",
    "selectedProjectTypeInWizard": "accelerometer",
    "gettingStartedStep": 1,
    "useGpu": true,
    "computeTimeLimitM": 1,
    "dspFileSizeMb": 1,
    "enterprisePerformance": true,
    "trainJobRamMb": 1,
    "metadata": {},
    "readme": "text",
    "lastAcquisitionLabel": "text",
    "trainJobNotificationUids": [
      1
    ],
    "dspJobNotificationUids": [
      1
    ],
    "modelTestingJobNotificationUids": [
      1
    ],
    "exportJobNotificationUids": [
      1
    ],
    "csvImportConfig": {},
    "inPretrainedModelFlow": true,
    "dspPageSize": 1,
    "indPauseProcessingSamples": true,
    "showSensorDataInAcquisitionGraph": true,
    "lastDeploymentTarget": "text",
    "dataAcquisitionPageSize": 1,
    "dataAcquisitionViewType": "list",
    "dataAcquisitionGridColumnCount": 1,
    "dataAcquisitionGridColumnCountDetailed": 1,
    "showExactSampleLength": true,
    "inlineEditBoundingBoxes": true,
    "defaultProfilingVariant": "int8",
    "enabledModelProfilingVariants": [
      "int8"
    ],
    "impulseListCoreMetricsHiddenColumns": [
      "text"
    ],
    "impulseListAdditionalMetricsShownColumns": [
      "text"
    ],
    "impulseListExtraColumns": [
      "text"
    ],
    "aiActionsGridColumnCount": 1,
    "lastShownModelEngine": "tflite-eon",
    "versioningStorageSizeMib": 1
  }'

200

200

{
  "success": true,
  "error": "text"
}

OK