Introduction

Carrier OS is a unified AI platform. The public API lets your applications, scripts, and the Carrier OS CLI send chat, run knowledge search, and manage sessions — all behind a single, stable interface.

2 min read

What is Carrier OS?

Carrier OS abstracts away individual model providers. Instead of choosing a raw model, you select a Carrier Mode (general, developer, or research) that maps to a curated, production-tuned configuration behind the scenes. Your integration never changes when we upgrade or swap the underlying model.

How the platform is organized

Everything you build is scoped through a simple hierarchy. Each layer inherits from the one above it, and API keys are always tied to exactly one project.

text

Developer account
   └── Workspace          (groups related work + billing)
         └── Project        (an app or environment: dev / prod)
               └── API Key   (Secret + Publishable pair)
                     └── Public /v1 APIs

Requests made with an API key are automatically scoped to that key's workspace and project. A key can never read or write another project's data.

Two API surfaces

Management API (/api/platform/*) — used by this dashboard to manage workspaces, projects, and keys. Authenticated with your login session (JWT).
Public API (/v1/*) — what your code calls. Authenticated with an API key (Authorization: Bearer carrier_sk_…). This documentation covers the Public API.

Base URL

text

https://api.carrieros.ai/v1

New here? Follow the Quick Start to make your first request in under five minutes.

Prefer the terminal? The Carrier OS CLI is the official developer client — an interactive AI shell over the same Public API.

Quick Start

Your first request in 5 minutes

Authentication

API keys & Bearer tokens

Developer Workflow

The end-to-end journey

Carrier OS CLI

Chat from your terminal