POST
/
api
/
organizations
/
{organizationId}
/
dataset
/
{dataset}
/
files
/
preview
Preview files in a default dataset
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/files/preview \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "prefix": "<string>",
  "itemsToList": "files"
}'
{
  "success": true,
  "error": "<string>",
  "files": [
    {
      "name": "<string>",
      "addedDate": "2019-07-21T17:32:28Z",
      "size": 123,
      "ETag": "<string>",
      "path": "<string>",
      "type": "folder"
    }
  ],
  "isTruncated": true,
  "truncationReason": "too-many-results"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
organizationId
integer
required

Organization ID

​
dataset
string
required

Dataset name

Body

application/json
​
prefix
string
required

S3 prefix

​
itemsToList
enum<string>
required

Return either files or folders matching the specified prefix

Available options:
files,
folders

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
files
object[]
required
​
error
string

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

​
isTruncated
boolean

True if results are truncated.

​
truncationReason
enum<string>

Explains why results are truncated; only present in the response if isTruncated is true. Results can be truncated if there are too many results (more than 500 matches), or if searching for more results is too expensive (for example, the dataset contains many items but very few match the given wildcard).

Available options:
too-many-results,
too-expensive-search