Svix

Svix Authentication API

Easily give your users access to our pre-built management UI.

GitHub OpenAPI

Operations 21

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/v1/auth/app-portal-access/{app_id} Get a magic link to the Consumer App Portal · Get Consumer App Portal Access #
Ask an LLM
“How do I give my customer a login link to their webhook portal in Svix?”
“Can I make the consumer app portal read-only for a customer?”
Tell an agent
Generate an app portal magic link for application {app_id}.
Create a read-only consumer portal login for app {app_id} that expires in {expiry} seconds.
GET /api/v1/auth/whoami Show which account the current token belongs to · Whoami #
Ask an LLM
“Which account is my current API token tied to?”
“Can I check who I'm authenticated as before making calls?”
Tell an agent
Tell me which account my current token is authenticated as.
Run a whoami check on the token I'm using.
POST /api/v1/auth/logout Log out an app token · Logout #
Ask an LLM
“How do I log out an application portal token when the session ends?”
“Can I use logout to kill a token that isn't an app token?”
Tell an agent destructive · confirm first
Log out the app token I'm currently using.
End this app portal token's session now.
POST /api/v1/auth/app/{app_id}/expire-all Expire every token for an application · Expire All #
Ask an LLM
“How do I revoke all portal tokens issued for one application at once?”
“Can I expire only certain portal sessions for an app instead of all of them?”
Tell an agent destructive · confirm first
Expire all tokens for application {app_id}.
Expire the portal sessions {sessionIds} for app {app_id}.
GET /api/v1/auth/org-group-admin-token List org group admin tokens · List Org Group Tokens #
Ask an LLM
“What org group API tokens have been created for my organization group?”
“Can I page through org group tokens newest first?”
Tell an agent
List all my org group admin tokens.
Show the first {limit} org group tokens.
POST /api/v1/auth/org-group-admin-token Create an org group admin token · Create Org Group Admin Token #
Ask an LLM
“How do I create a token that works across my org group but not on apps or messages?”
“Can an org group admin token be given an expiry?”
Tell an agent
Create an org group admin token named {name}.
Issue an org group admin token called {name} that expires in {expiry} seconds.
PUT /api/v1/auth/org-group-admin-token/{key_id} Rename an org group admin token · Update Org Group Token #
Ask an LLM
“How do I rename an existing org group token?”
“Can I change the label on an org group admin token after it's created?”
Tell an agent
Rename org group token {key_id} to {name}.
Update the name of org group admin token {key_id} to {name}.
POST /api/v1/auth/org-group-admin-token/{key_id}/expire Expire an org group admin token · Expire Org Group Token #
Ask an LLM
“How do I revoke an org group admin token that leaked?”
“Can I schedule an org group token to expire later instead of right now?”
Tell an agent destructive · confirm first
Expire org group token {key_id} immediately.
Expire org group admin token {key_id} in {expiry} seconds.
POST /api/v1/auth/app/{app_id}/poller/{endpoint_id}/token/rotate Rotate an application's poller token · Rotate Poller Token #
Ask an LLM
“How do I rotate the token used to read from a polling endpoint on an application?”
“Can the old poller token keep working for a while after rotation?”
Tell an agent
Rotate the poller token for endpoint {endpoint_id} in app {app_id}.
Rotate app {app_id} endpoint {endpoint_id}'s poller token and keep the old one alive for {oldTokenExpiry} seconds.
GET /api/v1/auth/app/{app_id}/poller/{endpoint_id}/token Get an application's current poller token · Get Poller Token #
Ask an LLM
“Where do I find the current auth token for an application's polling endpoint?”
“What poller token is active right now for this app endpoint?”
Tell an agent
Get the current poller token for endpoint {endpoint_id} in app {app_id}.
Show me app {app_id}'s poller token for endpoint {endpoint_id} without rotating it.
GET /api/v1/auth/app/{app_id}/mcp-token List an application's MCP tokens · List MCP Tokens #
Ask an LLM
“Which MCP tokens exist for my application?”
“Can I see all MCP tokens issued for one app?”
Tell an agent
List the MCP tokens for application {app_id}.
Show up to {limit} MCP tokens on app {app_id}.
POST /api/v1/auth/app/{app_id}/mcp-token Create an MCP token for an application · Create Mcp Token #
Ask an LLM
“How do I create an MCP token so an AI agent can reach my application?”
“Can an MCP token be set to expire?”
Tell an agent
Create an MCP token for application {app_id}.
Issue an MCP token for app {app_id} that expires in {expiry} seconds.
DELETE /api/v1/auth/app/{app_id}/mcp-token/{token_id} Revoke an MCP token · Revoke MCP Token #
Ask an LLM
“How do I revoke an MCP token I no longer trust?”
“Can I delete a single MCP token without affecting the app's others?”
Tell an agent destructive · confirm first
Revoke MCP token {token_id} on application {app_id}.
Delete MCP token {token_id} from app {app_id}.
POST /api/v1/auth/app/{app_id}/create-message-token Create a token that can only send messages · Create Cmg Token #
Ask an LLM
“How do I make an access token that can only create messages in one application?”
“Can I give a service a send-only credential scoped to a single app?”
Tell an agent
Create a message-only token named {name} for application {app_id}.
Issue a send-messages-only token {name} for app {app_id} expiring in {expiry} seconds.
POST /api/v1/management/authentication/{env_id}/api-token/{key_id}/expire Expire an environment API token · Expire Api Token #
Ask an LLM
“How do I expire an API token in one of my environments?”
“Can I give an environment API key a grace period before it expires?”
Tell an agent destructive · confirm first
Expire API token {key_id} in environment {env_id}.
Expire environment {env_id}'s API token {key_id} after {expiry} seconds.
GET /api/v1/management/authentication/{env_id}/api-token/{key_id} Get an environment API token · Get Api Token #
Ask an LLM
“What are the details of a specific API token in my environment?”
“Can I look up one environment API key by its id?”
Tell an agent
Get API token {key_id} in environment {env_id}.
Show the details of environment {env_id} API key {key_id}.
PUT /api/v1/management/authentication/{env_id}/api-token/{key_id} Replace an environment API token's name · Update Api Token #
Ask an LLM
“How do I update the name of an environment API token with a full replace?”
“Is the name required when I PUT an update to an API token?”
Tell an agent
Update environment {env_id} API token {key_id} so its name is {name}.
Replace API token {key_id} in {env_id} with the name {name}.
PATCH /api/v1/management/authentication/{env_id}/api-token/{key_id} Change an environment API token's scopes · Patch Api Token #
Ask an LLM
“How do I change the scopes on an existing environment API token?”
“Can I patch just the scopes of an API key without renaming it?”
Tell an agent
Set the scopes of API token {key_id} in environment {env_id} to {scopes}.
Patch environment {env_id} token {key_id} to have scopes {scopes}.
GET /api/v1/management/authentication/{env_id}/api-token List an environment's API tokens · List Api Tokens #
Ask an LLM
“Which API tokens exist in my environment?”
“Can I audit all the API keys issued for one environment?”
Tell an agent
List all API tokens in environment {env_id}.
Show the first {limit} API keys for environment {env_id}.
POST /api/v1/management/authentication/{env_id}/api-token Create an environment API token · Create Api Token #
Ask an LLM
“How do I create a new API key for one of my environments?”
“Can I restrict a new environment API token to specific scopes?”
Tell an agent
Create an API token named {name} in environment {env_id}.
Create API token {name} in {env_id} limited to scopes {scopes}.
POST /api/v1/auth/one-time-token Exchange a one-time token for access · Exchange One Time Token #
Ask an LLM
“How do I redeem a one-time token from a portal magic link?”
“Can a one-time token be exchanged more than once?”
Tell an agent
Exchange one-time token {oneTimeToken}.
Redeem the one-time token {oneTimeToken} from a portal link.

