Project information

PreviousList public project types NextUpdate project

Last updated 10 months ago

Was this helpful?

Project information

List all information about this project.

get

/api/{projectId}

Authorizations

Path parameters

projectIdintegerrequired

Project ID

Query parameters

impulseIdinteger

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}' \
  --header 'x-api-key: YOUR_API_KEY'

200

{
  "success": true,
  "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",
    "ownerUserId": 1,
    "ownerOrganizationId": 1,
    "ownerAvatar": "text",
    "ownerIsDeveloperProfile": true,
    "developerProfileUserId": 1,
    "metadata": {},
    "dataExplorerScreenshot": "text",
    "isEnterpriseProject": true,
    "whitelabelId": 1,
    "whitelabelName": "text",
    "category": "Image classification",
    "license": "text",
    "tier": "free",
    "hasPublicVersion": true,
    "isPublic": true,
    "allowsLivePublicAccess": true,
    "indPauseProcessingSamples": true,
    "publicProjectListed": true,
    "deletedDate": "2025-02-21T18:21:01.768Z",
    "fullDeletionDate": "2025-02-21T18:21:01.768Z",
    "scheduledFullDeletionDate": "2025-02-21T18:21:01.768Z",
    "labelingMethod": "single_label",
    "collaborators": [
      {
        "id": 1,
        "username": "janjongboom",
        "name": "Jan Jongboom",
        "email": "quijote@edgeimpulse.com",
        "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
        "created": "2019-08-31T17:32:28Z",
        "lastSeen": "2019-08-31T17:32:28Z",
        "staffInfo": {
          "isStaff": true,
          "hasSudoRights": true,
          "companyName": "text"
        },
        "pending": true,
        "lastTosAcceptanceDate": "2019-08-31T17:32:28Z",
        "jobTitle": "Software Engineer",
        "companyName": "Edge Impulse Inc.",
        "activated": true,
        "mfaConfigured": true,
        "stripeCustomerId": "text",
        "hasPendingPayments": true,
        "tier": "free",
        "permissions": [
          "admin:infra:disallowedEmailDomains:write"
        ],
        "isOwner": true
      }
    ],
    "tags": [
      "FOMO",
      "beers"
    ]
  },
  "developmentKeys": {
    "apiKey": "text",
    "hmacKey": "text"
  },
  "dataSummary": {
    "totalLengthMs": "726336",
    "dataCount": "Number of files in the training set",
    "labels": [
      "text"
    ]
  },
  "showCreateFirstImpulse": true,
  "hasNewTrainingData": true,
  "csvImportConfig": {},
  "studioUrl": "text",
  "inPretrainedModelFlow": true,
  "dspPageSize": 1,
  "showSensorDataInAcquisitionGraph": true,
  "targetConstraints": {
    "selectedTargetBasedOn": "user-configured",
    "targetDevices": [
      {
        "board": "text",
        "name": "text",
        "latencyDevice": "cortex-m4f-80mhz",
        "processors": [
          {
            "part": "text",
            "format": "low-end MCU",
            "architecture": "Cortex-M",
            "specificArchitecture": "Cortex-M0+",
            "accelerator": "Arm Cortex-U55",
            "fpu": true,
            "clockRateMhz": {
              "minimum": 1,
              "maximum": 1
            },
            "memory": {
              "ram": {
                "fastBytes": {
                  "minimum": 1,
                  "maximum": 1
                },
                "slowBytes": {
                  "minimum": 1,
                  "maximum": 1
                }
              },
              "rom": {
                "fastBytes": {
                  "minimum": 1,
                  "maximum": 1
                },
                "slowBytes": {
                  "minimum": 1,
                  "maximum": 1
                }
              }
            }
          }
        ]
      }
    ],
    "applicationBudgets": [
      {
        "latencyPerInferenceMs": {
          "minimum": 1,
          "maximum": 1
        },
        "energyPerInferenceJoules": {
          "minimum": 1,
          "maximum": 1
        },
        "memoryOverhead": {
          "ram": {
            "fastBytes": {
              "minimum": 1,
              "maximum": 1
            },
            "slowBytes": {
              "minimum": 1,
              "maximum": 1
            }
          },
          "rom": {
            "fastBytes": {
              "minimum": 1,
              "maximum": 1
            },
            "slowBytes": {
              "minimum": 1,
              "maximum": 1
            }
          }
        }
      }
    ]
  },
  "defaultImpulseId": 1,
  "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",
      "remote_mgmt_connected": true,
      "remote_mgmt_host": "text",
      "supportsSnapshotStreaming": true,
      "remoteMgmtMode": "disconnected",
      "inferenceInfo": {
        "projectId": 1,
        "projectOwner": "text",
        "projectName": "text",
        "deployedVersion": 1,
        "modelType": "classification"
      },
      "sensors": [
        {
          "name": "Built-in accelerometer",
          "maxSampleLengthS": 1,
          "frequencies": [
            62.5,
            100
          ]
        }
      ]
    }
  ],
  "collaborators": [
    {
      "id": 1,
      "username": "janjongboom",
      "name": "Jan Jongboom",
      "email": "quijote@edgeimpulse.com",
      "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
      "created": "2019-08-31T17:32:28Z",
      "lastSeen": "2019-08-31T17:32:28Z",
      "staffInfo": {
        "isStaff": true,
        "hasSudoRights": true,
        "companyName": "text"
      },
      "pending": true,
      "lastTosAcceptanceDate": "2019-08-31T17:32:28Z",
      "jobTitle": "Software Engineer",
      "companyName": "Edge Impulse Inc.",
      "activated": true,
      "mfaConfigured": true,
      "stripeCustomerId": "text",
      "hasPendingPayments": true,
      "tier": "free",
      "permissions": [
        "admin:infra:disallowedEmailDomains:write"
      ]
    }
  ],
  "latencyDevices": [
    {
      "mcu": "text",
      "name": "text",
      "selected": true,
      "int8Latency": 1,
      "int8ConvLatency": 1,
      "float32Latency": 1,
      "float32ConvLatency": 1,
      "helpText": "text"
    }
  ],
  "trainJobNotificationUids": [
    1
  ],
  "dspJobNotificationUids": [
    1
  ],
  "modelTestingJobNotificationUids": [
    1
  ],
  "exportJobNotificationUids": [
    1
  ],
  "notifications": [
    "text"
  ],
  "impulse": {
    "created": true,
    "configured": true,
    "complete": true
  },
  "dataSummaryPerCategory": {
    "training": {
      "totalLengthMs": "726336",
      "dataCount": "Number of files in the training set",
      "labels": [
        "text"
      ]
    },
    "testing": {
      "totalLengthMs": "726336",
      "dataCount": "Number of files in the training set",
      "labels": [
        "text"
      ]
    },
    "anomaly": {
      "totalLengthMs": "726336",
      "dataCount": "Number of files in the training set",
      "labels": [
        "text"
      ]
    }
  },
  "computeTime": {
    "periodStartDate": "2025-02-21T18:21:01.768Z",
    "periodEndDate": "2025-02-21T18:21:01.768Z",
    "timeUsedMs": 1,
    "timeLeftMs": 1
  },
  "urls": {
    "mobileClient": "text",
    "mobileClientComputer": "text",
    "mobileClientInference": "text"
  },
  "showGettingStartedWizard": {
    "showWizard": true,
    "step": 1
  },
  "performance": {
    "gpu": true,
    "jobLimitM": 1,
    "dspFileSizeMb": 1,
    "enterprisePerformance": true,
    "trainJobRamMb": 1
  },
  "readme": {
    "markdown": "text",
    "html": "text"
  },
  "acquisitionSettings": {
    "intervalMs": 1,
    "lengthMs": 1,
    "sensor": "text",
    "label": "text",
    "segmentLength": 1,
    "segmentShift": true,
    "defaultPageSize": 1,
    "gridColumnCount": 1,
    "gridColumnCountDetailed": 1,
    "showExactSampleLength": true,
    "inlineEditBoundingBoxes": true,
    "viewType": "list"
  },
  "deploySettings": {
    "eonCompiler": true,
    "arduinoLibraryName": "text",
    "tinkergenLibraryName": "text",
    "particleLibraryName": "text",
    "lastDeployModelEngine": "tflite-eon",
    "sensor": "accelerometer"
  },
  "experiments": [
    {
      "type": "text",
      "title": "text",
      "help": "text",
      "enabled": true,
      "showToUser": true
    }
  ]
}