canonical: https://jentic.com/apis/revolt.chat/revolt-chat

# Revolt Chat Revolt API

API for Revolt, an open source Discord alternative. Provides access to users, channels, servers, messages, and more. The API exposes 16 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get current user, edit current user. Covers 16 operations with apiKey authentication.

## Scope

Does not handle payments, crm, or developer tools - use for communications only.

## Capabilities

- Get current user
- Edit current user
- Close/delete channel
- Send message
- Monitor Revolt API operational status and events

## Use cases

### Communications Operations

Use the Revolt API to perform communications operations programmatically. The API provides 16 endpoints covering core functionality including get current user, edit current user, get user.

Example prompt: Call GET /users/@me to get current user

### Automated Users Management

Automate users operations by combining multiple Revolt API endpoints. Agents can edit current user and then get user in a single workflow.

Example prompt: Call PATCH /users/@me to edit current user, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Revolt API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'get current user', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/users/@me` | Get current user |
| PATCH | `/users/@me` | Edit current user |
| GET | `/users/{userId}` | Get user |
| GET | `/channels/{channelId}` | Get channel |
| PATCH | `/channels/{channelId}` | Edit channel |
| DELETE | `/channels/{channelId}` | Close/delete channel |
| POST | `/channels/{channelId}/messages` | Send message |
| GET | `/channels/{channelId}/messages` | Get messages |

## Key resources

- **Users** — User management
- **Channels** — Channel management
- **Messages** — Message operations
- **Servers** — Server management
- **Invites** — Invite management

## Why Jentic

- **Setup:** Wiring the Revolt API by hand means handling its x-session-token or x-bot-token header auth, sending the right token on every call to api.revolt.chat, and managing retries yourself. Through Jentic you install once, import the Revolt API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Revolt puts the channel id in the URL path (`/channels/{channelId}`), so a rule can pin your agent to one channel: it can read and post messages in that channel and nothing else. You choose the operations it may call, so destructive ones like deleting a channel are not included unless you add them.
- **Credential handling:** Your Revolt token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get the current user' or 'send a message to a channel', and Jentic returns the matching Revolt API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Twilio** — Alternative communications API
- **Sendgrid** — Alternative communications API
- **Pusher** — Complementary communications API

## FAQ

### What authentication does the Revolt API use?

The Revolt API uses an API key passed in the `x-session-token` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get current user with the Revolt API?

Yes. Use the GET /users/@me endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Revolt API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get current user through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get current user'. Jentic returns the matching Revolt API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Revolt API have?

The Revolt API exposes 16 endpoints covering users, channels, messages operations.

### Can I limit what my agent is allowed to do with the Revolt API?

Yes. Because Jentic One is self-hosted, your own rules decide which Revolt API operations and credentials the agent may use. Since Revolt puts the channel id in the URL path (`/channels/{channelId}`), you can pin the agent to a single channel so it only reads messages (GET `/channels/{channelId}/messages`) and posts messages (POST `/channels/{channelId}/messages`) there. You also choose which operations are exposed, so destructive calls like DELETE `/channels/{channelId}` are left out unless you deliberately add them.
