skip to content
superbot.gg

Endpoints

Custom OpenAI- or Anthropic-compatible endpoints and @mention aliases.

9 operations. Errors link to their row on the overview.

view .mdopenapi

List custom endpointslink to List custom endpoints

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

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

Add a custom endpointlink to Add a custom endpoint

POST /v1/upstreams

Add an OpenAI- or Anthropic-compatible endpoint and probe it. A failed probe still saves.

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

Operation id createUpstream in Endpoints.

Request body

application/json, required.

  • label string required
  • base_url string required
  • api_key string required
  • dialect string

    One of openai, anthropic, auto.

  • headers object
  • models array of string

Response 201

The saved endpoint and its 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

StatusCodeWhat to change
400invalid_request

A parameter or body field is invalid; param names it and issues lists every problem.

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 POST "https://superbot.gg/v1/upstreams" \
  -H "Authorization: Bearer $SUPERBOT_API_KEY" \
  -H "content-type: application/json" \
  -d '{"label":"your-label","base_url":"https://example.com","api_key":"your-api-key"}'

JavaScript

const res = await fetch(`https://superbot.gg/v1/upstreams`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SUPERBOT_API_KEY}`,
    'content-type': 'application/json',
  },
  body: JSON.stringify({"label":"your-label","base_url":"https://example.com","api_key":"your-api-key"}),
});
console.log(res.status, await res.json());

Python

import os
import requests

res = requests.request(
    "POST",
    "https://superbot.gg/v1/upstreams",
    headers={
        "Authorization": f"Bearer {os.environ['SUPERBOT_API_KEY']}",
        "content-type": "application/json",
    },
    json={"label":"your-label","base_url":"https://example.com","api_key":"your-api-key"},
)
print(res.status_code, res.json())
Response

201 The saved endpoint and its 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"
  }
}

400 The request is malformed or a parameter is invalid; `param` names the field.

{
  "error": "invalid_request",
  "message": "A parameter or body field is invalid; param names it and issues lists every problem.",
  "doc_url": "https://superbot.gg/developers#errors-invalid_request",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}

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

Update a custom endpointlink to Update a custom endpoint

PATCH /v1/upstreams/{slug}

Edit label, dialect, key, models or model names; re-probes when the dial changed.

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

Operation id updateUpstream in Endpoints.

Path parameters

  • slug string required

Request body

application/json, required.

  • label string
  • dialect string

    One of openai, anthropic.

  • api_key string
  • models array of string
  • model_names object

Response 200

The edited endpoint and its last 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

StatusCodeWhat to change
400invalid_request

A parameter or body field is invalid; param names it and issues lists every problem.

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.

404not_found

No such resource on this account; check the id.

view .mdopenapi
Request

curl

curl -sS -X PATCH "https://superbot.gg/v1/upstreams/$SLUG" \
  -H "Authorization: Bearer $SUPERBOT_API_KEY" \
  -H "content-type: application/json" \
  -d '{"label":"your-label","dialect":"openai","api_key":"your-api-key"}'

JavaScript

const slug = 'SLUG';
const res = await fetch(`https://superbot.gg/v1/upstreams/${slug}`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.SUPERBOT_API_KEY}`,
    'content-type': 'application/json',
  },
  body: JSON.stringify({"label":"your-label","dialect":"openai","api_key":"your-api-key"}),
});
console.log(res.status, await res.json());

Python

import os
import requests

slug = "SLUG"
res = requests.request(
    "PATCH",
    f"https://superbot.gg/v1/upstreams/{slug}",
    headers={
        "Authorization": f"Bearer {os.environ['SUPERBOT_API_KEY']}",
        "content-type": "application/json",
    },
    json={"label":"your-label","dialect":"openai","api_key":"your-api-key"},
)
print(res.status_code, res.json())
Response

200 The edited endpoint and its last 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"
  }
}

400 The request is malformed or a parameter is invalid; `param` names the field.

{
  "error": "invalid_request",
  "message": "A parameter or body field is invalid; param names it and issues lists every problem.",
  "doc_url": "https://superbot.gg/developers#errors-invalid_request",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}

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

Remove a custom endpointlink to Remove a custom endpoint

DELETE /v1/upstreams/{slug}

Remove the endpoint and its stored key.

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

Operation id deleteUpstream in Endpoints.

