HomeDocs
Projects
ForumStudio

Verify dataset

Verify dataset

Verify whether we can reach a dataset (and return some random files, used for data sources)

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/verify
Path parameters
organizationId*integer

Organization ID

dataset*string

Dataset name

Response

OK

Body
success*boolean

Whether the operation succeeded

errorstring

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

connectionStatus*enum

Indicates the current state of the connectivity verification process.

  • "connected": Verification successful, other properties are available.
  • "connecting": Verification in progress, continue polling.
  • "error": Verification failed, check connectionError for details.
connectedconnectingerror
connectionErrornullable string

Provides additional details if connectionStatus is "error". Helps diagnose verification failures.

connectionStatusSincenullable string (date-time)

Timestamp of when the connectionStatus last changed.

filesarray of object

Random files from the bucket. Only available when connectionStatus is "connected".

hasInfoLabelsFileboolean

Indicates whether there are any info.labels files in this bucket. If so, those are used for category/labels. Only available when connectionStatus is "connected".

signedUrlstring

A signed URL that allows you to PUT an item, to check whether CORS headers are set up correctly for this bucket. Only available when connectionStatus is "connected".

endpointstring

An alternative endpoint URL. Only returned and required for Azure storage accounts, where the endpoint must be reformatted. This field will be undefined for other storage providers.

Request
const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}/verify', {
    method: 'POST',
    headers: {},
});
const data = await response.json();
Response
{
  "success": false,
  "error": "text",
  "connectionStatus": "connected",
  "connectionError": "text",
  "connectionStatusSince": "2025-01-11T21:02:25.317Z",
  "files": [
    {
      "name": "text",
      "size": 0,
      "folderName": "text"
    }
  ],
  "hasInfoLabelsFile": false,
  "signedUrl": "text",
  "endpoint": "text"
}
PreviousCreate pre-signed S3 upload linkNextList files in dataset

Last updated