REST API
Authenticate, make a first call, and find the endpoints for each SUPERWISE object, from Sentinels to agents, guardrails, datasets, and dashboards
The SUPERWISE® REST API automates SUPERWISE Sentinel and the SUPERWISE Agentic Management Platform (AMP) over HTTPS. Exchange a client ID and secret for a bearer token, then call https://api.superwise.ai/v1/... with that token in the Authorization header. Every object you manage in the SUPERWISE app, from a Sentinel to an agent or a dashboard, has endpoints here.
Authenticate
All SUPERWISE® endpoints are HTTPS only and need a bearer token. Each token is a JWT, valid for 24 hours.
- Create a client ID and secret key. See Generate tokens.
- Exchange them for a token:
curl -s -X POST https://authentication.superwise.ai/identity/resources/auth/v1/api-token \
-H "Content-Type: application/json" \
-d '{"clientId": "<CLIENT_ID>", "secret": "<SECRET_KEY>"}'The token is in the accessToken field of the response. The Python SDK does this exchange for you and refreshes the token, so you only need it for direct HTTP calls. See SDK.
Example: read a Sentinel's guardrail metrics
List your Sentinels, then read the guardrail metrics of one of them.
TOKEN="<ACCESS_TOKEN>"
# 1. List Sentinels. Each item in "items" carries its id, status and last heartbeat.
curl -s "https://api.superwise.ai/v1/sentinels?page=1&size=20" \
-H "Authorization: Bearer $TOKEN"
# 2. Read the guardrail metrics of one Sentinel.
curl -s https://api.superwise.ai/v1/sentinels/<SENTINEL_ID>/guardrails/metrics \
-H "Authorization: Bearer $TOKEN"List calls are paged: use page and size, and read total and pages in the response.
Main objects and their endpoints
Each object has an overview in the API reference that lists every call it takes.
| Object | What it is | Common calls |
|---|---|---|
| Sentinels | A running SUPERWISE Sentinel AI gateway, on a PC or in your network, and the guardrails it applies | List sentinels, Get a sentinel, Get guardrail metrics |
| Guardrails | Rules that check prompts and responses before they go further | List guardrails, Run guardrules |
| Agents | An AI application built in SUPERWISE or registered from Flowise, with versions you publish | List agents, Ask an agent, Unarchive an agent |
| Model providers | The connection to a model service such as OpenAI, Anthropic, Google AI, or Vertex AI | List model providers, Get a model provider |
| MCP tools | A registered Model Context Protocol server whose tools agents can call | List MCP tools, Test MCP connectivity |
| Datasets | Records described by a schema, for analysis and monitoring | List datasets, Log a record |
| Dashboards | Saved queries and their widgets | List dashboards, Search dashboards |
The full API reference also covers policies, sources, destinations, knowledge, and tags, and lets you try each call with your token.
Get Sentinel: Create a free SUPERWISE® account to get a client ID and secret.
See also
- Generate tokens: create the client ID and secret.
- SDK: the same objects from Python.
- Gateway reference: the Sentinel gateway's own routes and CLI commands, which are separate from this API.
Updated 17 days ago