Svix

Svix Stream API

The Stream API from Svix — 2 operation(s) for stream.

GitHub OpenAPI

Operations 8

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/stream/transformations/simulate Test a stream transformation on sample events · Simulate Stream Transformation #
Ask an LLM
“How do I try out stream transformation code against sample events before deploying it?”
“Can I simulate what a transformation outputs for a given sink type?”
Tell an agent
Simulate transformation {code} for sink type {type} on events {events}.
Dry-run this stream transformation code {code} against {events} for a {type} sink.
GET /api/v1/stream List streams · List Streams #
Ask an LLM
“What streams does my organization have in Svix Stream?”
“Can I page through all of my event streams?”
Tell an agent
List all my streams.
Show the first {limit} streams in my organization.
POST /api/v1/stream Create a stream · Create Stream #
Ask an LLM
“How do I set up a new event stream?”
“Can I give a new stream my own uid so I can reference it later?”
Tell an agent
Create a stream named {name}.
Create stream {name} with uid {uid}.
GET /api/v1/stream/{stream_id} Get a stream · Get Stream #
Ask an LLM
“What are the details of a particular stream?”
“Can I look up a stream by its uid?”
Tell an agent
Get stream {stream_id}.
Show the name and metadata of stream {stream_id}.
PUT /api/v1/stream/{stream_id} Create or replace a stream · Upsert Stream #
Ask an LLM
“How do I upsert a stream so it's created if the id doesn't exist?”
“Can I rename a stream by replacing its record?”
Tell an agent
Upsert stream {stream_id} with name {name}.
Replace stream {stream_id} with name {name} and metadata {metadata}.
DELETE /api/v1/stream/{stream_id} Delete a stream · Delete Stream #
Ask an LLM
“How do I delete a stream I no longer need?”
“Can a deleted stream be recovered?”
Tell an agent destructive · confirm first
Delete stream {stream_id}.
Permanently remove the stream {stream_id}.
PATCH /api/v1/stream/{stream_id} Partially update a stream · Patch Stream #
Ask an LLM
“How do I change just a stream's description?”
“Can I update a stream's metadata without touching its name?”
Tell an agent
Set stream {stream_id}'s description to {description}.
Patch the metadata on stream {stream_id} to {metadata}.
PATCH /api/v1/stream/{stream_id}/alert-email Set a stream's alert email · Patch Alert Email #
Ask an LLM
“Where do alerts about a stream get emailed, and how do I change it?”
“Can I set a different alert email for each stream?”
Tell an agent
Send alerts for stream {stream_id} to {email}.
Change stream {stream_id}'s alert email to {email}.

Documentation

📖
Documentation
https://docs.svix.com
📖
APIReference
https://api.svix.com/docs
📖
Authentication
https://docs.svix.com/api-keys
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/svix/refs/heads/main/rate-limits/svix-rate-limits.yml
📖
Documentation
https://www.svix.com/ingest/
📖
Documentation
https://www.svix.com/stream/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/svix/refs/heads/main/openapi/svix-stream-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/svix/refs/heads/main/overlays/svix-stream-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-stream-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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-stream-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Svix Stream 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 (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/svix/refs/heads/main/openapi/svix-stream-api-openapi.yml