Synapse website screenshot

Synapse

Synapse is the reference Matrix homeserver implementation maintained by Element (formerly by the Matrix.org Foundation). Written in Python and Rust, it implements the Matrix open standard for secure, decentralized real-time communication. Synapse powers thousands of deployments worldwide and provides Client-Server, Server-Server (federation), Application Service, Identity Service, and Admin APIs. Since version 1.99, maintained by Element under AGPL-3.0.

Synapse publishes 8 APIs on the APIs.io network, including Federation API, Media API, Registration API, and 5 more. Tagged areas include Chat, Collaboration, Decentralized, Federation, and Matrix.

The Synapse catalog on APIs.io includes 1 JSON-LD context and 2 Spectral governance rulesets.

Synapse’s developer surface includes authentication, GitHub presence, documentation, getting-started guide, changelog, engineering blog, and 11 more developer resources.

46.6/100 developing ▼ -7.8 Agent 31/100 agent aware Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessPaidSelf serve
9 APIs
ChatCollaborationDecentralizedFederationMatrixMessagingOpen-SourceReal-Time

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 46.6/100 · developing
Contract Quality 15.7 / 25
Developer Ergonomics 6.5 / 20
Commercial Clarity 5.8 / 20
Operational Transparency 6.8 / 13
Governance 7.0 / 12
Discoverability 7.4 / 10
Agent readiness — 31/100 · agent aware
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 0 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/synapse: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 9

Individual APIs this provider publishes, each with its own machine-readable definition.

Synapse Application Service API

API for integrating application services (bridges and bots) with the Matrix homeserver. Allows third-party applications to handle namespaced user IDs and room aliases, enabling ...

Synapse Federation API

Federation management

Synapse Media API

Media file administration

Synapse Registration API

User registration and tokens

Synapse Reports API

Event and user reports

Synapse Rooms API

Room administration and membership

Synapse Server API

Server information and background updates

Synapse Statistics API

Server usage statistics

Synapse Users API

User account management

Scroll for all 9

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Synapse Admin API

OPEN COLLECTION

Pricing Plans 1

Published pricing tiers and plan structures.

Synapse Plans Pricing

2 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Synapse Rate Limits

11 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Synapse Context

0 classes · 31 properties

JSON-LD

Spectral Rules 2

Spectral governance rulesets for linting and validating these APIs.

Synapse API Rules

5 rules · 4 warnings 1 info

SPECTRAL

Synapse API Rules

8 rules · 2 errors 4 warnings

SPECTRAL

JSON Schema 1

Standalone JSON Schema definitions for this provider's data models.

Synapse User

12 properties

JSON SCHEMA

JSON Structure 1

JSON Structure definitions describing this provider's data shapes.

Synapse Room Structure

0 properties

JSON STRUCTURE

Examples 1

Example request and response payloads for these APIs.

Security Posture 3

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Synapse Authentication

http · 1 scheme

SECURITY

Synapse Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Synapse Vulnerability Disclosure

security.txt · contact published

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Synapse Agentic Access

18 operations · 6 acting · 1 human-in-the-loop

18 operations · 6 acting

AGENTIC

Resources

Get Started 1

Portal, sign-up, and the first successful call

Documentation 1

Reference material describing how the API behaves

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

Build 2

SDKs, sample code, and the tooling you integrate with

Access & Security 4

Authentication, authorization, and security posture

Operate 2

Status, limits, changes, and where to get help

Commercial 1

Pricing, plans, and the legal terms of use

Company 2

The organization behind the API

Other 3

Properties that don't map to a standard resource type

Source (apis.yml)

apis.yml Raw ↑
aid: synapse
name: Synapse
description: Synapse is the reference Matrix homeserver implementation maintained by Element (formerly by the Matrix.org Foundation).
  Written in Python and Rust, it implements the Matrix open standard for secure, decentralized real-time communication. Synapse
  powers thousands of deployments worldwide and provides Client-Server, Server-Server (federation), Application Service, Identity
  Service, and Admin APIs. Since version 1.99, maintained by Element under AGPL-3.0.
