Skip to main content

Brainiacs API Overview

NEXVECTA Brainiacs provides a comprehensive REST API that allows you to programmatically interact with all aspects of the platform.

Authentication​

All API requests require authentication using an API key. You can generate an API key from the Brainiacs web interface:

  1. Navigate to Settings > API Keys
  2. Click Create New API Key
  3. Name your key and set permissions
  4. Copy the generated key (it will only be shown once)

Include the API key in all requests using the X-API-Key header:

X-API-Key: your_api_key_here

Base URL​

All API endpoints are relative to the base URL:

https://api.nexvecta.com/brainiacs/v1/

Common Endpoints​

Projects​

GET /projects                 # List all projects
POST /projects                # Create a new project
GET /projects/{id}            # Get a specific project
PUT /projects/{id}            # Update a project
DELETE /projects/{id}         # Delete a project

Data Sources​

GET /projects/{id}/datasources        # List data sources for a project
POST /projects/{id}/datasources       # Create a new data source
GET /datasources/{id}                 # Get a specific data source
PUT /datasources/{id}                 # Update a data source
DELETE /datasources/{id}              # Delete a data source

Analyses​

GET /projects/{id}/analyses           # List analyses for a project
POST /projects/{id}/analyses          # Create a new analysis
GET /analyses/{id}                    # Get a specific analysis
PUT /analyses/{id}                    # Update an analysis
DELETE /analyses/{id}                 # Delete an analysis
GET /analyses/{id}/results            # Get analysis results

Rate Limits​

API requests are subject to rate limiting:

  • Free tier: 100 requests per hour
  • Professional tier: 1,000 requests per hour
  • Enterprise tier: 10,000 requests per hour

When you exceed the rate limit, the API will return a 429 Too Many Requests response.

Example Request​

curl -X GET \
  "https://api.nexvecta.com/brainiacs/v1/projects" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json"

Response Format​

All API responses are returned in JSON format:

{
  "status": "success",
  "data": {
    // Response data here
  }
}

For error responses:

{
  "status": "error",
  "error": {
    "code": "error_code",
    "message": "Human-readable error message"
  }
}

Next Steps​

For detailed information about specific endpoints, request parameters, and response formats, please refer to the full API reference.