Adding face bounding boxes or external images to events via /api/createEvent

Answered

Fatih

August 11, 2025 08:29

I’m using the Network Optix Server API to send requests to the /api/createEvent endpoint and create events. This allows me to integrate the alarms triggered by my facial recognition application into Network Optix, so the events appear in the system.

Is it possible to highlight (e.g., draw a bounding box around) the recognized face in the frame at the moment the event occurs?

If that’s not possible, can I instead attach an external image to the event — one that includes the recognized face already marked or boxed?

1

• Official comment

  

  Sergey Yuldashev

  • Network Optix team

  August 11, 2025 20:41

  Hello Fatih ,

   

  What you're seeking is impossible with the api/createEvent endpoint.

  It is effectively just a webhook to enable the fastest integrations that just need to pass the text metadata and associate one with the timestamp and the particular camera.

  To do so with the currently supported official version 6.0, one would need to implement a plugin with C++ using the Metadata SDK:

  https://meta.nxvms.com/docs/developers/knowledgebase/195-1-integration-capabilities--what-to-expect

  Alternatively - with the next version later this year Network Optix is going to release the Analytics API that will allow delivery of the same functionality using the REST API.

  You might give it a try using our developers preview program with Nx Meta:

  https://meta.nxvms.com/doc/developers/api-tool/analyticsapi

  You will need a preview beta version to work with that, it's avaialble down this link:

  https://meta.nxvms.com/download/betas
• 

  Fatih

  August 12, 2025 07:52 Edited

  Thanks a lot for your help and the information. @Sergey Yuldashev, which endpoint should I use in the beta version?

   

  0
• 

  Sergey Yuldashev

  • Network Optix team

  August 22, 2025 23:31

  Hello Fatih ,

  Apologies, I missed your question.

  You can not use just a single endpoint. You would need to implement an integration that should do at least the following:

  • Create Engine and Device Agents for each Device (e.g. a camera).
  • Define its features in the Integration, Engine, and Device Agent manifests.
  • Emit events on Device Agent level
  • Optional - declare settings models for its Engine and Device Agents if any needed

  It is still quite a lot of job to be done.

  You could refer to the existing implementation of the “stub” integration example that does all that(and covers more features) here:

  https://github.com/networkoptix/nx_open/tree/master/vms/server/stub_analytics_api_integration

   

  0

Please sign in to leave a comment.