Skip to main content

Developer Overview

Magne provides a comprehensive set of APIs for building integrations:
APIProtocolUse Case
REST APIHTTPSCRUD operations on all resources (servers, channels, messages, users)
WebSocketWSSReal-time events (messages, presence, typing indicators, voice states)
WebhooksHTTPS (outbound)Send messages to channels from external services
Bot ServiceREST + WSInteractive bots with commands and music playback

Base URL

All REST API endpoints are served from:
https://api.magne.chat/v1
All endpoints use the /v1/ prefix for versioning.

Authentication

Most endpoints require a Bearer token in the Authorization header:
curl -H "Authorization: Bearer YOUR_TOKEN" \
     https://api.magne.chat/v1/users/@me
See Authentication for details on obtaining and refreshing tokens.

Response Format

All responses are JSON-encoded. Successful responses return the resource directly:
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "username": "example",
  "displayName": "Example User"
}
Error responses follow a consistent format. See Errors for details.

Rate Limits

All endpoints are rate-limited. See Rate Limits for tiers, headers, and retry strategies.