Nexus

HTTP API

OpenAI-compatible endpoints and admin API reference.

OpenAI-Compatible Endpoints

Chat Completions

POST /v1/chat/completions

Request and response format follows the OpenAI API specification. Supports streaming via stream: true.

Embeddings

POST /v1/embeddings

Models

GET /v1/models

Returns all models from all registered providers, plus model aliases.

Admin Endpoints

Tenants

MethodPathDescription
GET/admin/tenantsList all tenants
POST/admin/tenantsCreate a tenant
GET/admin/tenants/:idGet a tenant
PUT/admin/tenants/:idUpdate a tenant
DELETE/admin/tenants/:idDelete a tenant

API Keys

MethodPathDescription
GET/admin/keysList keys for a tenant
POST/admin/keysCreate an API key
DELETE/admin/keys/:idRevoke an API key

Usage

MethodPathDescription
GET/admin/usageQuery usage records
GET/admin/usage/summaryAggregated usage summary

Providers

MethodPathDescription
GET/admin/providersList registered providers

Health

MethodPathDescription
GET/healthGateway health check

Response Headers

All responses include:

  • X-Nexus-Request-ID — Unique request identifier
  • X-Nexus-Provider — Provider that served the request
  • X-Nexus-Cache — HIT or MISS

Custom Plugin

Build a custom lifecycle plugin for Nexus.

Go Packages

Package reference for all Nexus Go packages.

On this page

OpenAI-Compatible EndpointsChat CompletionsEmbeddingsModelsAdmin EndpointsTenantsAPI KeysUsageProvidersHealthResponse Headers