Jobs

Export original data

Export all the data in the project as it was uploaded to Edge Impulse. Updates are streamed over the websocket API.

post/api/{projectId}/jobs/export/original

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/jobs/export/original/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

Request body

uploaderFriendlyFilenamesboolean required

Whether to rename the exported file names to an uploader friendly format (e.g. label.filename.cbor)

retainCropsboolean required

Whether to retain crops and splits (applicable to time-series data only). If this is disabled, then the original files are returned (as they were uploaded).

Response

successboolean required

Whether the operation succeeded

errorstring

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

idinteger required

Job identifier. Status updates will include this identifier.

Example response

{
  "id": 12873488112
}

Changes

No recorded changes to this operation across all 1 revision of this API.