Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nimbusbci.com/llms.txt

Use this file to discover all available pages before exploring further.

​
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.

​
Start Here

Authentication

Validate API keys, quotas, and license behavior.

Endpoints

Review model registry and analytics API routes.

Julia Setup

Install NimbusSDK.jl and enable authenticated workflows.

​
API Base URL

https://api.nimbusbci.com

​
Authentication

All API requests require authentication via API key. Prefer the X-API-Key header for server-to-server calls:
  • Header: X-API-Key: nbci_live_...
  • JSON body parameter: "api_key": "nbci_live_..." for POST endpoints that accept a request body
Some GET endpoints also accept ?api_key=nbci_live_... for compatibility. Avoid query-string keys in production because URLs are commonly captured in logs, browser history, proxies, and referrer headers.

​
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

​
SDK Setup

This page documents the backend API scope and endpoint surface. For the Julia installation and first-inference walkthrough, use the Julia SDK Quickstart. For Python, no API setup is required; install nimbus-bci from the Python SDK Quickstart.

​
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 Read

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)