Developer Workflow

The complete path from an empty account to a working integration — in the dashboard, the Playground, and the CLI. Each step links to its detailed page.

End-to-end flow

text
Create Workspace
      │
Create Project
      │
Generate API Key        (carrier_sk_… + carrier_pk_…)
      │
Test APIs (Playground)  — send a chat with your key, see the response + raw JSON
      │
Install Carrier OS CLI  (npm install -g @carrieros/cli)
      │
Login                   (cos login)
      │
Chat                    (interactive shell — just type)
      │
Sessions                (conversations persist + resume)
      │
Usage & Logs            (requests, tokens, cost — per key)

Step by step

  1. 1

    Create a workspace

    Groups related work and billing. See Creating a Workspace. A default project is created for you.
  2. 2

    Create a project

    Isolates an app or environment (dev / prod). See Creating a Project.
  3. 3

    Generate an API key

    Produces a matched Secret + Publishable pair, scoped to that project. See Generating API Keys.
  4. 4

    Test in the Playground

    Pick your workspace, project, key, mode, and model, then send a message and inspect the response and raw JSON. See API Playground.
  5. 5

    Install the CLI

    npm install -g @carrieros/cli. See Installation.
  6. 6

    Log in and chat

    cos login then cos to open the interactive shell and start chatting.
  7. 7

    Manage sessions

    Conversations persist and resume across turns. See Sessions.
  8. 8

    Monitor usage & logs

    Track requests, tokens, and cost per key from the dashboard and Usage API.
In a hurry? The 5-Minute Quick Start walks this whole flow in one sitting.