accessModel:
  pricing: paid
  onboarding: self-serve
  trial: false
  try_now: false
  public: false
  label: Paid · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://matrix.org/images/matrix-logo.svg
url: https://raw.githubusercontent.com/api-evangelist/synapse/refs/heads/main/apis.yml
created: '2026-05-03'
modified: '2026-05-19'
specificationVersion: '0.19'
apis:
- aid: synapse:synapse-application-service-api
  name: Synapse Application Service API
  description: API for integrating application services (bridges and bots) with the Matrix homeserver. Allows third-party
    applications to handle namespaced user IDs and room aliases, enabling Matrix bridges for IRC, Slack, Telegram, and other
    platforms.
  image: https://matrix.org/images/matrix-logo.svg
  humanURL: https://spec.matrix.org/latest/application-service-api/
  baseURL: https://matrix.example.com/_matrix/app
  tags:
  - Application-Services
  - Bots
  - Bridges
  - Integration
  - Matrix
  properties:
  - type: Documentation
    url: https://spec.matrix.org/latest/application-service-api/
- aid: synapse:synapse-federation-api
  name: Synapse Federation API
  description: Federation management
  humanURL: https://spec.matrix.org/latest/client-server-api/
  baseURL: https://matrix.example.com/_matrix/client
  tags:
  - Federation
  properties:
  - type: OpenAPI
    url: openapi/synapse-federation-api-openapi.yml
  - type: Documentation
    url: https://spec.matrix.org/latest/client-server-api/
  - type: Documentation
    url: https://spec.matrix.org/latest/server-server-api/
  - type: Documentation
    url: https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/
  - type: GitHub
    url: https://github.com/matrix-org/synapse/tree/develop/docs/admin_api
- aid: synapse:synapse-media-api
  name: Synapse Media API
  description: Media file administration
  humanURL: https://spec.matrix.org/latest/client-server-api/
  baseURL: https://matrix.example.com/_matrix/client
  tags:
  - Media
  properties:
  - type: OpenAPI
    url: openapi/synapse-media-api-openapi.yml
  - type: Documentation
    url: https://spec.matrix.org/latest/client-server-api/
  - type: Documentation
    url: https://spec.matrix.org/latest/server-server-api/
  - type: Documentation
    url: https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/
  - type: GitHub
    url: https://github.com/matrix-org/synapse/tree/develop/docs/admin_api
- aid: synapse:synapse-registration-api
  name: Synapse Registration API
  description: User registration and tokens
  humanURL: https://spec.matrix.org/latest/client-server-api/
  baseURL: https://matrix.example.com/_matrix/client
  tags:
  - Registration
  properties:
  - type: OpenAPI
    url: openapi/synapse-registration-api-openapi.yml
  - type: Documentation
    url: https://spec.matrix.org/latest/client-server-api/
  - type: Documentation
    url: https://spec.matrix.org/latest/server-server-api/
  - type: Documentation
    url: https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/
  - type: GitHub
    url: https://github.com/matrix-org/synapse/tree/develop/docs/admin_api
- aid: synapse:synapse-reports-api
  name: Synapse Reports API
  description: Event and user reports
  humanURL: https://spec.matrix.org/latest/client-server-api/
  baseURL: https://matrix.example.com/_matrix/client
  tags:
  - Reports
  properties:
  - type: OpenAPI
    url: openapi/synapse-reports-api-openapi.yml
  - type: Documentation
    url: https://spec.matrix.org/latest/client-server-api/
  - type: Documentation
    url: https://spec.matrix.org/latest/server-server-api/
  - type: Documentation
    url: https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/
  - type: GitHub
    url: https://github.com/matrix-org/synapse/tree/develop/docs/admin_api
