Skip to main content
GET
/
api
/
organizations
/
{organizationId}
/
data
/
files
List files
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/files \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "totalFileSize": 123,
  "totalFileCount": 123,
  "totalDataItemCount": 123,
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "bucketId": 123,
      "bucketName": "<string>",
      "bucketPath": "<string>",
      "dataset": "<string>",
      "totalFileCount": 123,
      "totalFileSize": 123,
      "created": "2023-11-07T05:31:56Z",
      "metadata": {},
      "files": [
        {
          "name": "<string>",
          "bucketPath": "<string>",
          "size": 123,
          "lastModified": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "error": "<string>",
  "filterParseError": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.edgeimpulse.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
organizationId
integer
required

Organization ID

Query Parameters

​
dataset
string

Selected dataset

​
filter
string

Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore).

​
limit
integer

Maximum number of results

​
offset
integer

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

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
totalFileSize
integer
required
​
totalFileCount
integer
required
​
totalDataItemCount
integer
required
​
data
object[]
required
​
error
string

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

​
filterParseError
string