Preview files in a default dataset

Preview files in a default dataset

Preview files and directories in a default dataset for the given prefix, with support for wildcards. This is an internal API used when starting a transformation job.

post

/api/organizations/{organizationId}/dataset/{dataset}/files/preview

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

datasetstringrequired

Dataset name

Body

prefixstringrequired

S3 prefix

itemsToListstring · enumrequired

Return either files or folders matching the specified prefix

Options: files, folders

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/files/preview' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"prefix":"text","itemsToList":"files"}'

200

200

{
  "success": true,
  "error": "text",
  "isTruncated": true,
  "truncationReason": "too-many-results",
  "files": [
    {
      "name": "text",
      "addedDate": "2019-07-21T17:32:28Z",
      "size": 1,
      "ETag": "text",
      "path": "text",
      "type": "folder"
    }
  ]
}

OK