> ## Documentation Index
> Fetch the complete documentation index at: https://basicsos.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# API overview

> Learn how the Basics Gateway API is organized and how to use it.

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.

| Method | Path | Auth | Purpose |
| - | - | - | - |
| `GET` | `/health` | No | Check gateway and dependency health |
| `GET` | `/v1/models` | No | List active model aliases |
| `GET` | `/v1/connections` | Yes | List provider connections |
| `POST` | `/v1/execute/...` | Yes | Run actions against connected providers |
| `POST` | `/v1/chat/completions` | Yes | OpenAI-style chat completions |
| `POST` | `/v1/messages` | Yes | Anthropic/basicOS-style chat shim |
| `POST` | `/v1/embeddings` | Yes | Create embeddings |
| `WS` | `/v1/listen` | Yes | Live streaming STT proxy |
| `POST` | `/v1/audio/transcriptions` | Yes | Convert speech to text |
| `POST` | `/v1/audio/speech` | Yes | Convert text to speech |
| `POST` | `/v1/email/send` | Yes | Send 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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.