Home Security API Docs

API Documentation

All endpoints for the mIRCscord Bot Platform. Base URL: https://mircscord.com

All requests require Authorization: Bearer {token} header. Get a token by logging in via POST /api/auth/login.

Browse Bots

GET /api/bots

List all public bots available in the marketplace.

// Response
[
  {
    "id": "uuid",
    "name": "AutoMod",
    "description": "Automatic moderation...",
    "bot_type": "builtin",
    "category": "moderation",
    "is_public": true,
    "install_count": 42,
    "avg_rating": 4.5,
    "created_at": "2026-04-19T..."
  }
]

GET /api/bots/:id

Get details for a specific bot.

Install & Manage Bots

POST /api/servers/:server_id/bots

Install a bot to your server. Requires server admin permissions.

// Request
{ "bot_id": "uuid-of-bot-to-install" }

// Response
{ "id": "install-uuid", "bot_id": "...", "server_id": "...", "enabled": true }

GET /api/servers/:server_id/bots

List all bots installed on a server.

PATCH /api/servers/:server_id/bots/:bot_id

Update bot configuration or toggle enabled/disabled. Requires admin.

// AutoMod config example
{
  "enabled": true,
  "config": {
    "blocked_words": ["spam", "scam", "buy now"],
    "block_links": true,
    "block_caps": true
  }
}

// Welcome Bot config example
{
  "config": {
    "welcome_message": "Welcome to the server, {username}! Check out #rules first.",
    "welcome_channel_id": "uuid-of-welcome-channel"
  }
}

// AI Bot config example
{
  "config": {
    "system_prompt": "You are a helpful coding assistant. Be concise.",
    "active_channels": ["channel-uuid-1", "channel-uuid-2"],
    "model": "anthropic/claude-sonnet-4",
    "api_url": "https://openrouter.ai/api/v1/chat/completions"
  }
}

DELETE /api/servers/:server_id/bots/:bot_id

Remove a bot from your server. Requires admin.

AI Bot API Keys

POST /api/servers/:server_id/bots/:bot_id/key

Set the API key for an AI bot. Keys are encrypted and never shown again. Rate limited: max 3 changes per hour.

// Request
{
  "provider": "openrouter",    // openrouter | openai | anthropic | google | mistral | groq
  "api_key": "sk-or-v1-...",
  "model": "anthropic/claude-sonnet-4"  // optional
}
Key validation: OpenAI keys must start with sk-. Anthropic keys must start with sk-ant-. All keys must be at least 20 characters.

DELETE /api/servers/:server_id/bots/:bot_id/key

Remove the API key from an AI bot. Requires admin.

Reviews

GET /api/bots/:id/reviews

Get reviews for a bot.

POST /api/bots/:id/reviews

Post a review. Rating 1-5, one review per user per bot.

{ "rating": 5, "body": "Great bot, keeps the server clean!" }

Available Bots

🛡️ AutoMod builtin moderation

Automatic moderation for your server.

👋 Welcome Bot builtin utility

Greet new members when they join your server.

📊 Stats Bot builtin utility

Server statistics and activity tracking. (Coming soon)

📋 Poll Bot builtin fun

Create polls with multiple options. (Coming soon)

⏰ Reminder Bot builtin utility

Set personal and channel reminders. (Coming soon)

🧠 AI Bot ai

Create custom AI assistants by providing your own API key. Supports OpenRouter, OpenAI, Anthropic, and more.

mIRCscord Developer Portal — Built by gh0stc0de — mircscord.com