Update project

Update project properties such as name and logo.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}

Path parameters

projectId*integer

Project ID

Body

logostring

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

namestring

New project name.

descriptionstring

projectVisibilityProjectVisibility (enum)

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.

publicprivate

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

lastDeployModelEngineModelEngineShortEnum (enum)

tflite-eontflite-eon-ram-optimizedtflite

latencyDevicestring

MCU used for calculating latency

experimentsarray of string

showCreateFirstImpulseboolean

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

labelingMethodenum

What labeling flow to use

single_labelobject_detection

selectedProjectTypeInWizardenum

Which option was selected in the project type wizard

accelerometeraudioimage_classificationobject_detectionsomething_else

gettingStartedStepinteger

The next step in the getting started wizard, or set to -1 to clear 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

trainJobNotificationUidsarray of integer

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

dspJobNotificationUidsarray of integer

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

modelTestingJobNotificationUidsarray of integer

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

autoSegmenterJobNotificationUidsarray of integer

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

exportJobNotificationUidsarray of integer

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

dspPageSizeinteger

Set to '0' to disable DSP paging

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

dataAcquisitionViewTypeenum

Default view type on data acquisition

listgrid

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.

defaultProfilingVariantKerasModelVariantEnum (enum)

int8float32akida

enabledModelProfilingVariantsarray of KerasModelVariantEnum (enum)

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

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

PreviousProject information NextRemove project

Last updated 2 months ago

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();