Docs / Getting started
Quickstart
Get your first request running in five minutes, with no new dependencies to install.
Step 1: Get an API key
After signing up, open the "API Keys" page in the console and create a new key. The key is shown in full only once, at creation time — store it in your secrets manager or an environment variable right away.
BASH
export COMPASS_KEY=sk-compass-xxxxxxxxxxxxxxxx
export COMPASS_BASE=https://compassapi.ai/v1Step 2: Send a request
The endpoint path, request body, and response body match OpenAI Chat Completions exactly — just swap the domain.
CURL
curl $COMPASS_BASE/chat/completions \
-H "Authorization: Bearer $COMPASS_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "deepseek-v4",
"messages": [{"role": "user", "content": "Hello"}]
}'Step 3: Switch to the SDK
PYTHON
from openai import OpenAI
client = OpenAI(
api_key=os.environ["COMPASS_KEY"],
base_url="https://compassapi.ai/v1",
)
resp = client.chat.completions.create(
model="deepseek-v4",
messages=[{"role": "user", "content": "Hello"}],
)Every request leaves one metadata record in the console's usage logs (model, tokens, cost, latency, request id). Request and response bodies are never stored.
PreviousThis is the first doc
NextAuthentication & keys