Update project

Update project

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

{
  "success": true,
  "error": "<string>"
}

POST

api

{projectId}

Update project

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

{
  "success": true,
  "error": "<string>"
}

Authorizations

x-api-key

string

header

required

Path Parameters

projectId

integer

required

Project ID

Body

application/json

Only fields set in this object will be updated.

logo

string

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

name

string

New project name.

description

string

projectVisibility

enum<string>

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.

Available options:

public,

private

publicProjectListed

boolean

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.

lastDeployEonCompiler

boolean

Call this when clicking the Eon compiler setting

lastDeployModelEngine

enum<string>

Model engine for last deploy

Available options:

tflite-eon,

tflite-eon-ram-optimized,

tflite

latencyDevice

string

MCU used for calculating latency

experiments

string[]

showCreateFirstImpulse

boolean

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

labelingMethod

enum<string>

What labeling flow to use

Available options:

single_label,

object_detection

selectedProjectTypeInWizard

enum<string>

Which option was selected in the project type wizard

Available options:

accelerometer,

audio,

image_classification,

object_detection,

something_else

gettingStartedStep

integer

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

gettingStartedTutorial

enum<string>

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

Available options:

kws,

cv

gettingStartedClasses

string[]

Classes or labels used in the getting started wizard

useGpu

boolean

Whether to use GPU for training

computeTimeLimitM

integer

Job limit in minutes

dspFileSizeMb

integer

DSP file size in MB

enterprisePerformance

boolean

trainJobRamMb

integer

Amount of RAM allocated to training jobs

metadata

object

New metadata about the project

readme

string

Readme for the project (in Markdown)

lastAcquisitionLabel

string

trainJobNotificationUids

integer[]

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

dspJobNotificationUids

integer[]

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

modelTestingJobNotificationUids

integer[]

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

exportJobNotificationUids

integer[]

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

csvImportConfig

object

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

inPretrainedModelFlow

boolean

dspPageSize

integer

Set to '0' to disable DSP paging

indPauseProcessingSamples

boolean

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

showSensorDataInAcquisitionGraph

boolean

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

lastDeploymentTarget

string

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.

dataAcquisitionPageSize

integer

Default page size on data acquisition

dataAcquisitionViewType

enum<string>

Default view type on data acquisition

Available options:

list,

grid

dataAcquisitionGridColumnCount

integer

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

dataAcquisitionGridColumnCountDetailed

integer

Number of grid columns in detailed view on data acquisition

showExactSampleLength

boolean

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.

inlineEditBoundingBoxes

boolean

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

defaultProfilingVariant

enum<string>

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

Available options:

int8,

float32,

akida

enabledModelProfilingVariants

enum<string>[]

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

Show child attributes

impulseListCoreMetricsHiddenColumns

string[]

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

impulseListAdditionalMetricsShownColumns

string[]

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

impulseListExtraColumns

string[]

Which extra columns should be shown in the impulse list.

aiActionsGridColumnCount

integer

Number of grid columns in AI Actions

lastShownModelEngine

enum<string>

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

Available options:

tflite-eon,

tflite-eon-ram-optimized,

tflite

versioningStorageSizeMib

integer

Response

200 - application/json

success

boolean

required

Whether the operation succeeded

error

string

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

Project information

Remove project

OVERVIEW

STUDIO API ENDPOINTS

Authorizations

Path Parameters

Body

Response