Path parameters

  • slug string required

Response 204

Removed.

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.

404not_found

No such resource on this account; check the id.

view .mdopenapi
Request

curl

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

JavaScript

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

204 Removed.

(no body)

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

Re-probe a custom endpointlink to Re-probe a custom endpoint

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

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.

404not_found

No such resource on this account; check the id.

view .mdopenapi
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"
}

List @mention aliaseslink to List @mention aliases

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

Set an @mention aliaslink to Set an @mention alias

PUT /v1/aliases/{token}

Create or overwrite one personal alias; every paired device picks it up.

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

Operation id setAlias in Endpoints.

Path parameters

  • token string required

Request body

application/json, required.

  • vendor string required
  • model_id string
  • label string
  • custody string

    One of envelope, device-held.

Response 200

Saved.

application/json: AliasWrite.

  • ok boolean required

    One of true.

  • token string required
  • rev integer required

Errors

StatusCodeWhat to change
400invalid_request

A parameter or body field is invalid; param names it and issues lists every problem.

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 PUT "https://superbot.gg/v1/aliases/$TOKEN" \
  -H "Authorization: Bearer $SUPERBOT_API_KEY" \
  -H "content-type: application/json" \
  -d '{"vendor":"your-vendor"}'

JavaScript

const token = 'TOKEN';
const res = await fetch(`https://superbot.gg/v1/aliases/${token}`, {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.SUPERBOT_API_KEY}`,
    'content-type': 'application/json',
  },
  body: JSON.stringify({"vendor":"your-vendor"}),
});
console.log(res.status, await res.json());

Python

import os
import requests

token = "TOKEN"
res = requests.request(
    "PUT",
    f"https://superbot.gg/v1/aliases/{token}",
    headers={
        "Authorization": f"Bearer {os.environ['SUPERBOT_API_KEY']}",
        "content-type": "application/json",
    },
    json={"vendor":"your-vendor"},
)
print(res.status_code, res.json())
Response

200 Saved.

{
  "ok": true,
  "token": "your-token",
  "rev": 0
}

400 The request is malformed or a parameter is invalid; `param` names the field.

{
  "error": "invalid_request",
  "message": "A parameter or body field is invalid; param names it and issues lists every problem.",
  "doc_url": "https://superbot.gg/developers#errors-invalid_request",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}

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

Delete an @mention aliaslink to Delete an @mention alias

DELETE /v1/aliases/{token}

Delete one personal alias on every device.

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

Operation id deleteAlias in Endpoints.

Path parameters

  • token string required

Response 200

Deleted.

application/json: AliasWrite.

  • ok boolean required

    One of true.

  • token string required
  • rev integer 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 DELETE "https://superbot.gg/v1/aliases/$TOKEN" \
  -H "Authorization: Bearer $SUPERBOT_API_KEY"

JavaScript

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

Python

import os
import requests

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

200 Deleted.

{
  "ok": true,
  "token": "your-token",
  "rev": 0
}

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

Get a service’s OpenAPI documentlink to Get a service’s OpenAPI document

GET /docs/services/{service_id}.json

One shipped service’s learned endpoints as an OpenAPI 3.1 document (x-path-templates, x-superbot-replay): endpoint shapes, header rule names and provenance, never an example value or a credential.

No credential needed; any live caller key (Authorization: Bearer sbc_… or x-api-key: sbc_…), or a signed-in session is also accepted.

Operation id getServiceDocument in Endpoints.

Path parameters

  • service_id string required

    The service id, e.g. doordash.

Response 200

The service as OpenAPI 3.1.

application/json: object.

Errors

StatusCodeWhat to change
404not_found

No such resource on this account; check the id.

view .mdopenapi
Request

curl

curl -sS -X GET "https://superbot.gg/docs/services/$SERVICE_ID.json"

JavaScript

const serviceId = 'SERVICE_ID';
const res = await fetch(`https://superbot.gg/docs/services/${serviceId}.json`, {
  method: 'GET',
});
console.log(res.status, await res.json());

Python

import os
import requests

service_id = "SERVICE_ID"
res = requests.request(
    "GET",
    f"https://superbot.gg/docs/services/{service_id}.json",
)
print(res.status_code, res.json())
Response

200 The service as OpenAPI 3.1.

{}

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