API & CLI

An API, not an afterthought

The protocol is public, the OpenAPI spec ships with every release, and the official clients are built on the same surface you get with a token.

api.synapse.app/v1 OpenAPI published per release
POST/messages
GET/spaces/:id/thread
POST/webhooks

signed webhook

{
  "type": "message.created",
  "space": "engineering",
  "signature": "v1=9f2c…"
}

REST endpoints and a signed webhook payload from api.synapse.app/v1.

What you get

Built for the way you actually work

Every client speaks the same protocol, so nothing here is a mobile-only or desktop-only promise.

REST API with signed webhooks

Tokens scoped per space, cursor pagination, idempotency keys, and webhook deliveries signed with replay protection.

A CLI that fits a pipeline

synapse dm, synapse send and synapse watch emit newline-delimited JSON, exit non-zero on failure, and read a token from the environment.

Open protocol and SDKs

Wire format, federation handshake and auth flow are documented; TypeScript, Go and Python SDKs are released alongside the server.

Build on it today

Install the CLI, mint a space token, and you have a working integration before the coffee goes cold.