Project information

Project information

List all information about this project.

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

Path parameters

projectId*integer

Project ID

Query parameters

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

project*Project (object)

developmentKeys*DevelopmentKeys (object)

impulse*object

devices*array of Device (object)

dataSummary*ProjectDataSummary (object)

dataSummaryPerCategory*object

computeTime*object

acquisitionSettings*object

collaborators*array of User (object)

deploySettings*object

experiments*array of object

Experiments that the project has access to. Enabling experiments can only be done through a JWT token.

latencyDevices*array of LatencyDevice (object)

urls*object

showCreateFirstImpulse*boolean

showGettingStartedWizard*object

performance*object

readmeobject

Present if a readme is set for this project

trainJobNotificationUids*array of integer

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

dspJobNotificationUids*array of integer

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

modelTestingJobNotificationUids*array of integer

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

autoSegmenterJobNotificationUids*array of integer

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

exportJobNotificationUids*array of integer

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

hasNewTrainingData*boolean

csvImportConfigobject

Config file specifying how to process CSV files.

studioUrl*string

inPretrainedModelFlow*boolean

dspPageSizeinteger

showSensorDataInAcquisitionGraph*boolean

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

targetConstraintsTargetConstraints (object)

notifications*array of string

List of notifications to show within the project

defaultImpulseIdinteger

