Quickstart

Follow these steps to get started quickly with our serverless OpenAI-compatible API.

​

Step 1: Set Up Your Account

1. Go to the nCompass Console.
2. Sign up or log in to your account.
3. Navigate to API Settings.
4. Generate a new API key. Keep this key secure, as you’ll need it to authenticate your requests.

​

Step 2: Make Your First API Call

To test the API, use the following code examples. Replace YOUR_API_KEY with your actual API key from the console.

• CURL
• Python

curl https://api.ncompass.tech/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "meta-llama/Llama-3.1-8B-Instruct",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

​

Step 3: Explore Further

Refer to OpenAI’s documentation for more examples.