Getting Started

Getting Started

Welcome to Supervisor! This guide will help you get up and running with our moderation API in minutes.

1. Create Your Account

First, sign up for a Supervisor account using Discord, Google, or GitHub OAuth.

2. Get Your API Key

Navigate to the API Keys section in your dashboard to generate your first API key.

  1. Go to Dashboard > API Keys
  2. Click 'Create New Key'
  3. Give your key a descriptive name
  4. Copy and securely store your API key (format: sk_prod_...)

3. Make Your First Request

Use your API key to moderate content. Select a model:

  • Observer (~£0.0014/KB)
  • Sentinel (~£0.0027/KB)
  • Arbiter (~£0.0055/KB)
curl -X POST https://supervisor.gg/api/moderate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Your content to moderate",
    "model": "observer"
  }'

4. Understand the Response

The API returns a JSON response with moderation results:

{
    "flagged": false,
    "labels": [],
    "model_version": "2.1"
}

When content is flagged, labels lists the categories that triggered:

{
    "flagged": true,
    "labels": ["toxicity", "insult"],
    "model_version": "2.1"
}

Depending on your request and plan, the response may also include implicit_labels (implicitly harmful content), and needs_context with context_labels when using context-aware moderation.

5. Model Access

Premium is the only plan, and it includes all three models: Observer, Sentinel and Arbiter. It also includes context-aware moderation, image and video moderation, implicit moderation, custom bot appearance and the Platform API. See the pricing page for current credit allowances.

Two closed plans still exist for the accounts already on them:

  • Legacy Free (accounts created before 13 July 2026): Observer model only, 0.25 GBP of credits each month, no context.
  • Legacy Basic and Standard: Observer only, and Observer plus Sentinel respectively, both with context.

Requesting a model your plan does not include returns an error.

6. Credit Management

Each moderation request consumes credits based on content size and model used:

  • Observer: ~£0.0014/KB
  • Sentinel: ~£0.0027/KB
  • Arbiter: ~£0.0055/KB

When your balance is exhausted: Requests will fail with a 402 Payment Required error until credits are replenished (monthly reset or upgrade).

7. Advanced: Context-Aware Moderation

Some messages may need conversation history for accurate moderation. Use the include_context parameter to check (included with Premium):

curl -X POST https://supervisor.gg/api/moderate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "stop it",
    "include_context": true
  }'

# Response:
{
    "flagged": false,
    "labels": [],
    "needs_context": true,
    "context_labels": ["harassment"]
}

If needs_context is true, include message history in a follow-up moderation request for better accuracy.

8. Image Moderation

You can also moderate images by sending base64-encoded image data in the image field instead of text:

curl -X POST https://supervisor.gg/api/moderate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image": "<base64-encoded image data>",
    "model": "sentinel"
  }'

Send text and images in separate requests. Costs for images are calculated based on the original image file size.

9. Next Steps