Quick Start
From zero to your first chat response. This walks through creating the resources you need and calling the Chat API.
- 1
Create a workspace
In the dashboard, open the workspace switcher (top left) and create a workspace. A default project is created for you automatically. - 2
Create a project
Projects isolate environments (development vs. production). Use the default project or create a new one from the Projects page. - 3
Generate an API key
On the API keys page, click Create secret key. Carrier OS generates a matched Secret + Publishable pair. - 4
Copy your secret key
The secret key (carrier_sk_…) is shown only once. Copy and store it securely — if you lose it, revoke it and create a new one. - 5
Call the Chat API
Send your first request using Bearer authentication:
bash
curl -X POST https://api.carrieros.ai/v1/chat \
-H "Authorization: Bearer carrier_sk_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"mode": "general",
"message": "Explain OAuth in two sentences."
}'You'll get back a response and a session id you can reuse to continue the conversation:
json
{
"success": true,
"data": {
"id": "…",
"response": "OAuth is an open standard for delegated access…",
"session_id": "…",
"tokens_used": 523
}
}Continue the conversation by passing the returned
session_id on your next /v1/chat call.Rather not write HTTP calls? The Carrier OS CLI does this for you — install,
cos login, and chat from your terminal.