---
title: "Endpoints – Superbot API"
canonical_url: "https://superbot.gg/developers/endpoints"
last_updated: "2026-09-25"
summary: "Custom OpenAI- or Anthropic-compatible endpoints and @mention aliases."
---

> Markdown twin of https://superbot.gg/developers/endpoints (the HTML page is canonical).
> The site index for agents is /llms.txt; every content page has a twin at its path plus `.md`.

# Endpoints

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

Base URL: `https://superbot.gg`. Errors: [https://superbot.gg/developers#errors](https://superbot.gg/developers#errors). Spec: [https://superbot.gg/docs/openapi.json](https://superbot.gg/docs/openapi.json).

## Operations

- [List custom endpoints](https://superbot.gg/developers/endpoints/listUpstreams.md): `GET /v1/upstreams`
- [Add a custom endpoint](https://superbot.gg/developers/endpoints/createUpstream.md): `POST /v1/upstreams`
- [Update a custom endpoint](https://superbot.gg/developers/endpoints/updateUpstream.md): `PATCH /v1/upstreams/{slug}`
- [Remove a custom endpoint](https://superbot.gg/developers/endpoints/deleteUpstream.md): `DELETE /v1/upstreams/{slug}`
- [Re-probe a custom endpoint](https://superbot.gg/developers/endpoints/probeUpstream.md): `POST /v1/upstreams/{slug}/probe`
- [List @mention aliases](https://superbot.gg/developers/endpoints/listAliases.md): `GET /v1/aliases`
- [Set an @mention alias](https://superbot.gg/developers/endpoints/setAlias.md): `PUT /v1/aliases/{token}`
- [Delete an @mention alias](https://superbot.gg/developers/endpoints/deleteAlias.md): `DELETE /v1/aliases/{token}`
- [Get a service’s OpenAPI document](https://superbot.gg/developers/endpoints/getServiceDocument.md): `GET /docs/services/{service_id}.json`

## List custom endpoints

`GET /v1/upstreams`

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

- Operation id: `listUpstreams`
- Group: [Endpoints](https://superbot.gg/developers/endpoints.md)
- Auth: A caller key holding `endpoints:read` (`Authorization: Bearer sbc_…` or `x-api-key: sbc_…`), or a signed-in session.
- Scopes: `endpoints:read`

### Response 200

The endpoints.

`application/json`: UpstreamList.

- `object` (string, required): One of `list`.
- `data` (array of Upstream, required)
  - `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)
    - `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`.
  - `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)
    - `ok` (boolean, required)
    - `models_found` (integer)
    - `error` (string)
    - `at` (string)
  - `updated_at` (string)

### Errors

Every refusal carries `error`, `message`, `doc_url` and `request_id`; the gateway routes answer in the dialect you dialed.

| Status | Codes | When |
| --- | --- | --- |
| 401 | [`unauthorized`](https://superbot.gg/developers#errors-unauthorized) | The bearer is missing, malformed or unknown. |
| 403 | [`insufficient_scope`](https://superbot.gg/developers#errors-insufficient_scope) | The key lacks a scope (insufficient_scope), is revoked, or may not call this route. |

### Examples

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

```js
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())
```

## Add a custom endpoint

`POST /v1/upstreams`

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

- Operation id: `createUpstream`
- Group: [Endpoints](https://superbot.gg/developers/endpoints.md)
- Auth: A caller key holding `endpoints:write` (`Authorization: Bearer sbc_…` or `x-api-key: sbc_…`), or a signed-in session.
- Scopes: `endpoints:write`

### 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)
  - `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)
    - `ok` (boolean, required)
    - `models_found` (integer)
    - `error` (string)
    - `at` (string)
  - `updated_at` (string)
- `probe` (UpstreamProbe, required)
  - `ok` (boolean, required)
  - `models_found` (integer)
  - `error` (string)
  - `at` (string)

### Errors

Every refusal carries `error`, `message`, `doc_url` and `request_id`; the gateway routes answer in the dialect you dialed.

| Status | Codes | When |
| --- | --- | --- |
| 400 | [`invalid_request`](https://superbot.gg/developers#errors-invalid_request) | The request is malformed or a parameter is invalid; `param` names the field. |
| 401 | [`unauthorized`](https://superbot.gg/developers#errors-unauthorized) | The bearer is missing, malformed or unknown. |
| 403 | [`insufficient_scope`](https://superbot.gg/developers#errors-insufficient_scope) | The key lacks a scope (insufficient_scope), is revoked, or may not call this route. |

### Examples

```sh
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"}'
```

```js
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())
```

## Update a custom endpoint

`PATCH /v1/upstreams/{slug}`

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

- Operation id: `updateUpstream`
- Group: [Endpoints](https://superbot.gg/developers/endpoints.md)
- Auth: A caller key holding `endpoints:write` (`Authorization: Bearer sbc_…` or `x-api-key: sbc_…`), or a signed-in session.
- Scopes: `endpoints:write`

### Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `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)
  - `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)
    - `ok` (boolean, required)
    - `models_found` (integer)
    - `error` (string)
    - `at` (string)
  - `updated_at` (string)
- `probe` (UpstreamProbe, required)
  - `ok` (boolean, required)
  - `models_found` (integer)
  - `error` (string)
  - `at` (string)

### Errors

Every refusal carries `error`, `message`, `doc_url` and `request_id`; the gateway routes answer in the dialect you dialed.

| Status | Codes | When |
| --- | --- | --- |
| 400 | [`invalid_request`](https://superbot.gg/developers#errors-invalid_request) | The request is malformed or a parameter is invalid; `param` names the field. |
| 401 | [`unauthorized`](https://superbot.gg/developers#errors-unauthorized) | The bearer is missing, malformed or unknown. |
| 403 | [`insufficient_scope`](https://superbot.gg/developers#errors-insufficient_scope) | The key lacks a scope (insufficient_scope), is revoked, or may not call this route. |
| 404 | [`not_found`](https://superbot.gg/developers#errors-not_found) | No such resource on this account. |

### Examples

```sh
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"}'
```

```js
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())
```

## Remove a custom endpoint

`DELETE /v1/upstreams/{slug}`

Remove the endpoint and its stored key.

- Operation id: `deleteUpstream`
- Group: [Endpoints](https://superbot.gg/developers/endpoints.md)
- Auth: A caller key holding `endpoints:write` (`Authorization: Bearer sbc_…` or `x-api-key: sbc_…`), or a signed-in session.
- Scopes: `endpoints:write`

### Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `slug` | string | required |  |

### Response 204

Removed.

### Errors

Every refusal carries `error`, `message`, `doc_url` and `request_id`; the gateway routes answer in the dialect you dialed.

| Status | Codes | When |
| --- | --- | --- |
| 401 | [`unauthorized`](https://superbot.gg/developers#errors-unauthorized) | The bearer is missing, malformed or unknown. |
| 403 | [`insufficient_scope`](https://superbot.gg/developers#errors-insufficient_scope) | The key lacks a scope (insufficient_scope), is revoked, or may not call this route. |
| 404 | [`not_found`](https://superbot.gg/developers#errors-not_found) | No such resource on this account. |

### Examples

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

```js
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())
```

## 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.

- Operation id: `probeUpstream`
- Group: [Endpoints](https://superbot.gg/developers/endpoints.md)
- Auth: A caller key holding `endpoints:write` (`Authorization: Bearer sbc_…` or `x-api-key: sbc_…`), or a signed-in session.
- Scopes: `endpoints:write`

### Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `slug` | string | required |  |

### Response 200

The endpoint and the probe.

`application/json`: UpstreamWithProbe.

- `upstream` (Upstream, required)
  - `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)
    - `ok` (boolean, required)
    - `models_found` (integer)
    - `error` (string)
    - `at` (string)
  - `updated_at` (string)
- `probe` (UpstreamProbe, required)
  - `ok` (boolean, required)
  - `models_found` (integer)
  - `error` (string)
  - `at` (string)

### Errors

Every refusal carries `error`, `message`, `doc_url` and `request_id`; the gateway routes answer in the dialect you dialed.

| Status | Codes | When |
| --- | --- | --- |
| 401 | [`unauthorized`](https://superbot.gg/developers#errors-unauthorized) | The bearer is missing, malformed or unknown. |
| 403 | [`insufficient_scope`](https://superbot.gg/developers#errors-insufficient_scope) | The key lacks a scope (insufficient_scope), is revoked, or may not call this route. |
| 404 | [`not_found`](https://superbot.gg/developers#errors-not_found) | No such resource on this account. |

### Examples

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

```js
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())
```

## List @mention aliases

`GET /v1/aliases`

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

- Operation id: `listAliases`
- Group: [Endpoints](https://superbot.gg/developers/endpoints.md)
- Auth: A caller key holding `endpoints:read` (`Authorization: Bearer sbc_…` or `x-api-key: sbc_…`), or a signed-in session.
- Scopes: `endpoints:read`

### Response 200

The aliases.

`application/json`: array of Alias.

### Errors

Every refusal carries `error`, `message`, `doc_url` and `request_id`; the gateway routes answer in the dialect you dialed.

| Status | Codes | When |
| --- | --- | --- |
| 401 | [`unauthorized`](https://superbot.gg/developers#errors-unauthorized) | The bearer is missing, malformed or unknown. |
| 403 | [`insufficient_scope`](https://superbot.gg/developers#errors-insufficient_scope) | The key lacks a scope (insufficient_scope), is revoked, or may not call this route. |

### Examples

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

```js
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())
```

## Set an @mention alias

`PUT /v1/aliases/{token}`

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

- Operation id: `setAlias`
- Group: [Endpoints](https://superbot.gg/developers/endpoints.md)
- Auth: A caller key holding `endpoints:write` (`Authorization: Bearer sbc_…` or `x-api-key: sbc_…`), or a signed-in session.
- Scopes: `endpoints:write`

### Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `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

Every refusal carries `error`, `message`, `doc_url` and `request_id`; the gateway routes answer in the dialect you dialed.

| Status | Codes | When |
| --- | --- | --- |
| 400 | [`invalid_request`](https://superbot.gg/developers#errors-invalid_request) | The request is malformed or a parameter is invalid; `param` names the field. |
| 401 | [`unauthorized`](https://superbot.gg/developers#errors-unauthorized) | The bearer is missing, malformed or unknown. |
| 403 | [`insufficient_scope`](https://superbot.gg/developers#errors-insufficient_scope) | The key lacks a scope (insufficient_scope), is revoked, or may not call this route. |

### Examples

```sh
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"}'
```

```js
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())
```

## Delete an @mention alias

`DELETE /v1/aliases/{token}`

Delete one personal alias on every device.

- Operation id: `deleteAlias`
- Group: [Endpoints](https://superbot.gg/developers/endpoints.md)
- Auth: A caller key holding `endpoints:write` (`Authorization: Bearer sbc_…` or `x-api-key: sbc_…`), or a signed-in session.
- Scopes: `endpoints:write`

### Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `token` | string | required |  |

### Response 200

Deleted.

`application/json`: AliasWrite.

- `ok` (boolean, required): One of `true`.
- `token` (string, required)
- `rev` (integer, required)

### Errors

Every refusal carries `error`, `message`, `doc_url` and `request_id`; the gateway routes answer in the dialect you dialed.

| Status | Codes | When |
| --- | --- | --- |
| 401 | [`unauthorized`](https://superbot.gg/developers#errors-unauthorized) | The bearer is missing, malformed or unknown. |
| 403 | [`insufficient_scope`](https://superbot.gg/developers#errors-insufficient_scope) | The key lacks a scope (insufficient_scope), is revoked, or may not call this route. |

### Examples

```sh
curl -sS -X DELETE "https://superbot.gg/v1/aliases/$TOKEN" \
  -H "Authorization: Bearer $SUPERBOT_API_KEY"
```

```js
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())
```

## 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.

- Operation id: `getServiceDocument`
- Group: [Endpoints](https://superbot.gg/developers/endpoints.md)
- Auth: No credential needed; any live caller key (`Authorization: Bearer sbc_…` or `x-api-key: sbc_…`), or a signed-in session is also accepted.
- Scopes: none

### Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `service_id` | string | required | The service id, e.g. `doordash`. |

### Response 200

The service as OpenAPI 3.1.

`application/json`: object.

### Errors

Every refusal carries `error`, `message`, `doc_url` and `request_id`; the gateway routes answer in the dialect you dialed.

| Status | Codes | When |
| --- | --- | --- |
| 404 | [`not_found`](https://superbot.gg/developers#errors-not_found) | No such resource on this account. |

### Examples

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

```js
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())
```