skip to content
superbot.gg

List @mention aliases

Part of Endpoints, 9 operations. The overview covers keys, scopes and errors.

GET /v1/aliases

Your own aliases, the built-in ones, then the catalog; available says whether the vendor is linked.

A caller key holding endpoints:read (Authorization: Bearer sbc_… or x-api-key: sbc_…), or a signed-in session.

Operation id listAliases in Endpoints.

Response 200

The aliases.

application/json: array of Alias.

  • token string required
  • vendor string required
  • model_id string required
  • label string required
  • tier string required
  • custody string required
  • available boolean required

Errors

StatusCodeWhat to change
401unauthorized

Send a live caller key or session as Authorization: Bearer … or x-api-key. No key yet: create one at /account/api, or sign a user in at /auth.md.

403insufficient_scope

The key lacks the scope in required_scopes; mint a key that holds it.

view .mdopenapi
Request

curl

curl -sS -X GET "https://superbot.gg/v1/aliases" \
  -H "Authorization: Bearer $SUPERBOT_API_KEY"

JavaScript

const res = await fetch(`https://superbot.gg/v1/aliases`, {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SUPERBOT_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os
import requests

res = requests.request(
    "GET",
    "https://superbot.gg/v1/aliases",
    headers={
        "Authorization": f"Bearer {os.environ['SUPERBOT_API_KEY']}",
    },
)
print(res.status_code, res.json())
Response

200 The aliases.

[
  {
    "token": "@claude",
    "vendor": "your-vendor",
    "model_id": "your-model-id",
    "label": "your-label",
    "tier": "your-tier",
    "custody": "your-custody",
    "available": true
  }
]

401 The bearer is missing, malformed or unknown.

{
  "error": "unauthorized",
  "message": "Send a live caller key or session as Authorization: Bearer … or x-api-key. No key yet: create one at /account/api, or sign a user in at /auth.md.",
  "doc_url": "https://superbot.gg/developers#errors-unauthorized",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}

403 The key lacks a scope (insufficient_scope), is revoked, or may not call this route.

{
  "error": "insufficient_scope",
  "message": "The key lacks the scope in required_scopes; mint a key that holds it.",
  "doc_url": "https://superbot.gg/developers#errors-insufficient_scope",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}