---
title: "Re-probe a custom endpoint – Superbot API"
canonical_url: "https://superbot.gg/developers/endpoints/probeUpstream"
summary: "Dial the stored endpoint and fold what it lists into the row. A failed probe is a 200 whose report says so."
---

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

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