---
title: "Add a custom endpoint – Superbot API"
canonical_url: "https://superbot.gg/developers/endpoints/createUpstream"
summary: "Add an OpenAI- or Anthropic-compatible endpoint and probe it. A failed probe still saves."
---

> Markdown of https://superbot.gg/developers/endpoints/createUpstream. Site index: /llms.txt.

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