Skip to main content
GET
/
api
/
{projectId}
Project information
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId} \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "project": {
    "id": 1,
    "name": "Water hammer detection",
    "description": "<string>",
    "created": "2019-07-21T17:32:28Z",
    "owner": "<string>",
    "ownerIsDeveloperProfile": true,
    "collaborators": [
      {
        "id": 1,
        "username": "janjongboom",
        "name": "Jan Jongboom",
        "email": "quijote@edgeimpulse.com",
        "created": "2019-08-31T17:32:28Z",
        "staffInfo": {
          "isStaff": true,
          "hasSudoRights": true,
          "companyName": "<string>"
        },
        "pending": true,
        "activated": true,
        "mfaConfigured": true,
        "isOwner": true,
        "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
        "lastSeen": "2019-08-31T17:32:28Z",
        "jobTitle": "Software Engineer",
        "permissions": [
          "admin:infra:disallowedEmailDomains:read"
        ],
        "companyName": "Edge Impulse Inc.",
        "stripeCustomerId": "<string>",
        "hasPendingPayments": true,
        "tier": "free",
        "idps": [
          "<string>"
        ]
      }
    ],
    "labelingMethod": "single_label",
    "metadata": {},
    "isEnterpriseProject": true,
    "whitelabelId": 123,
    "tier": "free",
    "hasPublicVersion": true,
    "isPublic": true,
    "allowsLivePublicAccess": true,
    "indPauseProcessingSamples": true,
    "publicProjectListed": true,
    "lastAccessed": "2019-07-21T17:32:28Z",
    "lastModified": "2019-07-21T17:32:28Z",
    "lastModificationDetails": "Data sample added",
    "logo": "<string>",
    "ownerUserId": 123,
    "ownerOrganizationId": 123,
    "ownerAvatar": "<string>",
    "developerProfileUserId": 123,
    "dataExplorerScreenshot": "<string>",
    "whitelabelName": "<string>",
    "tags": [
      "FOMO",
      "beers"
    ],
    "category": "Accelerometer",
    "license": "Apache-2.0",
    "deletedDate": "2023-11-07T05:31:56Z",
    "fullDeletionDate": "2023-11-07T05:31:56Z",
    "scheduledFullDeletionDate": "2023-11-07T05:31:56Z"
  },
  "developmentKeys": {
    "apiKey": "<string>",
    "hmacKey": "<string>"
  },
  "impulse": {
    "created": true,
    "configured": true,
    "complete": true
  },
  "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",
          "maxSampleLengthS": 123,
          "frequencies": [
            62.5,
            100
          ]
        }
      ],
      "remote_mgmt_connected": true,
      "supportsSnapshotStreaming": true,
      "remoteMgmtMode": "disconnected",
      "remote_mgmt_host": "<string>",
      "inferenceInfo": {
        "projectId": 123,
        "projectOwner": "<string>",
        "projectName": "<string>",
        "deployedVersion": 123,
        "modelType": "classification"
      }
    }
  ],
  "dataSummary": {
    "totalLengthMs": "726336",
    "labels": [
      "<string>"
    ],
    "dataCount": "Number of files in the training set"
  },
  "dataSummaryPerCategory": {
    "training": {
      "totalLengthMs": "726336",
      "labels": [
        "<string>"
      ],
      "dataCount": "Number of files in the training set"
    },
    "testing": {
      "totalLengthMs": "726336",
      "labels": [
        "<string>"
      ],
      "dataCount": "Number of files in the training set"
    },
    "postProcessing": {
      "totalLengthMs": "726336",
      "labels": [
        "<string>"
      ],
      "dataCount": "Number of files in the training set"
    }
  },
  "computeTime": {
    "periodStartDate": "2023-11-07T05:31:56Z",
    "periodEndDate": "2023-11-07T05:31:56Z",
    "timeUsedMs": 123,
    "timeLeftMs": 123
  },
  "acquisitionSettings": {
    "intervalMs": 123,
    "lengthMs": 123,
    "segmentShift": true,
    "defaultPageSize": 123,
    "viewType": "list",
    "gridColumnCount": 123,
    "gridColumnCountDetailed": 123,
    "showExactSampleLength": true,
    "inlineEditBoundingBoxes": true,
    "sensor": "<string>",
    "label": "<string>",
    "segmentLength": 123
  },
  "collaborators": [
    {
      "id": 1,
      "username": "janjongboom",
      "name": "Jan Jongboom",
      "email": "quijote@edgeimpulse.com",
      "created": "2019-08-31T17:32:28Z",
      "staffInfo": {
        "isStaff": true,
        "hasSudoRights": true,
        "companyName": "<string>"
      },
      "pending": true,
      "activated": true,
      "mfaConfigured": true,
      "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
      "lastSeen": "2019-08-31T17:32:28Z",
      "jobTitle": "Software Engineer",
      "permissions": [
        "admin:infra:disallowedEmailDomains:read"
      ],
      "companyName": "Edge Impulse Inc.",
      "stripeCustomerId": "<string>",
      "hasPendingPayments": true,
      "tier": "free",
      "idps": [
        "<string>"
      ]
    }
  ],
  "deploySettings": {
    "eonCompiler": true,
    "sensor": "accelerometer",
    "arduinoLibraryName": "<string>",
    "tinkergenLibraryName": "<string>",
    "particleLibraryName": "<string>",
    "lastDeployModelEngine": "tflite-eon"
  },
  "experiments": [
    {
      "type": "<string>",
      "title": "<string>",
      "enabled": true,
      "showToUser": true,
      "help": "<string>"
    }
  ],
  "latencyDevices": [
    {
      "mcu": "<string>",
      "name": "<string>",
      "selected": true,
      "int8Latency": 123,
      "int8ConvLatency": 123,
      "float32Latency": 123,
      "float32ConvLatency": 123,
      "helpText": "<string>"
    }
  ],
  "urls": {
    "mobileClient": "<string>",
    "mobileClientComputer": "<string>",
    "mobileClientInference": "<string>"
  },
  "showCreateFirstImpulse": true,
  "showGettingStartedWizard": {
    "showWizard": true,
    "step": 123,
    "tutorial": "kws",
    "classes": [
      "<string>"
    ]
  },
  "performance": {
    "gpu": true,
    "jobLimitM": 123,
    "dspFileSizeMb": 123,
    "enterprisePerformance": true,
    "trainJobRamMb": 123
  },
  "trainJobNotificationUids": [
    123
  ],
  "dspJobNotificationUids": [
    123
  ],
  "modelTestingJobNotificationUids": [
    123
  ],
  "exportJobNotificationUids": [
    123
  ],
  "hasNewTrainingData": true,
  "studioUrl": "<string>",
  "inPretrainedModelFlow": true,
  "showSensorDataInAcquisitionGraph": true,
  "notifications": [
    "<string>"
  ],
  "error": "<string>",
  "readme": {
    "markdown": "<string>",
    "html": "<string>"
  },
  "csvImportConfig": {},
  "dspPageSize": 123,
  "targetConstraints": {
    "targetDevices": [
      {
        "processors": [
          {
            "part": "<string>",
            "format": "low-end MCU",
            "architecture": "Cortex-M",
            "specificArchitecture": "Cortex-M0+",
            "accelerator": "Arm Cortex-U55",
            "fpu": true,
            "clockRateMhz": {
              "minimum": 123,
              "maximum": 123
            },
            "memory": {
              "ram": {
                "fastBytes": {
                  "minimum": 123,
                  "maximum": 123
                },
                "slowBytes": {
                  "minimum": 123,
                  "maximum": 123
                }
              },
              "rom": {
                "fastBytes": {
                  "minimum": 123,
                  "maximum": 123
                },
                "slowBytes": {
                  "minimum": 123,
                  "maximum": 123
                }
              }
            }
          }
        ],
        "board": "<string>",
        "name": "<string>",
        "latencyDevice": "cortex-m4f-80mhz"
      }
    ],
    "applicationBudgets": [
      {
        "latencyPerInferenceMs": {
          "minimum": 123,
          "maximum": 123
        },
        "energyPerInferenceJoules": {
          "minimum": 123,
          "maximum": 123
        },
        "memoryOverhead": {
          "ram": {
            "fastBytes": {
              "minimum": 123,
              "maximum": 123
            },
            "slowBytes": {
              "minimum": 123,
              "maximum": 123
            }
          },
          "rom": {
            "fastBytes": {
              "minimum": 123,
              "maximum": 123
            },
            "slowBytes": {
              "minimum": 123,
              "maximum": 123
            }
          }
        }
      }
    ],
    "selectedTargetBasedOn": "user-configured"
  },
  "defaultImpulseId": 123,
  "lastShownModelEngine": "tflite-eon",
  "versioningStorageSizeMib": 123
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
projectId
integer
required