Default selected impulse (by ID).

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "error": "text",
  "project": {
    "id": 1,
    "name": "Water hammer detection",
    "description": "text",
    "created": "2019-07-21T17:32:28Z",
    "owner": "text",
    "lastAccessed": "2019-07-21T17:32:28Z",
    "lastModified": "2019-07-21T17:32:28Z",
    "lastModificationDetails": "Data sample added",
    "logo": "text",
    "ownerAvatar": "text",
    "ownerIsDeveloperProfile": false,
    "collaborators": [
      {
        "id": 1,
        "username": "janjongboom",
        "name": "Jan Jongboom",
        "email": "[e-mail]",
        "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
        "created": "2019-08-31T17:32:28Z",
        "lastSeen": "2019-08-31T17:32:28Z",
        "staffInfo": {
          "isStaff": false,
          "hasSudoRights": false,
          "companyName": "text"
        },
        "pending": false,
        "lastTosAcceptanceDate": "2019-08-31T17:32:28Z",
        "jobTitle": "Software Engineer",
        "permissions": [
          "admin:infra:disallowedEmailDomains:write"
        ],
        "companyName": "Edge Impulse Inc.",
        "activated": false,
        "mfaConfigured": false,
        "stripeCustomerId": "text",
        "hasPendingPayments": false,
        "tier": "free",
        "isOwner": false
      }
    ],
    "labelingMethod": "single_label",
    "dataExplorerScreenshot": "text",
    "isEnterpriseProject": false,
    "tags": [
      "FOMO",
      "beers"
    ],
    "category": "Image classification",
    "license": "text",
    "tier": "free",
    "hasPublicVersion": false,
    "isPublic": false,
    "allowsLivePublicAccess": false,
    "indPauseProcessingSamples": false,
    "publicProjectListed": false
  },
  "developmentKeys": {
    "apiKey": "text",
    "hmacKey": "text"
  },
  "impulse": {
    "created": false,
    "configured": false,
    "complete": false
  },
  "devices": [
    {
      "id": 1,
      "deviceId": "38:f9:d3:d7:62:03",
      "created": "2019-07-21T17:32:28Z",
      "lastSeen": "2019-08-31T17:32:28Z",
      "name": "m6d.1 desk sensor",
      "deviceType": "DISCO-L475VG",
      "sensors": [
        {
          "name": "Built-in accelerometer",
          "frequencies": [
            62.5,
            100
          ]
        }
      ],
      "remote_mgmt_connected": false,
      "remote_mgmt_host": "text",
      "supportsSnapshotStreaming": false,
      "remoteMgmtMode": "disconnected",
      "inferenceInfo": {
        "projectOwner": "text",
        "projectName": "text",
        "modelType": "classification"
      }
    }
  ],
  "dataSummary": {
    "totalLengthMs": "726336",
    "labels": [
      "text"
    ],
    "dataCount": "Number of files in the training set"
  },
  "dataSummaryPerCategory": {
    "training": {
      "totalLengthMs": "726336",
      "labels": [
        "text"
      ],
      "dataCount": "Number of files in the training set"
    },
    "testing": {
      "totalLengthMs": "726336",
      "labels": [
        "text"
      ],
      "dataCount": "Number of files in the training set"
    },
    "anomaly": {
      "totalLengthMs": "726336",
      "labels": [
        "text"
      ],
      "dataCount": "Number of files in the training set"
    }
  },
  "computeTime": {
    "periodStartDate": "2024-11-21T08:58:59.076Z",
    "periodEndDate": "2024-11-21T08:58:59.076Z"
  },
  "acquisitionSettings": {
    "intervalMs": 0,
    "sensor": "text",
    "label": "text",
    "segmentLength": 0,
    "segmentShift": false,
    "viewType": "list",
    "showExactSampleLength": false,
    "inlineEditBoundingBoxes": false
  },
  "collaborators": [
    {
      "id": 1,
      "username": "janjongboom",
      "name": "Jan Jongboom",
      "email": "[e-mail]",
      "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
      "created": "2019-08-31T17:32:28Z",
      "lastSeen": "2019-08-31T17:32:28Z",
      "staffInfo": {
        "isStaff": false,
        "hasSudoRights": false,
        "companyName": "text"
      },
      "pending": false,
      "lastTosAcceptanceDate": "2019-08-31T17:32:28Z",
      "jobTitle": "Software Engineer",
      "permissions": [
        "admin:infra:disallowedEmailDomains:write"
      ],
      "companyName": "Edge Impulse Inc.",
      "activated": false,
      "mfaConfigured": false,
      "stripeCustomerId": "text",
      "hasPendingPayments": false,
      "tier": "free"
    }
  ],
  "deploySettings": {
    "eonCompiler": false,
    "sensor": "accelerometer",
    "arduinoLibraryName": "text",
    "tinkergenLibraryName": "text",
    "particleLibraryName": "text",
    "lastDeployModelEngine": "tflite-eon"
  },
  "experiments": [
    {
      "type": "text",
      "title": "text",
      "help": "text",
      "enabled": false,
      "showToUser": false
    }
  ],
  "latencyDevices": [
    {
      "mcu": "text",
      "name": "text",
      "selected": false,
      "int8Latency": 0,
      "int8ConvLatency": 0,
      "float32Latency": 0,
      "float32ConvLatency": 0,
      "helpText": "text"
    }
  ],
  "urls": {
    "mobileClient": "text",
    "mobileClientComputer": "text",
    "mobileClientInference": "text"
  },
  "showCreateFirstImpulse": false,
  "showGettingStartedWizard": {
    "showWizard": false
  },
  "performance": {
    "gpu": false,
    "enterprisePerformance": false
  },
  "readme": {
    "markdown": "text",
    "html": "text"
  },
  "trainJobNotificationUids": [],
  "dspJobNotificationUids": [],
  "modelTestingJobNotificationUids": [],
  "autoSegmenterJobNotificationUids": [],
  "exportJobNotificationUids": [],
  "hasNewTrainingData": false,
  "studioUrl": "text",
  "inPretrainedModelFlow": false,
  "showSensorDataInAcquisitionGraph": false,
  "targetConstraints": {
    "selectedTargetBasedOn": "user-configured",
    "targetDevices": [
      {
        "processors": [
          {
            "part": "text",
            "format": "low-end MCU",
            "architecture": "Cortex-M",
            "specificArchitecture": "Cortex-M0+",
            "accelerator": "Arm Cortex-U55",
            "fpu": false,
            "clockRateMhz": {
              "minimum": 0,
              "maximum": 0
            },
            "memory": {
              "ram": {
                "fastBytes": {
                  "minimum": 0,
                  "maximum": 0
                },
                "slowBytes": {
                  "minimum": 0,
                  "maximum": 0
                }
              },
              "rom": {
                "fastBytes": {
                  "minimum": 0,
                  "maximum": 0
                },
                "slowBytes": {
                  "minimum": 0,
                  "maximum": 0
                }
              }
            }
          }
        ],
        "board": "text",
        "name": "text",
        "latencyDevice": "cortex-m4f-80mhz"
      }
    ],
    "applicationBudgets": [
      {
        "latencyPerInferenceMs": {
          "minimum": 0,
          "maximum": 0
        },
        "energyPerInferenceJoules": {
          "minimum": 0,
          "maximum": 0
        },
        "memoryOverhead": {
          "ram": {
            "fastBytes": {
              "minimum": 0,
              "maximum": 0
            },
            "slowBytes": {
              "minimum": 0,
              "maximum": 0
            }
          },
          "rom": {
            "fastBytes": {
              "minimum": 0,
              "maximum": 0
            },
            "slowBytes": {
              "minimum": 0,
              "maximum": 0
            }
          }
        }
      }
    ]
  },
  "notifications": [
    "text"
  ]
}