Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Edge Impulse Classify API

The Classify API from Edge Impulse — 10 operation(s) for classify.

Edge Impulse Classify 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 Classify. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 10 paths, and defines 30 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.

10 operations 10 paths 30 schemas 6 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://studio.edgeimpulse.com/v1
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Edge Impulse Classify 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 10

Across 10 paths, the API surfaces 10 operations — 6 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Classify 10
GET
/api/{projectId}/classify/{sampleId}
Classify sample (deprecated)
classifySample 4 params → 200
POST
/api/{projectId}/classify/v2/{sampleId}
Classify sample
classifySampleV2 5 params → 200
POST
/api/{projectId}/classify/v2/{sampleId}/variants
Classify sample for the given set of variants
classifySampleForVariants 5 params → 200
GET
/api/{projectId}/classify/v2/{sampleId}/raw-data/{windowIndex}
Get a window of raw sample features from cache, after a live classification job has completed.
getSampleWindowFromCache 4 params → 200
GET
/api/{projectId}/classify/all/result
Classify job result
getClassifyJobResult 4 params → 200
GET
/api/{projectId}/classify/all/result/page
Single page of a classify job result
getClassifyJobResultPage 5 params → 200
GET
/api/{projectId}/classify/all/metrics
Get metrics for all available model variants
getClassifyMetricsAllVariants 2 params → 200
GET
/api/{projectId}/classify/anomaly-gmm/{blockId}/{sampleId}
Classify sample by learn block
classifySampleByLearnBlock 3 params → 200
POST
/api/{projectId}/classify/anomaly-gmm/v2/{blockId}/{sampleId}
Classify sample by learn block
classifySampleByLearnBlockV2 4 params → 200
POST
/api/{projectId}/classify/image
Classify an image
classifyImage 2 params body → 200

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are Sample (41 properties), StructuredClassifyResult (8 properties), ModelPrediction (8 properties), ImpulseLearnBlock (8 properties). Each schema is shown below with its type and property counts.

KerasModelVariantEnum
string
ModelResult
object
3 properties 3 required
UploadImageRequest
object
1 property 1 required
MetricsAllVariantsResponse
StartJobResponse
ClassifySampleResponseClassificationDetails
object
5 properties
ClassifySampleResponseClassification
object
8 properties 4 required
MetricsForModelVariant
object
2 properties 1 required
ClassifyJobResponsePage
GetSampleResponse
TestPretrainedModelResponse
AdditionalMetric
object
5 properties 3 required
ImpulseLearnBlock
object
8 properties 6 required
Sensor
object
2 properties 2 required
BoundingBoxWithScore
object
This has the ratio for x/y/w/h (so 0..1)
6 properties 6 required
GenericApiResponse
object
2 properties 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
AnomalyResult
object
4 properties
ObjectDetectionLastLayer
string
RawSampleData
object
3 properties 3 required
StructuredClassifyResult
object
8 properties 6 required
ClassifySampleResponseMultipleVariants
ClassifySampleResponse
ModelPrediction
object
8 properties 4 required
RawSamplePayload
object
Sensor readings and metadata
6 properties 3 required
ClassifySampleResponseVariantResults
object
2 properties 2 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
LearnBlockType
string
The type of learning block (anomaly, keras, keras-transfer-image, keras-transfer-kws, keras-object-detection, keras-regression). Each behaves differently.
ClassifyJobResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edge-impulse-classify-api-openapi.yml Raw ↑

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 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
Edge Impulse Impulse API