Project ID

Query Parameters

​
impulseId
integer

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

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
project
object
required
​
developmentKeys
object
required
​
impulse
object
required
​
devices
object[]
required
​
dataSummary
object
required
​
dataSummaryPerCategory
object
required
​
computeTime
object
required
​
acquisitionSettings
object
required
​
collaborators
object[]
required
​
deploySettings
object
required
​
experiments
object[]
required

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

​
latencyDevices
object[]
required
​
urls
object
required
​
showCreateFirstImpulse
boolean
required
​
showGettingStartedWizard
object
required
​
performance
object
required
​
trainJobNotificationUids
integer[]
required

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

​
dspJobNotificationUids
integer[]
required

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

​
modelTestingJobNotificationUids
integer[]
required

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

​
exportJobNotificationUids
integer[]
required

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

​
hasNewTrainingData
boolean
required
​
studioUrl
string
required
​
inPretrainedModelFlow
boolean
required
​
showSensorDataInAcquisitionGraph
boolean
required

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

​
notifications
string[]
required

List of notifications to show within the project

​
error
string

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

​
readme
object

Present if a readme is set for this project

​
csvImportConfig
object

Config file specifying how to process CSV files.

​
dspPageSize
integer
​
targetConstraints
object
​
defaultImpulseId
integer

Default selected impulse (by ID).

​
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