Matrix Client-Server API

Name: Matrix Client-Server API
Brand: Matrix Client-Server API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCommunicationsChat Messagingbearer, apiKey32 EndpointsREST

For Agents

Install Jentic One Beta

Connect the Matrix Client-Server API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Matrix Client-Server API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Matrix Client-Server API.

Create new Matrix rooms with configurable visibility and join rules

Join, leave, invite, kick, and ban users from a room

Manage room aliases under a homeserver's alias namespace

GET STARTED

Start building with Matrix Client-Server API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Matrix Client-Server API, keeping it validated and agent-ready. Matrix is an open standard for decentralised real-time communication, and the Client-Server API defines how a client talks to its homeserver to authenticate users, create and join rooms, send messages, and sync state. The spec covers core room operations (create, invite, join, leave, kick, ban), user filters, room aliases and visibility, and the messaging primitives that bridge clients across federated homeservers. It is intended for developers building Matrix clients, bridge bots, and AI agents that participate in Matrix rooms.

Use Cases

Patterns agents use Matrix Client-Server API for, with concrete tasks.

★ Self-Hosted Team Chat Client

Companies running a Matrix homeserver (such as Synapse) need a custom client embedded into their internal tools. The Client-Server API covers the core operations: create rooms, invite teammates, sync events, and manage filters. A typical embedded client uses long-poll sync against a homeserver and the room endpoints to drive the UI.

Call `POST /createRoom` with `{name: 'engineering', visibility: 'private'}` then `POST /rooms/{roomId}/invite` for each teammate's MXID.

Bridge and Notification Bots

Bridge bots replicate messages between Matrix and other systems (GitHub, Jira, Slack). The bot authenticates as a Matrix user, joins relevant rooms, and posts events whenever the upstream system fires. The Client-Server API provides everything the bot needs: join rooms, send messages, manage filters to skip noise.

Call `POST /join/{roomIdOrAlias}` to join the alerts room, then post incidents as message events whenever the upstream webhook fires.

Room Moderation Tooling

Community moderators need bulk tools to enforce conduct: kicking spammers, banning repeat offenders, and tightening join rules. The Matrix API exposes per-room kick, ban, and aliasing endpoints that a moderation dashboard can wire into rule-based actions or human review queues.

Call `POST /rooms/{roomId}/ban` with the MXID and a reason to ban a confirmed-spammer account from a moderated room.

AI Agent in Matrix Rooms

An AI agent participating in a Matrix room (answering questions, summarising threads) can use Jentic to call Matrix Client-Server operations on demand. Jentic stores the access token in the vault and exposes operations like 'join a room' or 'send a message' via intent search, so the agent does not have to hand-roll Matrix authentication.

Search Jentic for 'create a matrix room', load the `/createRoom` schema, and execute it with the agent's access token to bootstrap a project room.

Key Endpoints

32 endpoints — jentic publishes the only available openapi specification for matrix client-server api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/createRoom

Create a new Matrix room

POST

/rooms/{roomId}/join

Join a room by ID

POST

/join/{roomIdOrAlias}

Join a room by ID or alias

POST

/rooms/{roomId}/leave

Leave a room

POST

/rooms/{roomId}/invite

Invite a user to a room

POST

/rooms/{roomId}/kick

Kick a user from a room

POST

/rooms/{roomId}/ban

Ban a user from a room

POST

/user/{userId}/filter

Create a user sync filter

POST

/createRoom

Create a new Matrix room

POST

/rooms/{roomId}/join

Join a room by ID

POST

/join/{roomIdOrAlias}

Join a room by ID or alias

POST

/rooms/{roomId}/leave

Leave a room

POST

/rooms/{roomId}/invite

Invite a user to a room

POST

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Your Matrix access token is stored once, encrypted, by your own Jentic One instance and applied at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'create a Matrix room' or 'invite a user to a room', and Jentic returns the matching Matrix Client-Server operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

Time to first call

FAQs

Specific to using Matrix Client-Server API through Jentic.

Why is there no official OpenAPI spec for Matrix Client-Server API?

The Matrix.org Foundation publishes the Client-Server specification as Markdown plus Swagger fragments rather than a single distributable OpenAPI document. Jentic generates and maintains a unified OpenAPI specification so AI agents and developers can call the Matrix Client-Server API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

What authentication does the Matrix Client-Server API use?

The API supports two authentication schemes: an HTTP bearer token in the `Authorization` header (preferred) and an `access_token` query parameter. Through Jentic, the access token is stored encrypted in your Jentic One instance and applied to each request automatically.

Can I create a new room with the Matrix Client-Server API?

Yes. `POST /createRoom` creates a new room and returns the `room_id` and any aliases. The request body lets you set name, topic, visibility (`public`/`private`), and an initial set of invitees.

What are the rate limits for the Matrix Client-Server API?

Matrix rate limits are enforced per homeserver rather than globally. Synapse, the reference homeserver, applies per-IP and per-user limits configured by the homeserver admin (default ~ 0.1 events per second with bursts up to 10). Inspect the `Retry-After` header on `429` responses and back off accordingly.

How do I join a Matrix room through Jentic?

Run `pip install jentic`, then use Jentic's search with the query 'join a matrix room'. Jentic loads the `/join/{roomIdOrAlias}` operation schema and your agent executes it with the room alias - Jentic injects the access token automatically.

Does the API work against any Matrix homeserver?

Yes. The base URL is parameterised as `https://{homeserver}/_matrix/client/v3`, so the same operations work against matrix.org, a self-hosted Synapse instance, Conduit, Dendrite, or any other compliant homeserver.

Can I limit what my agent is allowed to do with the Matrix Client-Server API?

Yes. Because Jentic One is self-hosted, you write the rules that decide which Matrix operations and which access token your agent may use. Matrix carries the room id in the URL path (/rooms/{roomId}/...), so a rule can pin the agent to a single room and let it only invite and join there. You choose the operation set, so destructive calls like /rooms/{roomId}/kick or /rooms/{roomId}/ban stay out unless you explicitly grant them.

Matrix Client-Server API

Connect the Matrix Client-Server API to your agent

Capabilities

Start building with Matrix Client-Server API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs