Skip to content

BrainGenix-API Endpoint Overview

Welcome to the BrainGenix API Endpoint documentation! This API provides a gateway between users and the underlying BG systems (NES/EVM). It simplifies interactions by abstracting the complexities of these systems.

What is the BrainGenix-API Endpoint?

The BrainGenix API Endpoint is an essential component that facilitates communication between users and the BG systems. It acts as a middleware layer that translates requests from users into actions within the BG ecosystem. Additionally, the API unifies access across all BG backend systems, allowing users to interact with the system through a single API.

Features

  • Access to BG systems (NES/EVM) through a unified API
  • Secure communication through HTTPS/SSL support (using Let's Encrypt/Certbot)
  • Easy setup with both deb packages and manual installations available
  • Local deployment option for development and debugging purposes
  • Python client library (pyBrainGenixClient) for interacting with the API

Getting Started

Before diving into the installation and configuration details, make sure you have all necessary prerequisites:

  • Understanding of API concepts and usage
  • Basic knowledge of command line operations (e.g., cd, mkdir, chmod, etc.)
  • Access to a system where you can install the API endpoint and its dependencies (e.g., Debian/Ubuntu)
  • An active internet connection to download dependencies and clone the repo/debian package

For detailed installation and configuration instructions, please refer to our Setup guide.

This documentation is provided by BrainGenix, a division of Carboncopies Foundation R&D. BrainGenix is a platform focused on advancing the field of whole-brain-emulation and computational neuroscience. BrainGenix is part of the CarbonCopies Foundation, a 501(c)3 non-profit organization dedicated to researching and promoting whole brain emulation. Learn more about CarbonCopies at https://carboncopies.org. For any queries or feedback regarding BrainGenix projects or documentation, please write to us at braingenix@carboncopies.org.