Developer Guide

Welcome to the Developer Guide for VisionAIre. This comprehensive guide is designed to assist developers in integrating, customizing, and extending the capabilities of the VisionAIre platform. Through this guide, you will gain an in-depth understanding of the architectural design, APIs, and various services that make VisionAIre a powerful tool for computer vision applications.

Purpose of This Guide

The Developer Guide serves as a technical companion throughout your journey of building, integrating, and scaling applications with VisionAIre. It is structured to cover the following key areas:

• How Our APIs Work: This section explains the architecture and workflow of VisionAIre APIs, detailing how they can be used to interact with the platform and process video streams effectively.

• APIs: Here, you will find a complete reference to the available APIs, including endpoints, request/response formats, and usage examples to help you harness the full range of VisionAIre’s functionality.

• Connect to Docker Stream Websocket: This part of the guide provides instructions on establishing a connection to VisionAIre's Docker container via WebSocket, enabling real-time data streaming and interaction.

• Connect to Vanilla Websocket: For those who prefer a direct to our Dashboard WebSocket connection, this section guides you through the steps to connect, send, and receive messages with the VisionAIre Dashboard over a standard WebSocket protocol.

• Create Your Own Visualization: Dive into the process of creating custom visualizations for the insights derived from video data, ensuring that your applications display information in the most effective and intuitive ways.

• Database Structure: Gain insights into the underlying database schema used by VisionAIre, which is crucial for developers looking to perform direct database operations or integrate with other data systems.

• Supporting Codes: Access a repository of code snippets, libraries, and SDKs that support the development of applications using VisionAIre.

As a developer, this guide will be an essential resource, providing the necessary details to effectively utilize VisionAIre’s robust suite of tools and features. You will be equipped to innovate, optimize, and deploy advanced computer vision solutions tailored to your organization's needs.