- aid: synapse:synapse-rooms-api
  name: Synapse Rooms API
  description: Room administration and membership
  humanURL: https://spec.matrix.org/latest/client-server-api/
  baseURL: https://matrix.example.com/_matrix/client
  tags:
  - Rooms
  properties:
  - type: OpenAPI
    url: openapi/synapse-rooms-api-openapi.yml
  - type: Documentation
    url: https://spec.matrix.org/latest/client-server-api/
  - type: Documentation
    url: https://spec.matrix.org/latest/server-server-api/
  - type: Documentation
    url: https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/
  - type: GitHub
    url: https://github.com/matrix-org/synapse/tree/develop/docs/admin_api
- aid: synapse:synapse-server-api
  name: Synapse Server API
  description: Server information and background updates
  humanURL: https://spec.matrix.org/latest/client-server-api/
  baseURL: https://matrix.example.com/_matrix/client
  tags:
  - Server
  properties:
  - type: OpenAPI
    url: openapi/synapse-server-api-openapi.yml
  - type: Documentation
    url: https://spec.matrix.org/latest/client-server-api/
  - type: Documentation
    url: https://spec.matrix.org/latest/server-server-api/
  - type: Documentation
    url: https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/
  - type: GitHub
    url: https://github.com/matrix-org/synapse/tree/develop/docs/admin_api
- aid: synapse:synapse-statistics-api
  name: Synapse Statistics API
  description: Server usage statistics
  humanURL: https://spec.matrix.org/latest/client-server-api/
  baseURL: https://matrix.example.com/_matrix/client
  tags:
  - Statistics
  properties:
  - type: OpenAPI
    url: openapi/synapse-statistics-api-openapi.yml
  - type: Documentation
    url: https://spec.matrix.org/latest/client-server-api/
  - type: Documentation
    url: https://spec.matrix.org/latest/server-server-api/
  - type: Documentation
    url: https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/
  - type: GitHub
    url: https://github.com/matrix-org/synapse/tree/develop/docs/admin_api
- aid: synapse:synapse-users-api
  name: Synapse Users API
  description: User account management
  humanURL: https://spec.matrix.org/latest/client-server-api/
  baseURL: https://matrix.example.com/_matrix/client
  tags:
  - Users
  properties:
  - type: OpenAPI
    url: openapi/synapse-users-api-openapi.yml
  - type: Documentation
    url: https://spec.matrix.org/latest/client-server-api/
  - type: Documentation
    url: https://spec.matrix.org/latest/server-server-api/
  - type: Documentation
    url: https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/
  - type: GitHub
    url: https://github.com/matrix-org/synapse/tree/develop/docs/admin_api
common:
- type: AgenticAccess
  url: agentic-access/synapse-agentic-access.yml
- type: VulnerabilityDisclosure
  url: security/synapse-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/synapse-domain-security.yml
- type: Authentication
  url: authentication/synapse-authentication.yml
- type: LinkedIn
  url: https://www.linkedin.com/company/synapsepay
- type: GitHub
  url: https://github.com/matrix-org/synapse
- type: GitHub
  url: https://github.com/element-hq/synapse
- type: Documentation
  url: https://matrix-org.github.io/synapse/latest/
- type: GettingStarted
  url: https://matrix-org.github.io/synapse/latest/setup/installation.html
- type: Authentication
  url: https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#authentication
- type: RateLimits
  url: https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#ratelimiting
- type: ChangeLog
  url: https://github.com/matrix-org/synapse/blob/develop/CHANGES.md
- type: License
  url: https://github.com/matrix-org/synapse/blob/develop/LICENSE
- type: Docker
  url: https://hub.docker.com/r/matrixdotorg/synapse
- type: PyPI
  url: https://pypi.org/project/matrix-synapse/
- type: Matrix Spec
  url: https://spec.matrix.org/latest/
- url: https://www.matrix.org/blog/feed/
  type: Blog
maintainers:
- FN: API Evangelist
  email: info@apievangelist.com
tags:
- Chat
- Collaboration
- Decentralized
- Federation
- Matrix
- Messaging
- Open-Source
- Real-Time