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 Deployment API

The Deployment API from Edge Impulse — 10 operation(s) for deployment.

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

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

11 operations 10 paths 17 schemas 9 GET2 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 Deployment 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 11

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

Deployment 11
GET
/api/deployment/targets
Deployment targets
listAllDeploymentTargets → 200
GET
/api/{projectId}/deployment/targets
Deployment targets
listDeploymentTargetsForProject 2 params → 200
GET
/api/{projectId}/deployment/targets/data-sources
Deployment targets (data sources)
listDeploymentTargetsForProjectDataSources 2 params → 200
GET
/api/{projectId}/deployment/evaluate
Evaluate job result
getEvaluateJobResult 2 params → 200
GET
/api/{projectId}/deployment/evaluate/cache
Check evaluate job result (cache)
getEvaluateJobResultCache 2 params → 200
GET
/api/{projectId}/deployment
Get deployment info
getDeployment 5 params → 200
GET
/api/{projectId}/deployment/download
Download
downloadBuild 5 params → 200
GET
/api/{projectId}/deployment/last
Get information on the last deployment build
getLastDeploymentBuild 2 params → 200
GET
/api/{projectId}/deployment/syntiant/posterior
Get Syntiant posterior parameters
getSyntiantPosterior 2 params → 200
POST
/api/{projectId}/deployment/syntiant/posterior
Set Syntiant posterior parameters
setSyntiantPosterior 2 params body → 200
POST
/api/{projectId}/jobs/find-syntiant-posterior
Find Syntiant posterior parameters
findSyntiantPosterior 2 params body → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are DeploymentTarget (25 properties), ModelVariantStats (9 properties), FindSyntiantPosteriorRequest (5 properties), GenericApiResponse (2 properties). Each schema is shown below with its type and property counts.

FindSyntiantPosteriorRequest
object
5 properties 2 required
StartJobResponse
ProjectDeploymentTarget
GetLastDeploymentBuildResponse
ProjectDeploymentTargetsResponse
EvaluateResultValue
object
2 properties
ModelVariantStats
object
9 properties 9 required
DeploymentTargetEngine
string
GetSyntiantPosteriorResponse
EvaluateJobResponse
SetSyntiantPosteriorRequest
object
1 property 1 required
DeploymentTargetsResponse
DeploymentTarget
object
25 properties 18 required
KerasModelTypeEnum
string
LearnBlockType
string
The type of learning block (anomaly, keras, keras-transfer-image, keras-transfer-kws, keras-object-detection, keras-regression). Each behaves differently.
GenericApiResponse
object
2 properties 1 required
GetDeploymentResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edge-impulse-deployment-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 Classify 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