Neural Network

Each camera is capable of running a neural network and feeding it data from a selected stream. Our API can currently handle only models in the MyriadX blob format. To read more about this format and how to convert your models to MyriadX blob format, please refer to Luxonis conversion guide.

Deploying an AI model on the camera takes some time (usually ~20s, but may take up to a minute), during this time, the camera will be inaccessible via the API, since it needs to restart in order to deploy the model. All running streams from the particular camera will be paused and will resume when the camera is up again.

API Reference

Deploy Neural Network

post

/cameras/{mxid}/streams/{stream_name}/nn

Path parameters

stream_nameStream Namerequired

Pattern: CAM_[A-H]|DEPTH_[A-H]_[A-H]

mxidMxidrequired

Pattern: [A-Z0-9]+

Body

modelModelrequired

nn_configNn Configrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://robopipe-1.local/cameras/{mxid}/streams/{stream_name}/nn' \
  --header 'Content-Type: multipart/form-data' \
  --data '{"model":"text","nn_config":"text"}'

201

404

422

201

No body

Successful Response

NNConfig Description

The deploy neural network endpoint accepts form-data body. This body shall contain two fields - model, which is a binary file containing the neural network in the MyriadX blob format and nn_config, stringified json containing the neural network configuration. The nn_config format is described below

NNConfig Field	Description
type (required)	Type of the neural network being deployed. Possible values are: Generic YOLO MobileNet Type: enum
num_inference_threads (optional)	Number of CPU to run inference on. Type: number Default: 2
nn_config (optional)	Type-specific configuration for the deployed model. Type: NNYoloConfig | NNMobileNetConfig

NNYoloConfig

NNYoloConfig Field	Description
anchor_masks (optional)
anchors (optional)
coordinate_size (optional)
iou_threshold (optional)
num_classes (optional)

NNMobileNetConfig

NNMobileNetConfig Field	Description
confidence_threshold (optional)

Delete Neural Network

delete

/cameras/{mxid}/streams/{stream_name}/nn

Path parameters

stream_nameStream Namerequired

Pattern: CAM_[A-H]|DEPTH_[A-H]_[A-H]

mxidMxidrequired

Pattern: [A-Z0-9]+

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://robopipe-1.local/cameras/{mxid}/streams/{stream_name}/nn'

202

404

422

202

No body

Successful Response