Deployment

Build deployment (public)

Create a deployment job for a public project. If a deployment already exists, jobId is null. If a deployment did not exist, or a job is created, jobId is set to an integer, and you can get updates via getPublicDeploymentStatus. When this step is complete use downloadHistoricDeployment to download the artefacts using deploymentVersion. Updates are NOT streamed over the websocket API (for security reasons); but can be obtained via getPublicDeploymentStatus.

post/api/{projectId}/deployment/public/build

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/deployment/public/build/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

Query parameters

impulseIdinteger

Impulse ID. If this is unset then the default impulse is used.

Request body

deploymentTypestring required

modelType'int8' | 'float32' | 'akida' required

Response

successboolean required

Whether the operation succeeded

errorstring

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

jobIdinteger

Set if a job was created (or was already running) for this deployment. Use this ID to poll to the job logs via 'GetPublicDeploymentStatusResponse'.

deploymentVersioninteger required

Deployment version. Use downloadHistoricDeployment to download the deployment using this identifier (once the job is finished).

Changes

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