Skip to main content
Build on top of Basics Gateway with one API for chat, embeddings, audio, and email. Use this docs site to find the right endpoint, choose an auth model, and ship faster with fewer integration decisions.

​
Start here

Start with the core pages below.

API introduction

See the base URLs, API areas, and endpoint map.

Authentication

Learn when to use a Basics API key and BYOK headers.

Public API

Start with chat, embeddings, and core request patterns.

Connections and execute

Connect provider accounts and run user-scoped actions.

​
Self-hosted deployments

Running your own BasicsOS server? The CRM API is a separate set of endpoints on your server for managing contacts, companies, deals, and more.

Self-hosted CRM API

REST API for contacts, companies, deals, tasks, notes, and custom objects on your own BasicsOS server.

​
Key capabilities

These are the main building blocks most integrations use first.

Model discovery

Fetch active model aliases before making requests.

Audio and email

Transcribe audio, generate speech, and send tenant-scoped email.

Error handling

Handle shared gateway errors consistently.