Skip to content

API Overview

mycellm exposes an OpenAI-compatible REST API on port 8420. Any tool that works with the OpenAI API works with mycellm.

http://localhost:8420/v1

When MYCELLM_API_KEY is set, all /v1/* endpoints require authentication:

Authorization: Bearer <your-api-key>

Public endpoints (/health, /metrics, /v1/public/*) never require auth.

MethodPathAuthDescription
POST/v1/chat/completionsYesChat completions (streaming supported)
GET/v1/modelsYesList available models
POST/v1/embeddingsYesText embeddings
MethodPathDescription
POST/v1/public/chat/completionsRate-limited public chat (5K tokens/day)
GET/v1/node/public/statsNetwork stats
MethodPathDescription
GET/v1/node/statusNode status
GET/v1/node/systemHardware info
GET/v1/node/creditsCredit balance
POST/v1/node/models/loadLoad a model
POST/v1/node/models/unloadUnload a model
GET/v1/node/fleet/hardwareFleet aggregate stats
MethodPathAuthDescription
GET/healthNoHealth check + version
GET/metricsNoPrometheus metrics
GET/v1/node/versionYesVersion + update check
MethodPathDescription
POST/v1/admin/nodes/announceNode announcement
GET/v1/admin/nodesList fleet nodes
POST/v1/admin/nodes/{id}/approveApprove pending node

Every running node serves OpenAPI docs at:

http://localhost:8420/docs