Skip to main content

​
Nimbus API

The Nimbus API provides backend services for the NimbusSDK.jl ecosystem, including:
  • Authentication: API key validation and licensing
  • Model Registry: Access to pre-trained models
  • Analytics: Usage tracking and performance metrics
  • Quota Management: License-based usage limits

​
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

​
Quick Start

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)

​
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

Authentication

API key validation and management

Model Registry

List and download pre-trained models

Julia SDK

Complete Julia SDK reference

Quickstart

Get started with NimbusSDK