Documentation

📖
Documentation
https://docs.svix.com
📖
APIReference
https://api.svix.com/docs
📖
Authentication
https://docs.svix.com/api-keys
📖
RateLimits
https://artifacts.apis.io/svix/rate-limits/svix-rate-limits.yml
📖
Documentation
https://www.svix.com/ingest/
📖
Documentation
https://www.svix.com/stream/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/svix/openapi/svix-authentication-api-openapi.yml

Other Resources

🔗
Overlay
https://artifacts.apis.io/svix/overlays/svix-authentication-api-overlay.yaml
🔗
ErrorCodes
https://docs.svix.com/retries

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/svix:svix-authentication-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

svix-authentication-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Svix Authentication API
  description: Welcome to the Svix API documentation!
  version: 1.922.0
  x-logo:
    url: https://www.svix.com/static/img/brand-padded.svg
    altText: Svix Logo
servers:
- url: https://api.eu.svix.com
  description: The Svix EU region
- url: https://api.us.svix.com
  description: The Svix US region
- url: https://api.ca.svix.com
  description: The Svix Canada region
- url: https://api.au.svix.com
  description: The Svix Australia region
- url: https://api.in.svix.com
  description: The Svix India region
tags:


# --- truncated at 32 KB (91 KB total) ---
# Full source: https://artifacts.apis.io/svix/openapi/svix-authentication-api-openapi.yml