Welcome to DepthAI Gen2 API Documentation

On this page you can find the details regarding DepthAI API that will allow you to interact with the DepthAI device. We support both Python API and C++ API

What is Gen2?

Gen2 is a step forward in DepthAI integration, allowing users to define their own flow of data using pipelines, nodes and connections. Gen2 was created based on user’s feedback from Gen1 and from raising capabilities of both DepthAI and supporting software like OpenVINO.

Basic glossary

  • Host side is the device, like PC or RPi, to which the DepthAI is connected to. If something is happening on the host side, it means that this device is involved in it, not DepthAI itself

  • Device side is the DepthAI itself. If something is happening on the device side, it means that the DepthAI is responsible for it

  • Pipeline is a complete workflow on the device side, consisting of nodes and connections between them - these cannot exist outside of pipeline.

  • Node is a single functionality of the DepthAI. It have either inputs or outputs or both, together with properties to be defined (like resolution on the camera node or blob path in neural network node)

  • Connection is a link between one node’s output and another one’s input. In order to define the pipeline dataflow, the connections define where to send data in order to achieve an expected result

  • XLink is a middleware that is capable to exchange data between device and host. XLinkIn node allows to send the data from host to device, XLinkOut does the opposite.

Getting started

To help you get started with Gen2 API, we have prepared multiple examples of it’s usage, with more yet to come, together with some insightful tutorials.

Before running the example, install the DepthAI Python library using the command below

python3 -m pip install --extra-index-url https://artifacts.luxonis.com/artifactory/luxonis-python-snapshot-local/ depthai==0.0.2.1+c9a19df719cb668e438d6eafd193cdf60a0d9354

Now, pick a tutorial or code sample and start utilizing Gen2 capabilities