> ## Documentation Index
> Fetch the complete documentation index at: https://docs.magne.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Developer Overview

> Build integrations, bots, and extensions for the Magne platform.

# Developer Overview

Magne provides a comprehensive set of APIs for building integrations:

| API             | Protocol         | Use Case                                                               |
| --------------- | ---------------- | ---------------------------------------------------------------------- |
| **REST API**    | HTTPS            | CRUD operations on all resources (servers, channels, messages, users)  |
| **WebSocket**   | WSS              | Real-time events (messages, presence, typing indicators, voice states) |
| **Webhooks**    | HTTPS (outbound) | Send messages to channels from external services                       |
| **Bot Service** | REST + WS        | Interactive 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:

```bash theme={null}
curl -H "Authorization: Bearer YOUR_TOKEN" \
     https://api.magne.chat/v1/users/@me
```

See [Authentication](/developers/authentication) for details on obtaining and refreshing tokens.

## Response Format

All responses are JSON-encoded. Successful responses return the resource directly:

```json theme={null}
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "username": "example",
  "displayName": "Example User"
}
```

Error responses follow a consistent format. See [Errors](/developers/errors) for details.

## Rate Limits

All endpoints are rate-limited. See [Rate Limits](/developers/rate-limits) for tiers, headers, and retry strategies.