Skip to main content

​
Nimbus API

The Nimbus API provides backend services for the Julia SDK (NimbusSDK.jl), including:
  • Authentication: API key validation and licensing (Julia SDK only)
  • Model Registry: Access to pre-trained models (Julia SDK only)
  • Analytics: Usage tracking and performance metrics
  • Quota Management: License-based usage limits
Python SDK Users: The Python SDK (nimbus-bci) does not require API keys or API access. All processing is local. See the Python SDK documentation for details.

​
API Base URL

https://api.nimbusbci.com

​
Authentication

All API requests require authentication via API key. Include your API key in requests either as:
  • JSON body parameter: "api_key": "nbci_live_..."
  • Query parameter: ?api_key=nbci_live_...
  • Header: X-API-Key: nbci_live_...

​
API Key Format

  • Production keys: nbci_live_ + 48 hex characters
  • Test keys: nbci_test_ + 48 hex characters

​
License Tiers

TierMonthly QuotaFeaturesUse Case
Free10,000 inferencesBasic models, batch inferencePersonal projects, evaluation
Research50,000 inferencesAll models, streaming, trainingAcademic research
Commercial500,000 inferencesPriority support, custom modelsProduction applications
EnterpriseUnlimitedDedicated support, on-premiseLarge-scale deployments

​
SDK Comparison

FeaturePython SDKJulia SDK
API Key Required❌ No✅ Yes
API AccessNot neededRequired for installation
AuthenticationNoneVia API key
Model RegistryNot availablePre-trained models
LicensingProprietary (free eval)Commercial tiers

​
Quick Start (Julia SDK)

using NimbusSDK

# Authentication is handled automatically by the SDK
NimbusSDK.install_core("nbci_live_your_key_here")

# The SDK communicates with the API for:
# - Key validation
# - Model downloads
# - Usage logging (optional)
Python SDK: No API setup needed. Install with pip install nimbus-bci and start using immediately.

​
Endpoints Overview

The Nimbus API provides the following endpoints:
  • Authentication: /v1/auth/validate, /v1/auth/refresh, /v1/auth/revoke
  • SDK Installation: /v1/installer/github-token
  • Models: /v1/models/list
  • Analytics: /v1/analytics/log
  • Health: /api/health
Detailed documentation for each endpoint is available in the following pages.

​
Next Steps

Python SDK

No API key needed - get started immediately

Julia SDK

Complete Julia SDK reference (requires API key)

Authentication

API key validation and management (Julia SDK)

Model Registry

Pre-trained models (Julia SDK)