List samples

List samples

get

Retrieve all raw data by category.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerRequired

Project ID

Query parameters

categorystring · enumRequired

Which of the three acquisition categories to retrieve data from

Possible values:

limitintegerOptional

Maximum number of results

offsetintegerOptional

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

excludeSensorsbooleanOptional

Whether to exclude sensors in the response (as these can slow down requests when you have large pages).

labelsstringOptional

Only include samples with a label within the given list of labels, given as a JSON string

Example: ["idle", "snake"]

filenamestringOptional

Only include samples whose filename includes the given filename

maxLengthintegerOptional

Only include samples shorter than the given length, in milliseconds

minLengthintegerOptional

Only include samples longer than the given length, in milliseconds

minFrequencynumberOptional

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumberOptional

Only include samples with lower frequency than given frequency, in hertz

signatureValiditystring · enumOptional

Include samples with either valid or invalid signatures

Possible values:

includeDisabledstring · enumOptional

Include only enabled or disabled samples (or both)

Possible values:

minLabelnumberOptional

Only include samples with a label >= this value

maxLabelnumberOptional

Only include samples with a label < this value

searchstringOptional

Search query

Example: <id> <name>

proposedActionsJobIdintegerOptional

Pass this parameter when querying samples from inside an AI Action job. If you pass this parameter in a multi-stage AI Action, previous proposed changes (from an earlier step) will be applied to the returned dataset.

truncateStructuredLabelsbooleanOptional

If true, only a slice of labels will be returned for samples with multiple labels.

Responses

Responseall of

get

HTTPcURLJavaScriptPython

GET /v1/api/{projectId}/raw-data HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "error": "text",
  "samples": [
    {
      "id": 2,
      "filename": "idle01.d8Ae",
      "signatureValidate": true,
      "signatureMethod": "HS256",
      "signatureKey": "text",
      "created": "2025-04-25T10:47:49.148Z",
      "lastModified": "2025-04-25T10:47:49.148Z",
      "category": "training",
      "coldstorageFilename": "text",
      "label": "healthy-machine",
      "intervalMs": 16,
      "frequency": 62.5,
      "originalIntervalMs": 16,
      "originalFrequency": 62.5,
      "deviceName": "text",
      "deviceType": "text",
      "sensors": [
        {
          "name": "accX",
          "units": "text"
        }
      ],
      "valuesCount": 1,
      "totalLengthMs": 1,
      "added": "2025-04-25T10:47:49.148Z",
      "boundingBoxes": [
        {
          "label": "text",
          "x": 1,
          "y": 1,
          "width": 1,
          "height": 1
        }
      ],
      "boundingBoxesType": "object_detection",
      "chartType": "chart",
      "thumbnailVideo": "text",
      "thumbnailVideoFull": "text",
      "isDisabled": true,
      "isProcessing": true,
      "processingJobId": 1,
      "processingError": true,
      "processingErrorString": "text",
      "isCropped": true,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "projectId": 1,
      "projectOwnerName": "text",
      "projectName": "text",
      "projectLabelingMethod": "single_label",
      "sha256Hash": "text",
      "structuredLabels": [
        {
          "startIndex": 1,
          "endIndex": 1,
          "label": "text"
        }
      ],
      "structuredLabelsList": [
        "text"
      ],
      "createdBySyntheticDataJobId": 1,
      "imageDimensions": {
        "width": 1,
        "height": 1
      }
    }
  ],
  "totalCount": 1
}