How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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 38 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 16 operations across 15 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://studio.edgeimpulse.com/v1.

16 operations 15 paths 31 schemas 13 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 4

Edge Impulse Deployment API declares 4 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). It supports OAuth 2.0 (OAuth2) using the authorizationCode, implicit, password and clientCredentials flows, exposing 3 scopes.

Paths & Operations 16

Across 15 paths, the API surfaces 16 operations — 13 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Deployment 16
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
GET
/api/{projectId}/deployment/history
List deployment history
listDeploymentHistory 5 params → 200
GET
/api/{projectId}/deployment/history/{deploymentVersion}
Get historic deployment
getHistoricDeployment 2 params → 200
GET
/api/{projectId}/deployment/history/{deploymentVersion}/download
Download historic deployment
downloadHistoricDeployment 2 params → 200
POST
/api/{projectId}/deployment/public/build
Build deployment (public)
buildPublicDeploymentJob 2 params body → 200
GET
/api/{projectId}/deployment/public/jobs/{jobId}/status
Get status of build job (public)
getPublicDeploymentStatus 2 params → 200

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are DeploymentTarget_2 (32 properties), DeploymentTarget (25 properties), DSPGroupItem (22 properties), DeploymentHistory (13 properties). Each schema is shown below with its type and property counts.

StartJobResponse
EvaluateResultValue
object
2 properties
FindSyntiantPosteriorRequest
object
5 properties 2 required
LearnBlockType
string
The type of learning block (anomaly, keras, keras-transfer-image, keras-transfer-kws, keras-object-detection, keras-regression). Each behaves differently.
ModelVariantStats
object
9 properties 9 required
DeploymentTargetEngine
string
SetSyntiantPosteriorRequest
object
1 property 1 required
GenericApiResponse
object
2 properties 1 required
KerasModelTypeEnum
string
EvaluateJobResponse
DeploymentTargetsResponse
GetDeploymentResponse
ProjectDeploymentTarget
GetSyntiantPosteriorResponse
GetLastDeploymentBuildResponse
ProjectDeploymentTargetsResponse
DeploymentTarget
object
25 properties 18 required
DeploymentHistory
object
13 properties 10 required
BuildPublicDeploymentJobRequest
object
2 properties 2 required
LearnBlockType_2
string
The type of learning block (anomaly, keras, keras-transfer-image, keras-transfer-kws, keras-object-detection, keras-regression, keras-freeform). Each behaves d…
JobLogItem
object
3 properties 2 required
BuildPublicDeploymentJobResponse
DeploymentTargetEngine_2
string
GetPublicDeploymentStatusResponse
DSPGroupItem
object
22 properties 8 required
CreatedUpdatedByUser
object
4 properties 3 required
KerasModelVariantEnum
string
ListDeploymentHistoryResponse
GetDeploymentHistoryResponse
DeploymentTarget_2
object
32 properties 23 required
DeploymentTargetVariant
object
3 properties 2 required

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 Export API
Edge Impulse Health API
Edge Impulse API
Edge Impulse Jobs API
Edge Impulse Learn API
Where this information came from

This is an independent, third-party profile of Edge Impulse Deployment API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.