Re-probe a custom endpoint

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

POST /v1/upstreams/{slug}/probe

Dial the stored endpoint and fold what it lists into the row. A failed probe is a 200 whose report says so.

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

Operation id probeUpstream in Endpoints.

Path parameters

slug string required

Response 200

The endpoint and the probe.

application/json: UpstreamWithProbe.

upstream 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
probe UpstreamProbe required
4 fields
- ok boolean required
- models_found integer
- error string
- 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.
404	`not_found`	No such resource on this account; check the id.

view .md openapi

Request

curl

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

JavaScript

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

Python

import os
import requests

slug = "SLUG"
res = requests.request(
    "POST",
    f"https://superbot.gg/v1/upstreams/{slug}/probe",
    headers={
        "Authorization": f"Bearer {os.environ['SUPERBOT_API_KEY']}",
    },
)
print(res.status_code, res.json())

Response

200 The endpoint and the probe.

{
  "upstream": {
    "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"
  },
  "probe": {
    "ok": true,
    "models_found": 0,
    "error": "your-error",
    "at": "your-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"
}

404 No such resource on this account.

{
  "error": "not_found",
  "message": "No such resource on this account; check the id.",
  "doc_url": "https://superbot.gg/developers#errors-not_found",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}