EDedgeimpulse
Projects

Project information

List all information about this project.

get/api/{projectId}

Request

  • Base URL
    https://studio.edgeimpulse.com/v1
  • Auth
    • API key in header x-api-key
    • or API key in cookie jwt
    • or API key in header x-jwt-token
    • or OAuth 2
      Authorization code/v1/oauth/authorize
      Client credentials
      Implicit/v1/oauth/authorize
      Password
      Token URL/v1/oauth/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

Query parameters

impulseIdinteger

Impulse ID. If this is unset then the default impulse is used.

truncateLabelsboolean

If true, only a slice of labels will be returned.

datasetVersionIdinteger

Dataset version ID. If not set, the current mutable dataset is used

Response

OK

successboolean required

Whether the operation succeeded

errorstring

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

showCreateFirstImpulseboolean required
trainJobNotificationUidsinteger[] required

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

dspJobNotificationUidsinteger[] required

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

modelTestingJobNotificationUidsinteger[] required

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

exportJobNotificationUidsinteger[] required

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

hasNewTrainingDataboolean required
csvImportConfigobject

Config file specifying how to process CSV files.

studioUrlstring required
inPretrainedModelFlowboolean required

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

dspPageSizeinteger
windowJobConcurrencyinteger
showSensorDataInAcquisitionGraphboolean required

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

notificationsstring[] required

List of notifications to show within the project

defaultImpulseIdinteger

Default selected impulse (by ID).

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

Whether this project has a first-class validation dataset alongside training and testing.

Changes

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