Skip to main content
The Basics Gateway API gives you one entry point for chat, embeddings, audio, and email. Use this page to understand the base URLs, the public endpoint surface, and the pages you should read before you start building.

​
Base URLs

Choose the base URL that matches your environment:
  • Production: https://api.basicsos.com
  • Local development: http://localhost:3002
All paths in this reference are relative to the selected base URL.

​
Public API quick summary

The public API is organized around a small set of core workflows.
MethodPathAuthPurpose
GET/healthNoCheck gateway and dependency health
GET/v1/modelsNoList active model aliases
GET/v1/connectionsYesList provider connections
POST/v1/execute/...YesRun actions against connected providers
POST/v1/chat/completionsYesOpenAI-style chat completions
POST/v1/messagesYesAnthropic/basicOS-style chat shim
POST/v1/embeddingsYesCreate embeddings
WS/v1/listenYesLive streaming STT proxy
POST/v1/audio/transcriptionsYesConvert speech to text
POST/v1/audio/speechYesConvert text to speech
POST/v1/email/sendYesSend tenant-scoped email

​
Before you build

Read these pages first so you can pick the right auth model, use the right aliases, and handle errors consistently:
  • /api-reference/authentication for auth and BYOK headers
  • /api-reference/connections-and-execute for user-scoped connections and execute flows
  • /api-reference/errors for the shared error model
  • /api-reference/health-and-models for model discovery