Skip to main content
GET
/
api
/
{projectId}
/
deployment
Get deployment info
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/deployment \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "hasDeployment": true,
  "error": "<string>",
  "version": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.edgeimpulse.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
projectId
integer
required

Project ID

Query Parameters

​
type
string
required

The name of the built target. You can find this by listing all deployment targets through listDeploymentTargetsForProject (via GET /v1/api/{projectId}/deployment/targets) and see the format type.

​
modelType
enum<string>

Optional model type of the build (if not, it uses the settings in the Keras block)

Available options:
int8,
float32,
akida,
requiresRetrain
​
engine
enum<string>

Optional engine for the build (if not, it uses the default engine for the deployment target)

Available options:
tflite,
tflite-eon,
tflite-eon-ram-optimized,
tensorrt,
tensaiflow,
drp-ai,
tidl,
akida,
syntiant,
memryx,
neox,
ethos-linux,
st-aton,
ceva-npn,
nordic-axon,
vlm-connector
​
impulseId
integer

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

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
hasDeployment
boolean
required
​
error
string

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

​
version
integer