List custom endpoints

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

GET /v1/upstreams

Every custom endpoint on the account. Never the API key; header values are redacted for caller keys.

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

Operation id listUpstreams in Endpoints.

Response 200

The endpoints.

application/json: UpstreamList.

object string required
One of list.
data array of Upstream required
10 fields
- slug string required
  The endpoint id; custom for the legacy singleton.
- label string required
- base_url string required
- dialect string required
  One of openai, anthropic.
- headers object
  Extra header names; values are redacted for caller keys.
- models array of string
- model_names object
- model_meta object
- probe UpstreamProbe
  4 fields
  - ok boolean required
  - models_found integer
  - error string
  - at string
- updated_at string
has_more boolean required
first_id string | null required
Id of the first item on this page; pass as before_id for the previous page.
last_id string | null required
Id of the last item on this page; pass as after_id for the next page.
upstreams array of Upstream required
Legacy: the same rows as data.
10 fields
- slug string required
  The endpoint id; custom for the legacy singleton.
- label string required
- base_url string required
- dialect string required
  One of openai, anthropic.
- headers object
  Extra header names; values are redacted for caller keys.
- models array of string
- model_names object
- model_meta object
- probe UpstreamProbe
  4 fields
  - ok boolean required
  - models_found integer
  - error string
  - at string
- updated_at string

Errors

Status	Code	What to change
401	`unauthorized`	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.
403	`insufficient_scope`	The key lacks the scope in `required_scopes`; mint a key that holds it.

view .md openapi

Request

curl

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

JavaScript

const res = await fetch(`https://superbot.gg/v1/upstreams`, {
  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/upstreams",
    headers={
        "Authorization": f"Bearer {os.environ['SUPERBOT_API_KEY']}",
    },
)
print(res.status_code, res.json())

Response

200 The endpoints.

{
  "object": "list",
  "data": [
    {
      "slug": "your-slug",
      "label": "your-label",
      "base_url": "https://example.com",
      "dialect": "openai",
      "headers": {},
      "models": [
        "your-models"
      ],
      "model_names": {},
      "model_meta": {},
      "probe": {
        "ok": true,
        "models_found": 0,
        "error": "your-error",
        "at": "your-at"
      },
      "updated_at": "your-updated-at"
    }
  ],
  "has_more": true,
  "first_id": "your-first-id",
  "last_id": "your-last-id",
  "upstreams": [
    {
      "slug": "your-slug",
      "label": "your-label",
      "base_url": "https://example.com",
      "dialect": "openai",
      "headers": {},
      "models": [
        "your-models"
      ],
      "model_names": {},
      "model_meta": {},
      "probe": {
        "ok": true,
        "models_found": 0,
        "error": "your-error",
        "at": "your-at"
      },
      "updated_at": "your-updated-at"
    }
  ]
}

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"
}