Edge Impulse Raw data API
The Raw data API from Edge Impulse — 54 operation(s) for raw data.
Edge Impulse Raw data API is one of 34 APIs that Edge Impulse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Raw data. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 56 operations across 54 paths, and defines 56 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://studio.edgeimpulse.com/v1.
56 operations
54 paths
56 schemas
1 DELETE22 GET33 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Edge Impulse Raw data API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as x-api-key (ApiKeyAuthentication).
An API key is passed in the cookie as jwt (JWTAuthentication).
An API key is passed in the header as x-jwt-token (JWTHttpHeaderAuthentication).
By default, every request must be authenticated.
Paths & Operations 56
Across 54 paths, the API surfaces 56 operations — 1 DELETE, 22 GET, 33 POST. Each is listed below with its method, path, parameters, and response codes.
Raw data 56
GET
/api/{projectId}/raw-data
List samples
GET
/api/{projectId}/raw-data/count
Count samples
GET
/api/{projectId}/raw-data/label-object-detection-queue
Object detection label queue
GET
/api/{projectId}/raw-data/label-object-detection-queue/count
Object detection label queue count
POST
/api/{projectId}/rebalance
Rebalance dataset
POST
/api/{projectId}/raw-data/clear-all-object-detection-labels
Clear all object detection labels
POST
/api/{projectId}/raw-data/delete-all
Remove all samples
POST
/api/{projectId}/raw-data/delete-all/{category}
Remove all samples by category
GET
/api/{projectId}/raw-data/metadata
Get project sample metadata
GET
/api/{projectId}/raw-data/imported-from
List data with "imported from" metadata key
GET
/api/{projectId}/raw-data/{sampleId}
Get sample
DELETE
/api/{projectId}/raw-data/{sampleId}
Remove sample
GET
/api/{projectId}/raw-data/{sampleId}/raw
Download file
GET
/api/{projectId}/raw-data/{sampleId}/wav
Get WAV file
GET
/api/{projectId}/raw-data/{sampleId}/image
Get image file
GET
/api/{projectId}/raw-data/{sampleId}/video
Get video file
GET
/api/{projectId}/raw-data/{sampleId}/slice
Get sample slice
POST
/api/{projectId}/raw-data/{sampleId}/rename
Rename sample
POST
/api/{projectId}/raw-data/{sampleId}/edit-label
Edit label
POST
/api/{projectId}/raw-data/{sampleId}/move
Move sample
POST
/api/{projectId}/raw-data/{sampleId}/crop
Crop sample
POST
/api/{projectId}/raw-data/{sampleId}/split
Split sample into frames
POST
/api/{projectId}/raw-data/{sampleId}/find-segments
Find segments
POST
/api/{projectId}/raw-data/{sampleId}/segment
Segment sample
POST
/api/{projectId}/raw-data/{sampleId}/bounding-boxes
Set bounding boxes
POST
/api/{projectId}/raw-data/{sampleId}/structured-labels
Update structured labels
POST
/api/{projectId}/raw-data/store-segment-length
Store the last segment length
GET
/api/{projectId}/raw-data/{sampleId}/original
Get the original downsampled data
POST
/api/{projectId}/raw-data/{sampleId}/retry-processing
Retry processing
POST
/api/{projectId}/raw-data/{sampleId}/enable
Enable sample
POST
/api/{projectId}/raw-data/{sampleId}/disable
Disable sample
POST
/api/{projectId}/raw-data/{sampleId}/autolabel
Auto-label an image
POST
/api/{projectId}/raw-data/{sampleId}/metadata
Set sample metadata
POST
/api/{projectId}/raw-data/{sampleId}/to-labeling-queue
Move sample to labeling queue
POST
/api/{projectId}/raw-data/{sampleId}/propose-changes
Propose changes
POST
/api/{projectId}/raw-data/batch/edit-labels
Edit labels for multiple samples
POST
/api/{projectId}/raw-data/batch/delete
Remove multiple samples
POST
/api/{projectId}/raw-data/batch/moveSamples
Move multiple samples
POST
/api/{projectId}/raw-data/batch/enable-samples
Enable multiple samples
POST
/api/{projectId}/raw-data/batch/disable-samples
Disable multiple samples
POST
/api/{projectId}/raw-data/batch/add-metadata
Add metadata (multiple samples)
POST
/api/{projectId}/raw-data/batch/clear-metadata-by-key
Clear metadata by key (multiple samples)
POST
/api/{projectId}/raw-data/batch/clear-metadata
Clear all metadata (multiple samples)
POST
/api/{projectId}/raw-data/track-objects
Track objects
GET
/api/{projectId}/raw-data/data-explorer/features
Get data explorer features
GET
/api/{projectId}/raw-data/data-explorer/has-features
Check data explorer features
GET
/api/{projectId}/raw-data/data-explorer/predictions
Get data explorer predictions
POST
/api/{projectId}/raw-data/data-explorer/clear
Clear data explorer
GET
/api/{projectId}/raw-data/data-explorer/settings
Get data explorer settings
POST
/api/{projectId}/raw-data/data-explorer/settings
Set data explorer settings
POST
/api/{projectId}/raw-data/data-explorer/screenshot
Upload a data explorer screenshot
GET
/api/{projectId}/raw-data/data-quality/diversity/exists
Check if data diversity metrics exist
GET
/api/{projectId}/raw-data/data-quality/diversity
Get diversity metrics data
GET
/api/{projectId}/raw-data/data-quality/label-noise/exists
Check if label noise metrics exist
GET
/api/{projectId}/raw-data/data-quality/label-noise
Get label noise data
GET
/api/{projectId}/raw-data/ai-actions-preview/{jobId}/proposed-changes
Get AI Actions proposed changes
Schemas 56
The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are Sample (41 properties), ImpulseInputBlock (18 properties), ModelPrediction (8 properties), RawSamplePayload (6 properties). Each schema is shown below with its type and property counts.
CropSampleRequest
object
2 properties
2 required
SegmentSampleRequest
object
1 property
1 required
TrackObjectsRequest
object
2 properties
2 required
SetSampleProposedChangesRequest
object
2 properties
2 required
DataExplorerPredictionsResponse
Sensor
object
2 properties
2 required
ProjectSampleMetadata
object
Project sample metadata
1 property
1 required
CountSamplesResponse
ObjectDetectionLabelQueueResponse
CosineSimilarityData
object
Describes the results of running the cosine similarity label noise detection method.
2 properties
2 required
GetAIActionsProposedChangesResponse
RawSamplePayload
object
Sensor readings and metadata
6 properties
3 required
FindSegmentSampleRequest
object
2 properties
2 required
TrackObjectsResponse
SetSampleMetadataRequest
object
1 property
StartJobResponse
SampleMetadata
object
2 properties
2 required
GetDataExplorerFeaturesResponse
DatasetRatioData
object
1 property
FindSegmentSampleResponse
SampleBoundingBoxesRequest
object
1 property
1 required
BoundingBox
object
This has the absolute values for x/y/w/h (so 0..x (where x is the w/h of the image))
5 properties
5 required
ObjectDetectionLabelQueueCountResponse
SetSampleStructuredLabelsRequest
object
1 property
1 required
BatchAddMetadataRequest
object
2 properties
2 required
RebalanceDatasetResponse
CosineSimilarityIssue
object
Describes a sample that has potential issues as identified by the cosine similarity label noise detection method.
4 properties
3 required
UploadImageRequest
object
1 property
1 required
GetAllImportedFromResponse
HasDataExplorerFeaturesResponse
ImpulseInputBlock
object
18 properties
5 required
ListSamplesResponse
RenameSampleRequest
object
1 property
1 required
ObjectDetectionAutoLabelResponse
GetDataExplorerSettingsResponse
SampleProposedChanges
object
5 properties
GetDiversityDataResponse
NeighborsData
object
Describes the results of running the nearest neighbors label noise detection method.
2 properties
2 required
DataExplorerSettings
object
3 properties
BatchClearMetadataByKeyRequest
object
1 property
1 required
StoreSegmentLengthRequest
object
1 property
1 required
SplitSampleInFramesRequest
object
1 property
ModelPrediction
object
8 properties
4 required
GenericApiResponse
object
2 properties
1 required
ObjectDetectionAutoLabelRequest
object
1 property
1 required
MoveRawDataRequest
object
1 property
1 required
GetSampleMetadataResponse
NeighborsScore
object
Describes the label noise score and nearest neighbors for a single window of data in the project that shows a potential label noise issue.
6 properties
5 required
GetSampleResponse
EditSampleLabelRequest
object
1 property
RawSampleData
object
3 properties
3 required
CropSampleResponse
GetLabelNoiseDataResponse
CrossValidationData
object
Describes the results of running the cross validation label noise detection method.
1 property
1 required
StructuredLabel
object
A structured label contains a label, and the range for which this label is valid. endIndex is inclusive. E.g. { startIndex: 10, endIndex: 13, label: 'running'…
3 properties
3 required
Sample
object
41 properties
25 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Edge Impulse 12
Other APIs Edge Impulse publishes across the network.
Edge Impulse Admin API
Edge Impulse Auth API
Edge Impulse Canary API
Edge Impulse CDN API
Edge Impulse Classify API
Edge Impulse Deployment API
Edge Impulse Devices API
Edge Impulse DSP API
Edge Impulse EmailVerification API
Edge Impulse Export API
Edge Impulse FeatureFlags API
Edge Impulse Health API
#Raw data